AS AgentScopeAPI 手册 / API Reference

TaskTool

public class TaskTool
源码Source io/agentscope/harness/agent/tool/TaskTool.java:42–252

任务工具,封装可被智能体调用的能力。位于 io.agentscope.harness.agent.tool 包。核心成员包括 taskOutput、taskCancel、taskList、TaskTool。

Unified tool for background task lifecycle management. Combines task result retrieval, cancellation, and listing into a single tool class.

  • task_output — retrieve result (blocking or non-blocking)

  • task_cancel — cancel a running task

  • task_list — list all tracked tasks with optional status filter

All operations are scoped to the current parent session ID via RuntimeContext. The TaskRepository handles fallback to workspace-persisted records when no local future exists (cross-node or post-restart scenarios).

构造器摘要Constructor Summary

构造器Constructor说明Description
public TaskTool(TaskRepository taskRepository)
初始化 `TaskTool` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public String taskOutput(RuntimeContext runtimeContext, String taskId, Boolean block, Long timeout)
执行任务输出相关操作。
Performs the task output operation.
public String taskCancel(RuntimeContext runtimeContext, String taskId)
执行任务取消相关操作。
Performs the task cancel operation.
public String taskList(RuntimeContext runtimeContext, String statusFilter)
执行任务列表相关操作。
Performs the task list operation.

构造器详情Constructor Detail

TaskTool

public TaskTool(TaskRepository taskRepository)

初始化 TaskTool 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
taskRepositoryTaskRepository任务仓库(类型 `TaskRepository`)。The task repository.
源码Source io/agentscope/harness/agent/tool/TaskTool.java:49–51

方法详情Method Detail

taskOutput

public String taskOutput(RuntimeContext runtimeContext, String taskId, Boolean block, Long timeout)

执行任务输出相关操作。

Performs the task output operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
taskIdString任务标识(类型 `String`)。The task id.
blockBoolean内容块(类型 `Boolean`)。The block.
timeoutLong超时时间(类型 `Long`)。The timeout.
返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/harness/agent/tool/TaskTool.java:53–140

taskCancel

public String taskCancel(RuntimeContext runtimeContext, String taskId)

执行任务取消相关操作。

Performs the task cancel operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
taskIdString任务标识(类型 `String`)。The task id.
返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/harness/agent/tool/TaskTool.java:142–172

taskList

public String taskList(RuntimeContext runtimeContext, String statusFilter)

执行任务列表相关操作。

Performs the task list operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
statusFilterString状态过滤器(类型 `String`)。The status filter.
返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/harness/agent/tool/TaskTool.java:174–215
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.