langchain_core.messages.tool.ToolMessageChunk

class langchain_core.messages.tool.ToolMessageChunk[source]

基础: ToolMessageBaseMessageChunk

工具消息块。

将内容作为位置参数传入。

参数
  • content – 消息的字符串内容。

  • kwargs – 要传递给消息的其他字段

参数additional_kwargs:dict [可选]

保留用于与消息关联的附加有效载荷数据。

例如,对于来自AI的消息,这可能包括模型提供商编码的工具调用。

参数artifact:Any =None

工具执行的工件,这些工件不打算发送给模型。

只有在它与消息内容不同的情况下才指定,例如,如果只有工具的全部输出的子集作为消息内容被传递,但需要使用代码的其他部分使用全部输出。

自版本 0.2.17 新增。

参数content:Union[str,List[Union[str,Dict]]]] [必需]

消息的字符串内容。

参数id:Optional[str] =None

消息的可选唯一标识符。理想情况下,应由创建信息的提供者/模型提供。

参数name:Optional[str] =None

消息的可选名称。

可用于为消息提供一个可读的名称。

此字段的用法是可选的,是否使用取决于模型实现。

param response_metadata: dict [可选]

响应元数据。例如:响应头、对数概率、令牌计数。

param status: Symbol['success', 'error'] = 'success'

工具调用的状态。

自版本 0.2.24 以来新增。

param tool_call_id: str [必选]

此消息响应的工具调用。

param type: Symbol['ToolMessageChunk'] = 'ToolMessageChunk'

消息类型(用于序列化)。默认为"tool"。

pretty_print() None
返回类型

pretty_repr(html: bool = False) str

获取消息的漂亮表示。

参数

html (布尔值) – 是否将消息格式化为HTML。如果为True,则消息将带有HTML标签。默认为False。

返回

消息的漂亮表示。

返回类型

字符串

使用ToolMessageChunk的示例