AS AgentScopeAPI 手册 / API Reference
功能域Functional domain

消息·事件·格式化Messages, events & formatting

Msg、内容块、流式事件与各家模型格式化器。它定义了 AgentScope 内部以及对外协议之间的数据契约,是排查“消息丢失/顺序错乱/格式不兼容”的第一站。Messages, content blocks, streaming events and provider formatters: the data contracts inside AgentScope and at protocol boundaries.

213类型总数types total
68Python
145Java
3学习锚点learning anchors

心智模型Mental model

Msg 与内容块是系统内唯一的数据契约;事件把流式增量、工具调用和生命周期状态结构化,便于前端和中间件消费。Msg and content blocks are the single data contract; events structure streaming deltas, tool calls and lifecycle state for UIs and middleware.

先学什么What to learn first

  • 消息角色只有 system/user/assistant/tool 四类,工具结果绑定 tool_call id。There are only system/user/assistant/tool roles; tool results bind to tool-call ids.
  • 流式场景处理增量块与最终消息的合并,避免重复渲染。In streaming UIs, merge incremental blocks with the final message to avoid duplicates.
  • 跨语言或跨协议时先转换到 Msg,再交给 Formatter。Convert across languages or protocols into Msg first, then hand it to a Formatter.

生产常见坑Production pitfalls

  • 把 HTML/Markdown 当作结构化内容塞进 text 块,前端无法安全渲染。Packing HTML or Markdown into text blocks makes rendering unsafe and lossy.
  • 工具结果缺少 tool_call id,模型无法关联。Tool results without tool-call ids cannot be correlated by the model.

进入对应闯关单元Practice this domain →

域内图谱Domain map

点击节点打开 API 页面;拖拽平移,滚轮缩放。Click a node to open its API page. Drag to pan, scroll to zoom.

Python Java

Python API 集Python API set 68

归入本功能域的全部 Python 公开类型,按所属包分组。Every public Python type classified into this domain, grouped by owning package.

