所有类和接口

类
说明
Abstract base formatter providing common functionality for all formatter implementations.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
A directory included in a permission context's working scope.
Complete agent interface combining all capabilities.
Abstract base class for all agents in the AgentScope framework.
Emitted when an agent finishes processing an invocation.
Base class for all fine-grained agent events.
Public interface for emitting AgentEvents into the parent agent's streamEvents() event stream from within tool execution code.
Fine-grained event types emitted during agent execution.
Emitted when an agent successfully finishes processing an invocation, carrying the final result message.
JVM hook for SIGTERM graceful shutdown entry.
Exception thrown when request is rejected or interrupted during shutdown.
Represents an agent skill that can be loaded and used by agents.
Builder for creating AgentSkill instances.
Generates skill system prompts for agents to understand available skills.
Repository interface for AgentSkill persistence operations.
Metadata about a skill repository.
Emitted when an agent begins processing an invocation.
Mutable per-agent runtime state.
 
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
Persistent storage interface for AgentScope agent state.
Interface for agent tools that can be called by models.
Emitted during the acting phase when all tool calls from the most recent reasoning step were denied (by user HITL confirmation or by permission rules).
A Msg with MsgRole.ASSISTANT pinned at construction time.
Fluent builder for AssistantMessage.
Represents audio content in a message.
Builder for constructing AudioBlock instances.
Represents Base64-encoded media content with media type and data.
Builder for constructing Base64Source instances.
Controls whether ModelRegistry caches models created with a ModelCreationContext.
Interface for agents that can be called to process messages.
Abstract base class for all models in the AgentScope framework.
Represents a chat completion response from a language model.
Builder for creating ChatResponse instances.
Represents token usage information for chat completion responses.
Builder for creating ChatUsage instances.
ClasspathSkillRepository - Loads skills from classpath resources and JAR files.
WebSocket connection close information.
Interface for validating shell commands before execution.
Result of command validation.
 
 
Represents the result of a single user confirmation decision for a tool call.
Base sealed class for all content blocks in messages.
已过时。
Part of the ToolExecutionContext layer which is superseded by RuntimeContext.
Credential metadata for a model provider.
Generic extensible event for signals that don't fit a specific AgentEvent subtype.
Unified data block for arbitrary binary media (image / audio / video / file).
Builder for constructing DataBlock instances.
 
 
 
Credential for the DeepSeek API.
 
Default implementation of ToolResultConverter.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
Builder for constructing DocumentMetadata instances with fluent API.
Dynamically composes skills from an ordered list of repositories on every call() via DynamicSkillMiddleware.onSystemPrompt(Agent, RuntimeContext, String), replacing the static skill prompt with a per-call view that supports per-user skill isolation and one-click marketplace integration.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时。
since 2.0.0.
已过时。
since 2.0.0.
Builder for EventSource.
已过时。
since 2.0.0.
Emitted when the agent's ReAct loop exceeds the configured maximum iterations.
Utility methods for exception handling.
Unified execution configuration for timeout and retry behavior.
Builder for ExecutionConfig.
Interface for extended model that adds properties to tool parameters.
Emitted after externally-executed tool results are provided back to the agent.
File system based implementation of AgentSkillRepository.
Utility methods shared by text file tools.
Formatter interface for converting between AgentScope and provider-specific formats.
Exception thrown when formatter encounters an error during message formatting or response parsing.
Immutable generation options for LLM models.
 
Represents the reason why a message was generated by an agent.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
Configuration for graceful shutdown behavior of the agent system.
Global manager for graceful shutdown lifecycle and active request tracking.
System middleware that integrates graceful shutdown into the agent lifecycle.
A content block that provides hints to the LLM during reasoning.
One-shot hint block event.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
HTTP request encapsulation for the transport layer.
Builder for HttpRequest.
HTTP response encapsulation for the transport layer.
Builder for HttpResponse.
HTTP transport layer interface for making HTTP requests.
Configuration for HTTP transport layer.
Builder for HttpTransportConfig.
Exception thrown when HTTP transport operations fail.
Factory for managing HttpTransport instances.
HTTP version.
Represents image content in a message with URL or Base64 source.
Builder for constructing ImageBlock instances.
In-memory implementation of the AgentStateStore interface.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
Context information about an interruption.
Builder for InterruptContext.
Per-session interrupt signal.
Enum representing the source of an interruption.
Jackson-based implementation of JsonCodec.
Pure JDK implementation of the HttpTransport interface.
Builder for JdkHttpTransport.
WebSocket connection implementation based on JDK WebSocket.
WebSocket client implementation based on JDK 11+ HttpClient.
Interface for JSON serialization and deserialization operations.
Runtime exception for JSON processing errors.
JSON file-based AgentStateStore implementation.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
 
