所有类和接口
类
说明
Abstract base formatter providing common functionality for all formatter implementations.
Event fired during tool execution streaming.
Base class for tool execution (acting) related events.
Complete agent interface combining all capabilities.
Abstract base class for all agents in the AgentScope framework.
State record for agent metadata.
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.
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.
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.
Represents audio content in a message.
Builder for constructing AudioBlock instances.
Audio player for playing PCM audio data in real-time.
Builder for constructing AudioPlayer 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.
Base sealed class for all content blocks in messages.
Storage layer abstraction for tool execution context.
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.
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 Realtime TTS Model with WebSocket streaming input support.
Builder for constructing DashScopeRealtimeTTSModel instances.
Session mode for TTS.
DashScope API request DTO.
DashScope API response DTO.
Parses DashScope API responses to AgentScope ChatResponse.
DashScope tool definition DTO.
DashScope tool call DTO.
DashScope tool function definition DTO.
Handles tool registration and options application for DashScope API.
DashScope TTS Model implementation.
Builder for constructing DashScopeTTSModel instances.
DashScope TTS API request DTO.
TTS input containing text, voice, and language.
TTS parameters for audio format settings.
DashScope TTS API HTTP response.
Audio section of the output.
Output section of the response.
DashScope usage statistics DTO.
Formatter for DeepSeek Chat models (deepseek-chat, deepseek-coder).
Multi-agent formatter for DeepSeek Chat models.
Default implementation of PlanToHint that generates contextual hints based on plan state.
Default implementation of ToolResultConverter.
Document class representing a document chunk in the RAG system.
Document metadata containing content and chunking information.
Builder for constructing DocumentMetadata instances with fluent API.
Enum representing the endpoint type for DashScope models.
Event fired when an error occurs during agent execution.
An event emitted during streaming agent execution.
Types of events emitted during agent execution.
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.
Fanout pipeline implementation for parallel agent execution.
Builder for creating fanout pipelines with fluent API.
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.
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.
Generic RAG Hook for automatic knowledge retrieval before reasoning.
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.
System hook that integrates graceful shutdown into the agent lifecycle.
Global manager for graceful shutdown lifecycle and active request tracking.
Hook interface for monitoring and intercepting agent execution.
Base class for all hook events.
Enum representing all hook event types.
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 Memory with state persistence support.
In-memory implementation of PlanStorage.
In-memory implementation of the Session interface.
Exception thrown when the server encounters an internal error (HTTP 5xx).
Context information about an interruption.
Builder for InterruptContext.
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.
A built-in, out-of-the-box JSONL trace exporter based on the Hook event system.
JSON Schema definition for structured outputs.
JSON file-based session implementation.
Utility class for accessing the global
JsonCodec instance.Interface for knowledge bases.
Knowledge retrieval tools for Agentic RAG mode.
Utility class for computing hash values of state lists.
Abstract base class for long-term memory implementations.
Defines how long-term memory is integrated with agent behavior.
Tool adapter that exposes long-term memory operations as agent-callable tools.
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.
Wrapper for synchronous MCP clients that converts blocking calls to reactive Mono types.
AgentTool implementation that wraps an MCP (Model Context Protocol) tool.
Utility class for handling media files in multimodal content.
Interface for memory components that store and manage conversation history.
Constants for well-known message metadata keys.
Exception thrown when model operations fail.
Utility class for common Model operations.
Represents a message in the AgentScope framework.
MsgHub is designed to share messages among a group of agents.
Builder for MsgHub.
Defines the role of a message participant in agent conversations.
A no-op implementation of ToolEmitter that silently discards all emitted chunks.
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.
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.
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.
Policy for handling incomplete reasoning content on shutdown interruption.
Hook that automatically recovers from orphaned pending tool calls by generating error
ToolResultBlocks before the agent processes new input.Exception thrown when permission is denied (HTTP 403).
Base interface for pipeline execution in AgentScope.
Utility class providing functional-style pipeline operations.
Represents a plan containing a sequence of subtasks.
Plan notebook for managing complex tasks through structured planning.
Builder for constructing PlanNotebook instances with customizable settings.
State record for PlanNotebook.
State of a plan.
Storage interface for persisting and retrieving plans.
Interface for generating contextual hints based on the current plan state.
Event fired after tool execution completes.
Event fired after agent completes processing.
Event fired after LLM reasoning completes.
Event fired after summary generation completes.
Event fired before tool execution.
Event fired before agent starts processing.
Event fired before LLM reasoning.
Event fired before summary generation when max iterations is reached.
Configuration for HTTP and SOCKS proxy.
Builder for ProxyConfig.
Enumeration of supported proxy types.
Predefined voices for Qwen3 TTS Flash / Realtime models.
Simple gender enum for voices.
RAG (Retrieval-Augmented Generation) mode enumeration.
Exception thrown when rate limits are exceeded (HTTP 429).
ReAct (Reasoning and Acting) Agent implementation.
Tool for viewing text file content with optional line range specification and listing directory
contents.
Interface for real-time TTS models that support streaming input.
Base class for WebSocket response events from DashScope Realtime TTS API.
Error event.
Input text buffer cleared event.
Input text buffer committed event.
Response audio delta event (contains audio data).
Response audio done event.
Response content part added event.
Content part information.
Response content part done event.
Response created event.
Response information.
Response done event.
Response output item added event.
Item information.
Response output item done event.
Session created event.
Session information.
Session finished event.
Session updated event.
Unknown event type (fallback for unregistered event types).
Event fired during reasoning streaming.
Base class for reasoning-related events.
Response format configuration for OpenAI API.
Configuration for document retrieval operations.
Builder for RetrieveConfig.
An external tool implementation that only contains schema definition without execution logic.
Sequential pipeline implementation for agent orchestration.
Builder for creating sequential pipelines with fluent API.
Session storage interface for AgentScope.
Session configuration for DashScope Realtime TTS.
Information about a session.
Marker interface for session identifiers.
Utility class for managing session state with simplified API.
Tool for executing shell commands with security validation.
Persistent flag indicating that an agent was interrupted by graceful shutdown.
Session binding used for shutdown checkpoint persistence.
Global framework shutdown state.
Simple implementation of ExtendedModel using maps.
Default simple session identifier implementation using a single string.
Fluent builder for configuring code execution with custom options.
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.
Utility class for creating AgentSkill instances.
Base class for media sources (URL or Base64).
Marker interface for persistable state objects.
Interface for all stateful components in AgentScope.
Configuration for which components ReActAgent should manage state persistence.
Builder for constructing StatePersistence instances with customizable settings.
Static Long-Term Memory Hook for automatic memory management.
Interface for agents that support streaming events during execution.
Configuration options for the
StreamableAgent.stream(io.agentscope.core.agent.StreamOptions) API.Builder for
StreamOptions.Stream-based user input implementation that reads from any InputStream and writes to any
OutputStream.
Builder for StreamUserInput.
Abstract base class for agents that support structured output generation.
Configuration for how to ensure the model calls generate_response tool in structured output
mode.
Configuration for sub-agent registration.
Builder for SubAgentConfig.
Factory interface for creating agent instances.
AgentTool implementation that wraps a sub-agent for multi-turn conversation.
Represents a subtask within a plan.
State of a subtask in a plan.
Event fired during summary streaming.
Base class for summary-related events.
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.Annotation to mark a method as a tool that can be invoked by AI agents.
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.
Interface for emitting streaming responses during tool execution.
Facade for passing custom POJOs to tool methods via priority-based resolution.
Builder for ToolExecutionContext.
Provider interface for resolving ToolExecutionContext from external sources.
Represents a named group of tools with activation state.
Builder for constructing ToolGroup instances.
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.
State record for toolkit active groups.
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.
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.
Registry for the global
Tracer instance.Constants for HTTP transport layer.
Base class for TTS WebSocket events.
Append text to input buffer event.
Clear text buffer event.
Commit text buffer event.
Session finish event.
Session update event.
Exception thrown when TTS operations fail.
Hook for real-time Text-to-Speech synthesis during agent execution.
Builder for constructing TTSHook instances.
Text-to-Speech model interface.
Options for TTS synthesis.
Builder for constructing TTSOptions instances.
Response from TTS synthesis.
Builder for constructing TTSResponse instances.
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.
UserAgent class for handling user interaction within the agent framework.
Builder for UserAgent.
Strategy interface for handling user input from different sources.
Data class that holds user input information with dual representation.
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.