agentscope.event33
ConfirmResultclass用于工具调用的确认结果。
CustomEventclass自定义事件,描述执行过程中的事件。
DataBlockDeltaEventclass数据块增量事件,描述执行过程中的事件。
DataBlockEndEventclass数据块结束事件,描述执行过程中的事件。
DataBlockStartEventclass数据块启动事件,描述执行过程中的事件。
EventBaseclass基类事件。
EventTypeclass事件类型,在智能体、模型与前端之间传递结构化消息和事件。
ExceedMaxItersEventclass超出最大迭代次数事件,描述执行过程中的事件。
ExternalExecutionResultEventclass外部执行结果事件,描述执行过程中的事件。
HintBlockEventclassHint 块事件,描述执行过程中的事件。
ModelCallEndEventclass模型调用结束事件,描述执行过程中的事件。
ModelCallStartEventclass模型调用启动事件,描述执行过程中的事件。
ReplyEndEventclass回复结束事件,描述执行过程中的事件。
ReplyEndReasonclass回复结束推理,在智能体、模型与前端之间传递结构化消息和事件。
ReplyFinishedReasonclass回复 Finished 推理,在智能体、模型与前端之间传递结构化消息和事件。
ReplyStartEventclass回复启动事件,描述执行过程中的事件。
RequireExternalExecutionEventclassRequire 外部执行事件,描述执行过程中的事件。
RequireUserConfirmEventclassRequire 用户确认事件,描述执行过程中的事件。
TextBlockDeltaEventclass文本块增量事件,描述执行过程中的事件。
TextBlockEndEventclass文本块结束事件,描述执行过程中的事件。
TextBlockStartEventclass文本块启动事件,描述执行过程中的事件。
ThinkingBlockDeltaEventclassThinking 块增量事件,描述执行过程中的事件。
ThinkingBlockEndEventclassThinking 块结束事件,描述执行过程中的事件。
ThinkingBlockStartEventclassThinking 块启动事件,描述执行过程中的事件。
ToolCallDeltaEventclass工具调用增量事件,描述执行过程中的事件。
ToolCallEndEventclass工具调用结束事件,描述执行过程中的事件。
ToolCallStartEventclass工具调用启动事件,描述执行过程中的事件。
ToolResultDataDeltaEventclass工具结果数据增量事件,描述执行过程中的事件。
ToolResultEndEventclass工具结果结束事件,描述执行过程中的事件。
ToolResultStartEventclass工具结果启动事件,描述执行过程中的事件。
ToolResultTextDeltaEventclass工具结果文本增量事件,描述执行过程中的事件。
UserConfirmResultEventclass用户确认结果事件,描述执行过程中的事件。
UserInterruptEventclass用户中断事件,描述执行过程中的事件。
agentscope.formatter23
AnthropicChatFormatterclassAnthropic 聊天格式化器,在智能体、模型与前端之间传递结构化消息和事件。
AnthropicMultiAgentFormatterclassAnthropic Multi 智能体格式化器,在智能体、模型与前端之间传递结构化消息和事件。
DashScopeChatFormatterclassDashScope 聊天格式化器,在智能体、模型与前端之间传递结构化消息和事件。
DashScopeMultiAgentFormatterclassDashScope Multi 智能体格式化器,在智能体、模型与前端之间传递结构化消息和事件。
DeepSeekChatFormatterclassDeepSeek 聊天格式化器,在智能体、模型与前端之间传递结构化消息和事件。
DeepSeekMultiAgentFormatterclassDeepSeek Multi 智能体格式化器,在智能体、模型与前端之间传递结构化消息和事件。
FormatterBaseclass消息格式转换基类
GeminiChatFormatterclassGemini 聊天格式化器,在智能体、模型与前端之间传递结构化消息和事件。
GeminiMultiAgentFormatterclassGemini Multi 智能体格式化器,在智能体、模型与前端之间传递结构化消息和事件。
MiniMaxChatFormatterclassMiniMax 聊天格式化器,在智能体、模型与前端之间传递结构化消息和事件。
MiniMaxMultiAgentFormatterclassMiniMax Multi 智能体格式化器,在智能体、模型与前端之间传递结构化消息和事件。
MoonshotChatFormatterclassMoonshot 聊天格式化器,在智能体、模型与前端之间传递结构化消息和事件。
MoonshotMultiAgentFormatterclassMoonshot Multi 智能体格式化器,在智能体、模型与前端之间传递结构化消息和事件。
OllamaChatFormatterclassOllama 聊天格式化器,在智能体、模型与前端之间传递结构化消息和事件。
OllamaMultiAgentFormatterclassOllama Multi 智能体格式化器,在智能体、模型与前端之间传递结构化消息和事件。
OpenAIChatFormatterclassOpenAI 聊天格式化器,在智能体、模型与前端之间传递结构化消息和事件。
OpenAIMultiAgentFormatterclassOpenAI Multi 智能体格式化器,在智能体、模型与前端之间传递结构化消息和事件。
OpenAIResponseFormatterclassOpenAIResponse 格式化器,在智能体、模型与前端之间传递结构化消息和事件。
OpenAIResponseMultiAgentFormatterclassOpenAIResponse Multi 智能体格式化器,在智能体、模型与前端之间传递结构化消息和事件。
VolcengineChatFormatterclass火山引擎聊天格式化器,在智能体、模型与前端之间传递结构化消息和事件。
VolcengineMultiAgentFormatterclass火山引擎 Multi 智能体格式化器,在智能体、模型与前端之间传递结构化消息和事件。
XAIChatFormatterclass用于xAI 聊天模型的格式化器。
XAIMultiAgentFormatterclassxAI Multi 智能体格式化器,在智能体、模型与前端之间传递结构化消息和事件。
agentscope.message12
Base64Sourceclassbase64 来源。
DataBlockclass数据块,在智能体、模型与前端之间传递结构化消息和事件。
HintBlockclassHint 块,在智能体、模型与前端之间传递结构化消息和事件。
Msgclass统一消息对象
TextBlockclass文本块。
ThinkingBlockclassThinking 块,在智能体、模型与前端之间传递结构化消息和事件。
ToolCallBlockclass工具调用块。
ToolCallStateclass工具调用的状态。
ToolResultBlockclass工具结果块。
ToolResultStateclass工具结果状态。
URLSourceclassURL 来源。
Usageclass用量,在智能体、模型与前端之间传递结构化消息和事件。

Java API 集Java API set 145

归入本功能域的全部 Java 公开类型,按包分组并标注构件。Every public Java type classified into this domain, grouped by package with its artifact.

