程序包 io.agentscope.core.tool

类 ToolSuspendException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.agentscope.core.tool.ToolSuspendException

所有已实现的接口:

Serializable

public class ToolSuspendException
extends RuntimeException

Exception thrown to signal that a tool execution should be suspended and handled externally.

This exception is used by tools that require external execution (e.g., tools registered via schema-only registration). When thrown, the framework will:

1. Convert the exception to a pending ToolResultBlock
2. Return a suspended message to the user with GenerateReason.TOOL_SUSPENDED
3. Wait for the user to provide the tool execution result

Example usage in a custom tool:

 @Tool(name = "external_api", description = "Call external API")
 public ToolResultBlock callExternalApi(@ToolParam(name = "url") String url) {
     // Signal that this tool needs external execution
     throw new ToolSuspendException("Requires external API call to: " + url);
 }
 

另请参阅:

• SchemaOnlyTool
• 序列化表格

构造器概要

构造器

构造器	说明
ToolSuspendException()	Creates a new ToolSuspendException with default message.
ToolSuspendException(String reason)	Creates a new ToolSuspendException with a custom reason.

方法概要

修饰符和类型	方法	说明
String	getReason()	Gets the user-defined reason for suspension.

从类继承的方法 java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造器详细资料

ToolSuspendException

public ToolSuspendException()

Creates a new ToolSuspendException with default message.

ToolSuspendException

public ToolSuspendException(String reason)

Creates a new ToolSuspendException with a custom reason.

参数:

reason - the reason for suspension, will be included in the pending ToolResultBlock

方法详细资料

getReason

public String getReason()

Gets the user-defined reason for suspension.

返回:

the reason, or null if not specified