JSON Schema definition for structured outputs.
 
Utility class for accessing the global JsonCodec instance.
Credential for the Kimi (Moonshot AI) API.
 
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0, for removal.
Utility for loading v1 session data into the 2.0 AgentState format.
Utility class for computing hash values of state lists.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
Utility for parsing and generating Markdown files with YAML frontmatter.
Result of parsing markdown with frontmatter.
Wrapper for asynchronous MCP clients using Project Reactor.
Builder for creating MCP client wrappers with fluent configuration.
Abstract wrapper for MCP (Model Context Protocol) clients.
Utility class for converting between MCP content types and AgentScope content blocks.
Type-namespace marker for MCP (Model Context Protocol) request metadata.
Wrapper for synchronous MCP clients that converts blocking calls to reactive Mono types.
ToolBase subclass that wraps an MCP (Model Context Protocol) tool.
Utility class for handling media files in multimodal content.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
Constants for well-known message metadata keys.
Middleware provides interception mechanisms at 5 key execution points in the Agent lifecycle.
Builds an onion-style middleware chain for a given interception point.
Functional interface representing one of the onion-pattern middleware hooks.
 
Emitted when the agent finishes a model (LLM) call.
Emitted when the agent starts a model (LLM) call.
Description of one candidate chat model under a provider.
Model invocation configuration.
Known context window sizes for popular models.
Provider-neutral model creation context used by ModelRegistry and model provider SPI implementations.
 
Exception thrown when model operations fail.
Exception contract for model providers that can expose an HTTP status code.
Service Provider Interface for model adapters discovered from extension modules.
Registry for resolving Model instances from string identifiers (named instances or provider:model patterns).
 
 
Utility class for common Model operations.
Represents a message in the AgentScope framework.
 
Defines the role of a message participant in agent conversations.
A no-op implementation of ToolEmitter that silently discards all emitted chunks.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
Interface for agents that can observe messages without generating replies.
OkHttp implementation of the HttpTransport interface.
Builder for OkHttpTransport.
WebSocket connection implementation based on OkHttp WebSocket.
WebSocket client implementation based on OkHttp.
Middleware that adds OpenTelemetry tracing to the agent lifecycle.
Policy for handling incomplete reasoning content on shutdown interruption.
Outcome of a permission rule or tool self-check.
Permission evaluation context: mode + working directories + three rule tables.
 
Decision returned by a permission rule match or a tool self-check.
 
Evaluates tool execution requests against configured permission rules.
Permission mode controlling how the engine evaluates tool execution requests.
A single permission rule pinned to a tool name.
Persisted plan-mode flag for an agent.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
Configuration for HTTP and SOCKS proxy.
Builder for ProxyConfig.
Enumeration of supported proxy types.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
ReAct (Reasoning and Acting) Agent implementation.
 
Reasoning-loop configuration.
Snapshot of a file's contents kept in the tool read cache.
Tool for viewing text file content with optional line range specification and listing directory contents.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
Requests the agent to pause execution after the current phase completes.
Emitted when tool calls require external (out-of-process) execution.
Emitted when the agent requires user confirmation before executing tool calls (HITL).
Response format configuration for model APIs.
 
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
Builder for RetrieveConfig.
Per-call metadata for an agent run: session-scoped fields plus a thread-safe attribute bag and an optional ToolExecutionContext (tool-POJO / DI layer).
 
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
An external tool implementation that only contains schema definition without execution logic.
Information about a session.
Tool for executing shell commands with security validation.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
Global framework shutdown state.
Strategy for persisting AgentState during graceful shutdown.
Simple implementation of ExtendedModel using maps.
Manages a collection of AgentSkill instances and exposes them as tools.
Fluent builder for registering skills with optional configuration.
Filter for deciding whether a skill resource should be uploaded.
Utility class for file system operations related to skills.
Immutable filter that decides which skills are allowed in a prompt.
已过时。
since 2.0.0.
A ToolGroup that is bound to a specific skill.
Builder for constructing SkillToolGroup instances.
Utility class for creating AgentSkill instances.
Base class for media sources (URL or Base64).
Marker interface for persistable state objects.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0, for removal in a future minor release.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
Builder for StreamOptions.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
Builder for StreamUserInput.
Configuration for how to ensure the model calls generate_response tool in structured output mode.
Configuration for sub-agent registration.
Builder for SubAgentConfig.
A lightweight channel that allows synchronously-invoked subagents to push their Events into the parent agent's Flux<Event> stream.
Emitted when a spawned subagent is exposed as a user-addressable entry point via agent_spawn(expose_to_user=true).
Factory interface for creating agent instances.
AgentTool implementation that wraps a sub-agent for multi-turn conversation.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
A Msg with MsgRole.SYSTEM pinned at construction time.
Fluent builder for SystemMessage.
Persistent agent task record carried inside TaskContextState.
 