io.agentscope.core.message38
AssistantMessageclassagentscope-coreAssistant 消息,在智能体、模型与前端之间传递结构化消息和事件。
AudioBlockclassagentscope-core表示音频内容 in 消息。
Base64Sourceclassagentscope-core基类 64 来源,在智能体、模型与前端之间传递结构化消息和事件。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
ContentBlockclassagentscope-core内容块,在智能体、模型与前端之间传递结构化消息和事件。
DataBlockclassagentscope-core数据块,在智能体、模型与前端之间传递结构化消息和事件。
GenerateReasonenumagentscope-core定义Generate 推理相关取值的枚举。
HintBlockclassagentscope-coreHint 块,在智能体、模型与前端之间传递结构化消息和事件。
ImageBlockclassagentscope-core表示图像内容 in 消息使用 URL 或 Base64 来源。
MessageMetadataKeysclassagentscope-core消息元数据密钥,在智能体、模型与前端之间传递结构化消息和事件。
Msgclassagentscope-coreJava 消息模型
MsgRoleenumagentscope-core定义消息角色相关取值的枚举。
Sourceclassagentscope-core来源,在智能体、模型与前端之间传递结构化消息和事件。
SystemMessageclassagentscope-core系统消息,在智能体、模型与前端之间传递结构化消息和事件。
TextBlockclassagentscope-core文本块,在智能体、模型与前端之间传递结构化消息和事件。
ThinkingBlockclassagentscope-coreThinking 块,在智能体、模型与前端之间传递结构化消息和事件。
ToolCallStateenumagentscope-core定义工具调用状态的枚举。
ToolResultBlockclassagentscope-core表示结果的工具执行。
ToolResultMessageclassagentscope-core工具结果消息,在智能体、模型与前端之间传递结构化消息和事件。
ToolResultStateenumagentscope-core定义工具结果状态的枚举。
ToolUseBlockclassagentscope-core工具使用块,在智能体、模型与前端之间传递结构化消息和事件。
URLSourceclassagentscope-coreURL 来源,在智能体、模型与前端之间传递结构化消息和事件。
UserMessageclassagentscope-core用户消息,在智能体、模型与前端之间传递结构化消息和事件。
VideoBlockclassagentscope-core表示视频内容 in 消息。
io.agentscope.core.agui.event36
ActivityDeltarecordagentscope-extensions-agui承载 Activity 增量数据的记录类型。
ActivitySnapshotrecordagentscope-extensions-agui承载 Activity 快照数据的记录类型。
AguiEventinterfaceagentscope-extensions-agui定义 AGUI 事件契约的接口。
AguiEventsclassagentscope-extensions-aguiAGUI 事件,描述执行过程中的事件。
AguiEventTypeenumagentscope-extensions-agui定义AGUI 事件类型的枚举。
Customrecordagentscope-extensions-agui承载自定义数据的记录类型。
Interruptrecordagentscope-extensions-agui承载中断数据的记录类型。
JsonPatchOperationrecordagentscope-extensions-agui承载 JSON Patch Operation数据的记录类型。
MessagesSnapshotrecordagentscope-extensions-agui承载消息快照数据的记录类型。
Rawrecordagentscope-extensions-agui承载原始数据的记录类型。
ReasoningEncryptedValuerecordagentscope-extensions-agui承载推理已加密值数据的记录类型。
ReasoningEndrecordagentscope-extensions-agui承载推理结束数据的记录类型。
ReasoningMessageChunkrecordagentscope-extensions-agui承载推理消息分块数据的记录类型。
ReasoningMessageContentrecordagentscope-extensions-agui承载推理消息内容数据的记录类型。
ReasoningMessageEndrecordagentscope-extensions-agui承载推理消息结束数据的记录类型。
ReasoningMessageStartrecordagentscope-extensions-agui承载推理消息启动数据的记录类型。
ReasoningStartrecordagentscope-extensions-agui承载推理启动数据的记录类型。
RunErrorrecordagentscope-extensions-agui承载运行错误数据的记录类型。
RunFinishedrecordagentscope-extensions-agui承载运行 Finished数据的记录类型。
RunFinishedInterruptOutcomerecordagentscope-extensions-agui承载运行 Finished 中断 Outcome数据的记录类型。
RunFinishedOutcomeinterfaceagentscope-extensions-agui定义运行 Finished Outcome契约的接口。
RunFinishedSuccessOutcomerecordagentscope-extensions-agui承载运行 Finished 成功 Outcome数据的记录类型。
RunStartedrecordagentscope-extensions-agui承载运行已启动数据的记录类型。
StateDeltarecordagentscope-extensions-agui承载状态增量数据的记录类型。
StateSnapshotrecordagentscope-extensions-agui承载状态快照数据的记录类型。
StepFinishedrecordagentscope-extensions-agui承载步骤 Finished数据的记录类型。
StepStartedrecordagentscope-extensions-agui承载步骤已启动数据的记录类型。
TextMessageChunkrecordagentscope-extensions-agui承载文本消息分块数据的记录类型。
TextMessageContentrecordagentscope-extensions-agui承载文本消息内容数据的记录类型。
TextMessageEndrecordagentscope-extensions-agui承载文本消息结束数据的记录类型。
TextMessageStartrecordagentscope-extensions-agui承载文本消息启动数据的记录类型。
ToolCallArgsrecordagentscope-extensions-agui承载工具调用参数数据的记录类型。
ToolCallChunkrecordagentscope-extensions-agui承载工具调用分块数据的记录类型。
ToolCallEndrecordagentscope-extensions-agui承载工具调用结束数据的记录类型。
ToolCallResultrecordagentscope-extensions-agui承载工具调用结果数据的记录类型。
ToolCallStartrecordagentscope-extensions-agui承载工具调用启动数据的记录类型。
io.agentscope.core.event35
AgentEndEventclassagentscope-core智能体结束事件,描述执行过程中的事件。
AgentEventclassagentscope-core智能体事件,描述执行过程中的事件。
AgentEventEmitterinterfaceagentscope-core定义智能体事件 Emitter契约的接口。
AgentEventTypeenumagentscope-core定义智能体事件类型的枚举。
AgentResultEventclassagentscope-core智能体结果事件,描述执行过程中的事件。
AgentStartEventclassagentscope-core智能体启动事件,描述执行过程中的事件。
AllToolsDeniedEventclassagentscope-core所有工具已拒绝事件,描述执行过程中的事件。
ConfirmResultclassagentscope-core确认结果,在智能体、模型与前端之间传递结构化消息和事件。
CustomEventclassagentscope-core自定义事件,描述执行过程中的事件。
DataBlockDeltaEventclassagentscope-core数据块增量事件,描述执行过程中的事件。
DataBlockEndEventclassagentscope-core数据块结束事件,描述执行过程中的事件。
DataBlockStartEventclassagentscope-core数据块启动事件,描述执行过程中的事件。
ExceedMaxItersEventclassagentscope-core超出最大迭代次数事件,描述执行过程中的事件。
ExternalExecutionResultEventclassagentscope-core外部执行结果事件,描述执行过程中的事件。
HintBlockEventclassagentscope-coreHint 块事件,描述执行过程中的事件。
ModelCallEndEventclassagentscope-core模型调用结束事件,描述执行过程中的事件。
ModelCallStartEventclassagentscope-core模型调用启动事件,描述执行过程中的事件。
RequestStopEventclassagentscope-core请求停止事件,描述执行过程中的事件。
RequireExternalExecutionEventclassagentscope-coreRequire 外部执行事件,描述执行过程中的事件。
RequireUserConfirmEventclassagentscope-coreRequire 用户确认事件,描述执行过程中的事件。
SubagentExposedEventclassagentscope-core子智能体 Exposed 事件,描述执行过程中的事件。
TextBlockDeltaEventclassagentscope-core文本块增量事件,描述执行过程中的事件。
TextBlockEndEventclassagentscope-core文本块结束事件,描述执行过程中的事件。
TextBlockStartEventclassagentscope-core文本块启动事件,描述执行过程中的事件。
ThinkingBlockDeltaEventclassagentscope-coreThinking 块增量事件,描述执行过程中的事件。
ThinkingBlockEndEventclassagentscope-coreThinking 块结束事件,描述执行过程中的事件。
ThinkingBlockStartEventclassagentscope-coreThinking 块启动事件,描述执行过程中的事件。
ToolCallDeltaEventclassagentscope-core工具调用增量事件,描述执行过程中的事件。
ToolCallEndEventclassagentscope-core工具调用结束事件,描述执行过程中的事件。
ToolCallStartEventclassagentscope-core工具调用启动事件,描述执行过程中的事件。
ToolResultDataDeltaEventclassagentscope-core工具结果数据增量事件,描述执行过程中的事件。
ToolResultEndEventclassagentscope-core工具结果结束事件,描述执行过程中的事件。
ToolResultStartEventclassagentscope-core工具结果启动事件,描述执行过程中的事件。
ToolResultTextDeltaEventclassagentscope-core工具结果文本增量事件,描述执行过程中的事件。
UserConfirmResultEventclassagentscope-core用户确认结果事件,描述执行过程中的事件。
io.agentscope.core.formatter8
AbstractBaseFormatterclassagentscope-core抽象基类格式化器,在智能体、模型与前端之间传递结构化消息和事件。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Builderclassagentscope-core构建器,用于构建并配置目标实例。
Formatterinterfaceagentscope-core请求与响应格式转换器
FormatterExceptionclassagentscope-core格式化器异常,表示执行过程中的错误。
JsonSchemaclassagentscope-coreJSON 模式,在智能体、模型与前端之间传递结构化消息和事件。
MediaUtilsclassagentscope-coreMedia Utils,在智能体、模型与前端之间传递结构化消息和事件。
ResponseFormatclassagentscope-core用于模型 APIs的响应格式配置。
io.agentscope.core.agui5
AgentNotFoundExceptionclassagentscope-extensions-agui智能体未找到异常,表示执行过程中的错误。
AguiExceptionclassagentscope-extensions-aguiAGUI 异常,表示执行过程中的错误。
AguiInterruptConstantsclassagentscope-extensions-aguiAGUI 中断 Constants,在智能体、模型与前端之间传递结构化消息和事件。
AguiUtilclassagentscope-extensions-aguiAGUI Util,在智能体、模型与前端之间传递结构化消息和事件。
EncodingExceptionclassagentscope-extensions-aguiEncoding 异常,表示执行过程中的错误。
io.agentscope.core.agui.adapter.strategy5
AgentEventConverterinterfaceagentscope-extensions-agui定义智能体事件转换器契约的接口。
AgentEventConverterRegistryclassagentscope-extensions-agui智能体事件转换器注册表,在智能体、模型与前端之间传递结构化消息和事件。
AguiEventEnricherinterfaceagentscope-extensions-agui定义 AGUI 事件 Enricher契约的接口。
AguiStreamContextclassagentscope-extensions-aguiAGUI 流上下文,在智能体、模型与前端之间传递结构化消息和事件。
BaseEventPropertiesEnricherclassagentscope-extensions-agui基类事件属性 Enricher,在智能体、模型与前端之间传递结构化消息和事件。
io.agentscope.core.agui.runtime5
AguiRequestBodyParserclassagentscope-extensions-aguiAGUI 请求正文解析器,在智能体、模型与前端之间传递结构化消息和事件。
AguiRuntimeContextRequestclassagentscope-extensions-aguiAGUI 运行时上下文请求,在智能体、模型与前端之间传递结构化消息和事件。
AguiRuntimeContextResolverinterfaceagentscope-extensions-agui定义 AGUI 运行时上下文解析器契约的接口。
Builderclassagentscope-extensions-agui`AguiRuntimeContextRequest`的构建器。
Transportenumagentscope-extensions-agui定义传输层相关取值的枚举。
io.agentscope.core.agui.adapter4
AguiAdapterConfigclassagentscope-extensions-agui用于AG-UI 智能体适配器的配置。
AguiAgentAdapterclassagentscope-extensions-aguiAGUI 智能体适配器,在智能体、模型与前端之间传递结构化消息和事件。
AguiAgentAdapterFactoryinterfaceagentscope-extensions-agui定义 AGUI 智能体适配器工厂契约的接口。
Builderclassagentscope-extensions-aguiAguiAdapterConfig的构建器。
io.agentscope.core.agui.processor4
AgentResolverinterfaceagentscope-extensions-agui定义智能体解析器契约的接口。
AguiRequestProcessorclassagentscope-extensions-aguiAGUI 请求处理器,在智能体、模型与前端之间传递结构化消息和事件。
Builderclassagentscope-extensions-aguiAguiRequestProcessor的构建器。
ProcessResultrecordagentscope-extensions-agui承载 Process 结果数据的记录类型。
io.agentscope.core.agui.converter3
AguiMessageConverterclassagentscope-extensions-aguiAGUI 消息转换器,在智能体、模型与前端之间传递结构化消息和事件。
AguiStateConverterclassagentscope-extensions-agui用于状态管理,使用 AG-UI 协议的转换器。
AguiToolConverterclassagentscope-extensions-aguiAGUI 工具转换器,在智能体、模型与前端之间传递结构化消息和事件。
io.agentscope.core.agui.encoder1
AguiEventEncoderclassagentscope-extensions-aguiAGUI 事件 Encoder,在智能体、模型与前端之间传递结构化消息和事件。
io.agentscope.core.agui.registry1
AguiAgentRegistryclassagentscope-extensions-aguiAGUI 智能体注册表,在智能体、模型与前端之间传递结构化消息和事件。

Python ↔ Java 对照Python ↔ Java

两套实现共享同一概念模型,但在并发(async/await 与 Reactor)、打包(wheel 模块与 Maven 构件)和生命周期 API 上存在差异。需要精确签名时请使用 API 全景。The two implementations follow the same conceptual model but differ in concurrency (async/await vs Reactor), packaging (wheel modules vs Maven artifacts) and lifecycle APIs. Use the full API map to locate exact signatures.

打开 API 全景Open full API map →

基于官方固定版本源码静态生成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.