所有类和接口
类
说明
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.
已过时。
since 2.0.0.
Builder for creating AgentSkill instances.
已过时。
since 2.0.0.
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.
Abstract base formatter for Anthropic API with shared logic for handling Anthropic-specific
requirements.
Formatter for Anthropic Messages API.
Anthropic Chat Model implementation using the official Anthropic Java SDK.
Builder for AnthropicChatModel.
Merges multi-agent conversation messages into a formatted conversation history for Anthropic
API.
Credential for the Anthropic API.
Handles media content conversion for Anthropic API.
Converts AgentScope Msg objects to Anthropic SDK MessageParam types.
Multi-agent formatter for Anthropic Messages API.
Parses Anthropic API responses (both streaming and non-streaming) into AgentScope ChatResponse
objects.
Helper class for tool registration and option application for Anthropic API.
A
Msg with MsgRole.ASSISTANT pinned at construction time.Fluent builder for
AssistantMessage.Represents audio content in a message.
Builder for constructing AudioBlock instances.
Exception thrown when authentication fails (HTTP 401).
Exception thrown when the request is malformed (HTTP 400).
Represents Base64-encoded media content with media type and data.
Builder for constructing Base64Source instances.
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.Formatter for DashScope Conversation/Generation APIs.
DashScope Chat Model using native HTTP API.
DashScope choice DTO.
DashScope content part DTO for multimodal messages.
Merges multi-agent conversation messages for DashScope API.
Credential for the DashScope (Alibaba Cloud) OpenAI-compatible API.
Encryption utilities for secure DashScope API access.
Exception thrown when encryption/decryption operations fail.
DashScope function call DTO.
HTTP client for DashScope API.
Builder for DashScopeHttpClient.
Exception thrown when DashScope HTTP operations fail.
Result of fetching a public key from DashScope API.
DashScope API input container DTO.
Handles media content conversion for DashScope API.
DashScope message DTO.
Converts AgentScope Msg objects to DashScope DTO message types.
DashScope formatter for multi-agent conversations.
DashScope multimodal tool.
DashScope output DTO.
DashScope API parameters DTO.
DashScope public key response DTO.
Public key data containing the key ID and key value.
DashScope API request DTO.
DashScope API response DTO.
Parses DashScope API responses to AgentScope ChatResponse.
DashScope search options DTO.
DashScope tool definition DTO.
DashScope tool call DTO.
DashScope tool function definition DTO.
Handles tool registration and options application for DashScope API.
DashScope usage statistics DTO.
Unified data block for arbitrary binary media (image / audio / video / file).
Builder for constructing DataBlock instances.
Credential for the DeepSeek API.
Formatter for DeepSeek Chat models (deepseek-chat, deepseek-coder).
Multi-agent formatter for DeepSeek Chat models.
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.Enum representing the endpoint type for DashScope models.
已过时, 待删除: 此 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.
Formatter for Gemini Content Generation API.
Gemini Chat Model implementation using the official Google GenAI Java SDK.
Builder for creating GeminiChatModel instances.
Merges multi-agent conversation messages for Gemini API.
Credential for the Google Gemini API.
Converter for Gemini API multimodal content.
Converter for transforming AgentScope Msg objects to Gemini API Content format.
Gemini formatter for multi-agent conversations.
Parses Gemini API responses to AgentScope ChatResponse.
Handles tool registration and configuration for Gemini API.
Immutable generation options for LLM models.
Represents the reason why a message was generated by an agent.
已过时, 待删除: 此 API 元素将从以后的版本中删除。
since 2.0.0.
Formatter for Zhipu GLM models (glm-4, glm-3-turbo, etc.).
Multi-agent formatter for Zhipu GLM models.
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.
Exception thrown when the server encounters an internal error (HTTP 5xx).
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.
已过时。
since 2.0.0.
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.
Exception thrown when model operations fail.
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.
Exception thrown when the requested resource is not found (HTTP 404).
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.
Formatter for Ollama Chat API.
AgentScope ChatModel implementation for Ollama.
Merges multi-agent conversation messages for Ollama API.
Credential for the Ollama local server (connection settings only).
Ollama embedding request DTO.
Ollama embedding response DTO.
Ollama function execution DTO.
HTTP client for Ollama API.
Builder for OllamaHttpClient.
Exception thrown when Ollama HTTP operations fail.
Handles media content conversion for Ollama API.
Ollama chat message DTO.
Converter for transforming AgentScope Msg objects to OllamaMessage objects.
Ollama formatter for multi-agent conversations.
AgentScope implementation of Ollama model configuration options.
Keys for Ollama parameters.
Ollama chat request DTO.
Ollama chat response DTO.
Parser for converting OllamaResponse objects to AgentScope ChatResponse objects.
Ollama tool definition DTO.
Ollama tool call DTO.
Ollama tool function definition DTO.
Helper class for managing Ollama tool conversions and options application.
Base formatter for OpenAI Chat Completion HTTP API.
Formatter for OpenAI Chat Completion HTTP API.
OpenAI Chat Model using native HTTP API.
Builder for OpenAIChatModel.
OpenAI choice DTO.
Stateless HTTP client for OpenAI-compatible APIs.
OpenAI content part DTO for multimodal messages.
Merges multi-agent conversation messages for OpenAI HTTP API.
Utility class for OpenAI message and conversation conversion.
Credential for the OpenAI API.
OpenAI error DTO.
Base exception for all OpenAI API errors.
OpenAI function call DTO.
OpenAI image URL DTO.
OpenAI input audio DTO.
OpenAI message DTO.
Converts AgentScope Msg objects to OpenAI DTO types (for HTTP API).
Multi-agent formatter for OpenAI Chat Completion HTTP API.
OpenAI multimodal tool.
OpenAI Reasoning Detail DTO (OpenRouter specific for Gemini).
OpenAI Chat Completion API request DTO.
OpenAI Chat Completion API response DTO.
Parses OpenAI HTTP API responses to AgentScope ChatResponse.
OpenAI stream options DTO.
OpenAI tool definition DTO.
OpenAI tool call DTO.
OpenAI tool function definition DTO.
OpenAI usage statistics DTO.
Detailed breakdown of completion tokens.
Detailed breakdown of prompt tokens.
OpenAI video URL DTO.
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.
Exception thrown when permission is denied (HTTP 403).
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.
Exception thrown when rate limits are exceeded (HTTP 429).
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 OpenAI API.
已过时, 待删除: 此 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.
已过时。
since 2.0.0.
Fluent builder for registering skills with optional configuration.
已过时。
since 2.0.0.
已过时。
since 2.0.0.
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.
已过时。
since 2.0.0.
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.
Configuration options for the
StreamableAgent.stream(io.agentscope.core.agent.StreamOptions) API.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.
Defines the configuration contract for the "thinking" capability (Chain of Thought) in AgentScope's Ollama integration.
Implementation of
ThinkOption representing a binary state (Enabled/Disabled).Implementation of
ThinkOption representing a specific level of reasoning effort.Custom deserializer implementation for
ThinkOption.Custom serializer implementation for
ThinkOption.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).
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.
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).
Exception thrown when the request is well-formed but semantically incorrect (HTTP 422).
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.