Allowed values for Task.state.
Mutable bag of Tasks carried by AgentState.
Keeps the agent's todo list in front of the model so long-running tasks don't drift.
Represents plain text content in a message.
Builder for constructing TextBlock instances.
 
 
 
Represents reasoning or thinking content in a message.
Builder for constructing ThinkingBlock instances.
 
 
 
Built-in task-list tool that lets the agent maintain a structured todo list for the current session, mirroring opencode's todowrite.
A single todo item as supplied by the model.
Annotation to mark a method as a tool that can be invoked by AI agents.
Abstract base class for tools that participate in permission evaluation and ReAct execution.
Fluent builder for ToolBase subclasses.
Emitted as tool call input arguments are streamed incrementally.
 
Parameters for tool invocation.
Builder for ToolCallParam.
 
 
Represents the tool choice behavior for LLM model calls.
Auto mode: Let the model decide whether and which tools to call.
None mode: Prevent the model from calling any tools.
Required mode: Force the model to call at least one tool.
Specific mode: Force the model to call a specific tool by name.
Read-cache backing for file-touching tools (Read / Write / Edit).
 
Serializable metadata for a spawned subagent, persisted alongside the parent agent's state so that agent_send can lazily rebuild the live Agent instance after session restore or on a different replica.
Defaults for the dangerous-path and dangerous-command lists consulted by tool self-checks.
Interface for emitting streaming responses during tool execution.
已过时。
Use RuntimeContext instead.
Builder for ToolExecutionContext.
已过时。
Part of the ToolExecutionContext layer which is superseded by RuntimeContext.
Represents a named group of tools with activation state.
Builder for constructing ToolGroup instances.
Defines who manages a ToolGroup's activation lifecycle.
Toolkit manages the registration, retrieval, and execution of agent tools.
Fluent builder for registering tools with optional configuration.
Implemented by middleware (or other components) that hold a reference to a Toolkit.
Configuration for Toolkit execution behavior.
Builder for ToolkitConfig.
Deserialization shape for the v1 toolkit_activeGroups session entry.
Annotation to describe parameters of a tool method.
Represents the result of a tool execution.
Builder for constructing ToolResultBlock instances.
Converts tool method return values to ToolResultBlock.
 
 
A Msg with MsgRole.TOOL pinned at construction time.
Fluent builder for ToolResultMessage.
 
 
 
Immutable tool schema definition.
Builder for creating ToolSchema instances.
A victools JSON Schema Module that reads ToolParam annotations to populate "description" and "required" in the generated schema.
Options for customizing module behavior.
Exception thrown to signal that a tool execution should be suspended and handled externally.
Represents a tool use request within a message.
Builder for constructing ToolUseBlock instances.
Unified validator for tool-related operations.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
Constants for HTTP transport layer.
Utility class for type-safe operations.
Command validator for Unix-like systems (Linux, macOS).
Represents URL-based media content.
Builder for constructing URLSource instances.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
Builder for UserAgent.
Emitted after the user has responded to a RequireUserConfirmEvent.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
已过时, 待删除: 此 API 元素将从以后的版本中删除。
A Msg with MsgRole.USER pinned at construction time.
Fluent builder for UserMessage.
AgentScope version and User-Agent information.
Represents video content in a message.
Builder for constructing VideoBlock instances.
WebSocket connection interface.
WebSocket connection request configuration.
Builder for WebSocketRequest.
WebSocket client interface.
Configuration for WebSocket clients.
Builder for WebSocketTransportConfig.
WebSocket transport layer exception.
Command validator for Windows systems.
Text file writing and insertion tools.
Credential for the xAI API.