提交工具执行结果

请求地址

权限

submitToolChat
确保调用该接口使用的访问令牌开通了 submitToolChat 权限，详细信息参考准备工作。

接口说明

调用接口提交工具执行结果。

Authorization

Bearer $Access_Token

用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌，详细信息，参考鉴权方式。

Content-Type

application/json

解释请求正文的方式。

conversation_id

String

必选

748348012449138***

Conversation ID，即会话的唯一标识。可以在发起对话接口 Response 中查看 conversation_id 字段。

chat_id

String

必选

738137187639794***

Chat ID，即对话的唯一标识。可以在发起对话接口 Response 中查看 id 字段，如果是流式响应，则在 Response 的 chat 事件中查看 id 字段。

stream

Boolean

可选

true

是否开启流式响应。

• true：填充之前对话中的上下文，继续流式响应。
• false：（默认）非流式响应，仅回复对话的基本信息。

tool_outputs

Array of ToolOutput

必选

[{“tool_call_id”:“BUJJF0dAQ0NAEBVeQkVKEV5HFURFXhFCEhFeFxdHShcSQEtFSxY****”,“output”:“Tokyo”}]

工具执行结果。

output

String

必选

{"file": "12345"}

工具的执行结果。
如果端插件工具某个请求参数包含 Image 等文件类型，可以先调用上传文件 API 获取 file_id，然后调用此 API 在 output 中以序列化之后的 JSON 格式传入 file_id。例如入参 file 为文件类型，文件的 file_id 为 12345，则 output 可以指定为 "output": "{\"file\": \"12345\"}"。

tool_call_id

String

必选

BUJJF0dAQ0NAEBVeQkVKEV5HFURFXhFCEhFeFxdHShcSQEtFSxY****

上报运行结果的 ID。你可以在发起对话（V3）接口响应的 tool_calls 字段下查看此 ID。

code

Long

0

调用状态码。0 表示调用成功，其他值表示调用失败，你可以通过 msg 字段判断详细的错误原因。

data

Object of ChatV3ChatDetail

本次对话的基本信息。

msg

String

“”

状态信息。API 调用失败时可通过此字段查看详细错误信息。
状态码为 0 时，msg 默认为空。

detail

Object of ResponseDetail

{“logid”:“20241210152726467C48D89D6DB2****”}

响应的详细信息。

id

String

738137187639794****

对话 ID，即对话的唯一标识。

conversation_id

String

738136585609548****

会话 ID，即会话的唯一标识。

bot_id

String

737946218936519****

该会话所属的智能体的 ID。

status

String

completed

对话的运行状态。取值为：

• created：对话已创建。
• in_progress：智能体正在处理中。
• completed：智能体已完成处理，本次对话结束。
• failed：对话失败。
• requires_action：对话中断，需要进一步处理。
• canceled：对话已取消。

created_at

Integer

1718609571

对话创建的时间。格式为 10 位的 Unixtime 时间戳，单位为秒。

completed_at

Integer

1718609575

对话结束的时间。格式为 10 位的 Unixtime 时间戳，单位为秒。

failed_at

Integer

1718609571

对话失败的时间。格式为 10 位的 Unixtime 时间戳，单位为秒。

meta_data

JSON Map

{“customKey1”:“customValue1”,“customKey2”:“customValue2”}

发起对话时的附加消息，用于传入使用方的自定义数据，查看对话详情时也会返回此附加消息。
自定义键值对，应指定为 Map 对象格式。长度为 16 对键值对，其中键（key）的长度范围为 1～64 个字符，值（value）的长度范围为 1～512 个字符。

last_error

Object of LastError

\

对话运行异常时，此字段中返回详细的错误信息，包括：

• Code：错误码。Integer 类型。0 表示成功，其他值表示失败。
• Msg：错误信息。String 类型。

section_id

String

737946218936519****

上下文片段 ID。每次调用清除上下文 API 都会生成一个新的 section_id。

required_action

Object of RequiredAction

{“type”:“submit_tool_outputs”,“submit_tool_outputs”:{“tool_calls”:[{“id”:“738137187639794****”,“type”:“function”,“function”:{“name”:“get_weather”,“arguments”:“{"city":"Beijing"}”}}]}}

当对话状态为 requires_action 时，此字段包含需要进一步处理的信息详情，用于继续对话。

usage

Object of Usage

预留字段，无需关注，具体消耗的 Token 请查看火山账单。

msg

String

详见响应示例

状态信息。API 调用失败时可通过此字段查看详细错误信息。

code

Integer

0

状态码。
0 代表调用成功。

type

String

submit_tool_outputs

额外操作的类型，枚举值：
submit_tool_outputs：需要提交工具输出以继续对话。

submit_tool_outputs

Object of SubmitToolOutputs

{“tool_calls”:[{“id”:“738137187639794****”,“type”:“function”,“function”:{“name”:“get_weather”,“arguments”:“{"city":"Beijing"}”}}]}

当对话状态为 requires_action时，此字段包含需要提交的工具输出信息，用于继续对话。通常包含一个工具调用列表，每个工具调用包含工具类型和参数。

tool_calls

Array of InterruptPlugin

