类class io.agentscope.core.message 2.x

MessageMetadataKeys

public final class MessageMetadataKeys

源码Source io/agentscope/core/message/MessageMetadataKeys.java:24–156

消息元数据密钥，在智能体、模型与前端之间传递结构化消息和事件。位于 io.agentscope.core.message 包。核心成员包括 BYPASS_MULTIAGENT_HISTORY_MERGE、STRUCTURED_OUTPUT_REMINDER、STRUCTURED_OUTPUT_REMINDER_TYPE、SUMMARY_FAILED、CHAT_USAGE、STRUCTURED_OUTPUT。

Constants for well-known message metadata keys.

This class defines standard metadata keys used across the framework to ensure consistency and avoid magic strings.

字段摘要Field Summary

字段Field	类型Type	说明Description
`BYPASS_MULTIAGENT_HISTORY_MERGE` staticfinal	String	BYPASS 多智能体历史 MERGE字段。 Metadata key to bypass history merging in multiagent formatters.
`STRUCTURED_OUTPUT_REMINDER` staticfinal	String	结构化输出 REMINDER字段。 Metadata key to mark structured output reminder messages.
`STRUCTURED_OUTPUT_REMINDER_TYPE` staticfinal	String	结构化输出 REMINDER 类型字段。 Metadata key for the type of structured output reminder.
`SUMMARY_FAILED` staticfinal	String	摘要失败字段。 Metadata key to indicate that summary generation failed after reaching max iterations.
`CHAT_USAGE` staticfinal	String	聊天用量字段。 Metadata key for chat usage statistics.
`STRUCTURED_OUTPUT` staticfinal	String	用于结构化输出数据的元数据密钥。 Metadata key for structured output data.
`CACHE_CONTROL` staticfinal	String	缓存 CONTROL字段。 Metadata key to explicitly mark a message for prompt caching or non-caching.
`TOOL_RETURN_DIRECT` staticfinal	String	工具 RETURN DIRECT字段。 Metadata key marking an assistant message synthesized by the `returnDirect` tool path (the tool result presented as the turn's final answer).

字段详情Field Detail

BYPASS_MULTIAGENT_HISTORY_MERGE

public static final String BYPASS_MULTIAGENT_HISTORY_MERGE

staticfinal

BYPASS 多智能体历史 MERGE字段。声明为 public static final String BYPASS_MULTIAGENT_HISTORY_MERGE。

Metadata key to bypass history merging in multiagent formatters.

源码Source io/agentscope/core/message/MessageMetadataKeys.java:48

STRUCTURED_OUTPUT_REMINDER

public static final String STRUCTURED_OUTPUT_REMINDER

staticfinal

结构化输出 REMINDER字段。声明为 public static final String STRUCTURED_OUTPUT_REMINDER。

Metadata key to mark structured output reminder messages.

源码Source io/agentscope/core/message/MessageMetadataKeys.java:59

STRUCTURED_OUTPUT_REMINDER_TYPE

public static final String STRUCTURED_OUTPUT_REMINDER_TYPE

staticfinal

结构化输出 REMINDER 类型字段。声明为 public static final String STRUCTURED_OUTPUT_REMINDER_TYPE。

Metadata key for the type of structured output reminder.

源码Source io/agentscope/core/message/MessageMetadataKeys.java:71

SUMMARY_FAILED

public static final String SUMMARY_FAILED

staticfinal

摘要失败字段。声明为 public static final String SUMMARY_FAILED。

Metadata key to indicate that summary generation failed after reaching max iterations.

源码Source io/agentscope/core/message/MessageMetadataKeys.java:79

CHAT_USAGE

public static final String CHAT_USAGE

staticfinal

聊天用量字段。声明为 public static final String CHAT_USAGE。

Metadata key for chat usage statistics.

源码Source io/agentscope/core/message/MessageMetadataKeys.java:105

STRUCTURED_OUTPUT

public static final String STRUCTURED_OUTPUT

staticfinal

用于结构化输出数据的元数据密钥。

Metadata key for structured output data.

源码Source io/agentscope/core/message/MessageMetadataKeys.java:120

CACHE_CONTROL

public static final String CACHE_CONTROL

staticfinal

缓存 CONTROL字段。声明为 public static final String CACHE_CONTROL。

Metadata key to explicitly mark a message for prompt caching or non-caching.

源码Source io/agentscope/core/message/MessageMetadataKeys.java:147

TOOL_RETURN_DIRECT

public static final String TOOL_RETURN_DIRECT

staticfinal

工具 RETURN DIRECT字段。声明为 public static final String TOOL_RETURN_DIRECT。

Metadata key marking an assistant message synthesized by the returnDirect tool path (the tool result presented as the turn's final answer).

源码Source io/agentscope/core/message/MessageMetadataKeys.java:155