[{“id”:“738137187639794****”,“type”:“function”,“function”:{“name”:“get_weather”,“arguments”:“{"city":"Beijing"}”}}]

当对话状态为 requires_action 时，此字段包含需要提交的工具调用列表，每个工具调用包含工具类型和参数。

id

String

738137187639794****

上报运行结果的 ID。

type

String

function

工具类型，枚举值包括：

• function：待执行的方法，通常是端插件。触发端插件时会返回此枚举值。
• reply_message：待回复的选项。触发工作流问答节点时会返回此枚举值。

function

Object of InterruptFunction

{“name”:“get_weather”,“arguments”:“{"city":"Beijing"}”}

当对话状态为 requires_action时，此字段表示需要调用的工具或函数的定义，包含函数名称和参数。通常用于指定工具的具体执行方法。

name

String

get_weather

当对话状态为 requires_action 时，此字段表示需要调用的工具或函数的名称，用于继续对话。通常与 arguments字段配合使用，指定工具的具体执行方法。

arguments

String

{“city”:“Beijing”}

当对话状态为 requires_action时，此字段表示需要调用的工具或函数的参数，通常为 JSON 格式的字符串，用于指定工具的具体执行参数。

input_count

Integer

50

输入内容所消耗的 Token 数，包含对话上下文、系统提示词、用户当前输入等所有输入类的 Token 消耗。

token_count

Integer

150

本次 API 调用消耗的 Token 总量，包括输入和输出两部分的消耗。

output_count

Integer

100

大模型输出的内容所消耗的 Token 数。

logid

String

20241210152726467C48D89D6DB2****

本次请求的日志 ID。如果遇到异常报错场景，且反复重试仍然报错，可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考获取帮助和技术支持。

event

String

conversation.chat.created

流式响应事件，事件说明如下：

• conversation.chat.created：创建对话的事件，表示对话开始。
• conversation.chat.in_progress：服务端正在处理对话。
• conversation.message.delta：增量消息，通常是 type=answer 时的增量消息。
• conversation.message.completed：message 已回复完成，此时流式包中带有所有 message.delta 的拼接结果，且每个消息均为 completed 状态。
• conversation.chat.completed：对话完成。
• conversation.chat.failed：此事件用于标识对话失败。
• conversation.chat.requires_action：对话中断，需要使用方上报工具的执行结果。
• error：流式响应过程中的错误事件，关于 code 和 msg 的详细说明，可参考错误码。
• done：本次会话的流式返回正常结束。

data

Object of ChatV3MessageDetail

消息内容。其中，chat 事件和 message 事件的格式不同。

• chat 事件中，data 为 Chat Object。
• message 事件中，data 为 Message Object。

id

String

738216762080970****

智能体回复的消息的 Message ID，即消息的唯一标识。

conversation_id

String

738147352534297****

此消息所在的会话 ID。

role

String

assistant

发送这条消息的实体。取值：

• user：代表该条消息内容是用户发送的。
• assistant：代表该条消息内容是智能体发送的。

type

String

verbose

消息类型。

• question：用户输入内容。
• answer：智能体返回给用户的消息内容，支持增量返回。如果工作流绑定了 messge 节点，可能会存在多 answer 场景，此时可以用流式返回的结束标志来判断所有 answer 完成。
• function_call：智能体对话过程中调用函数（function call）的中间结果。
• tool_output：调用工具 （function call）后返回的结果。
• tool_response：调用工具 （function call）后返回的结果。
• follow_up：如果在智能体上配置打开了用户问题建议开关，则会返回推荐问题相关的回复内容。
• verbose：多 answer 场景下，服务端会返回一个 verbose 包，对应的 content 为 JSON 格式，content.msg_type =generate_answer_finish 代表全部 answer 回复完成。

bot_id

String

737946218936519****

编写此消息的智能体 ID。此参数仅在对话产生的消息中返回。

chat_id

String

747946218936519****

Chat ID。此参数仅在对话产生的消息中返回。

section_id

String

767946218936519****

上下文片段 ID。每次调用清除上下文 API 都会生成一个新的 section_id。

content

String

{“msg_type”:“generate_answer_finish”,“data”:“”,“from_module”:null,“from_unit”:null}

消息的内容，支持纯文本、多模态（文本、图片、文件混合输入）、卡片等多种类型的内容。

meta_data

JSON Map

{ “uuid”: “newid1234” }

创建消息时的附加消息，查看消息列表时也会返回此附加消息。

created_at

Long

1718592898

消息的创建时间，格式为 10 位的 Unixtime 时间戳，单位为秒（s）。

updated_at

Long

1718592898

消息的更新时间，格式为 10 位的 Unixtime 时间戳，单位为秒（s）。

content_type

String

text

消息内容的类型，取值包括：

• text：文本。
• object_string：多模态内容，即文本和文件的组合、文本和图片的组合。
• card：卡片。此枚举值仅在接口响应中出现，不支持作为入参。

reasoning_content

String

好的，我现在需要给一个13岁的大学生提供学习建议。首先，我得考虑用户的情况……

模型的思维链（CoT），展示模型如何将复杂问题逐步分解为多个简单步骤并推导出最终答案。仅当模型支持深度思考、且智能体开启了深度思考时返回该字段，当前支持深度思考的模型请参考模型能力差异。