当你创建 Response 并将 stream 设置为 true 时,服务器会在生成 Response 的过程中,通过 Server-Sent Events(SSE)实时向客户端推送事件。本节介绍 Response 从创建到完成/失败的生命周期事件。
response.created#
当响应被创建时触发的事件。
response object | 响应对象
response.created.response
创建状态的响应。包含参数与非流式调用返回的参数一致。
created_at integer | 创建时间戳
response.created.response.created_at
该 Response 创建时的 Unix 时间戳(单位:秒)。
id string | 响应 ID
response.created.response.id
本次 Response 的唯一标识,可用于后续查询、续接或删除该响应。
model string | 模型 ID
response.created.response.model
生成本次响应所使用的模型标识,回显请求中的 model 字段。
object string | 对象类型
response.created.response.object
返回对象的类型标识,用于区分响应对象种类。
取值固定为 response。
output object[] | 输出内容
response.created.response.output
模型本次响应产出的 Item 列表,按生成顺序排列,可能包含消息、工具调用、推理等不同类型条目。
消息输出 object
模型生成的消息输出,包含文本内容。
content object[] | 输出内容
response.created.response.output.content
输出内容列表。
模型回答文本 object
模型生成的最终回答文本。
type string | 类型
response.created.response.output.content.type
内容类型判别字段,用于区分 union 变体。
取值固定为 output_text。
annotations object[] | 标注列表
response.created.response.output.content.annotations
文本附带的标注信息列表(如引用来源等)
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.created.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.created.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.created.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.created.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.created.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.created.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.created.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.created.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.created.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.created.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.created.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.created.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.created.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.created.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.created.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.created.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.created.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.created.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.created.response.output.content.text
模型生成的文本内容。
模型思维链文本 object
模型生成的思维链文本。
type string | 类型
response.created.response.output.content.type
内容类型标识,用于区分 union 变体。
取值固定为 reasoning_text。
annotations object[] | 标注列表
response.created.response.output.content.annotations
思维链附带的标注信息列表。
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.created.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.created.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.created.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.created.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.created.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.created.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.created.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.created.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.created.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.created.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.created.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.created.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.created.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.created.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.created.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.created.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.created.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.created.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.created.response.output.content.text
模型思维链文本内容。
id string | 条目 ID
response.created.response.output.id
输出条目唯一标识。
role string | 角色
response.created.response.output.role
消息发送者的角色。
取值固定为 assistant。
status string | 状态
response.created.response.output.status
消息输出条目的当前状态。
completed:消息已生成完毕。in_progress:消息正在生成中(流式场景)。incomplete:消息未完整生成(例如达到max_output_tokens上限)。failed:消息生成失败。
type string | 类型
response.created.response.output.type
输出条目的类型标识。
取值固定为 message。
partial boolean | 增量片段
response.created.response.output.partial
是否为流式增量片段。
phase string | 消息阶段
response.created.response.output.phase
标记 assistant 消息属于中间讲解还是最终回答。在回放 assistant 历史消息时,建议保留并原样回传该字段。可选值:commentary、final_answer。
函数调用输出 object
模型发起的函数调用请求。
type string | 类型
response.created.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 function_call。
arguments string | 参数
response.created.response.output.arguments
函数参数的 JSON 字符串。
call_id string | 调用 ID
response.created.response.output.call_id
函数调用的唯一标识 ID,用于将该 function_call 输出与后续回传的 function_call_output 关联匹配。
id string | 条目 ID
response.created.response.output.id
输出条目唯一标识。
name string | 函数名
response.created.response.output.name
调用的函数名称。
status string | 状态
response.created.response.output.status
函数调用条目的当前状态。
completed:函数调用请求已生成完毕。in_progress:函数调用请求正在生成中(流式场景)。incomplete:函数调用请求未完整生成(例如达到max_output_tokens上限)。failed:函数调用生成失败。
思维链输出 object
模型的深度思考过程输出。
status string | 状态
response.created.response.output.status
推理条目的处理状态,用于判断思维链是否生成完成。可选值:completed、failed、in_progress、incomplete。
summary object[] | 推理摘要
response.created.response.output.summary
推理摘要内容列表。
type string | 类型
response.created.response.output.summary.type
摘要片段类型标识。
取值固定为 summary_text。
text string | 摘要文本
response.created.response.output.summary.text
思维链摘要文本内容。
type string | 类型
response.created.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 reasoning。
content object[] | 推理内容
response.created.response.output.content
思维链推理过程的内容元素列表。
模型回答文本 object
模型生成的最终回答文本。
type string | 类型
response.created.response.output.content.type
内容类型判别字段,用于区分 union 变体。
取值固定为 output_text。
annotations object[] | 标注列表
response.created.response.output.content.annotations
文本附带的标注信息列表(如引用来源等)
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.created.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.created.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.created.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.created.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.created.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.created.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.created.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.created.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.created.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.created.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.created.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.created.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.created.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.created.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.created.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.created.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.created.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.created.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.created.response.output.content.text
模型生成的文本内容。
模型思维链文本 object
模型生成的思维链文本。
type string | 类型
response.created.response.output.content.type
内容类型标识,用于区分 union 变体。
取值固定为 reasoning_text。
annotations object[] | 标注列表
response.created.response.output.content.annotations
思维链附带的标注信息列表。
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.created.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.created.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.created.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.created.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.created.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.created.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.created.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.created.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.created.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.created.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.created.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.created.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.created.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.created.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.created.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.created.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.created.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.created.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.created.response.output.content.text
模型思维链文本内容。
encrypted_content string | 加密思维链
response.created.response.output.encrypted_content
思考内容加密原文。经加密及压缩处理后的思考内容原文。
相关文档:
模型支持:
doubao-seed-2-0-lite-260428 及后续版本
id string | 条目 ID
response.created.response.output.id
输出条目唯一标识。
语音转写输出 object
模型返回的语音转写输出。
status string | 状态
response.created.response.output.status
语音转写条目的当前状态。
completed:转写已生成完毕。in_progress:转写正在生成中(流式场景)。incomplete:转写未完整生成(例如达到输出上限而截断)。failed:转写生成失败。
type string | 类型
response.created.response.output.type
输出条目类型标识。
取值固定为 transcription。
id string | 条目 ID
response.created.response.output.id
输出条目唯一标识。
transcription object[] | 转写内容
response.created.response.output.transcription
语音转写结果片段列表。
type string | 类型
response.created.response.output.transcription.type
转写片段类型。
取值固定为 transcription_text。
chunks object[] | 音频小段
response.created.response.output.transcription.chunks
当前片段对应的音频小段列表。
end_time integer | 结束时间
response.created.response.output.transcription.chunks.end_time
片段结束时间(毫秒)
start_time integer | 开始时间
response.created.response.output.transcription.chunks.start_time
片段开始时间(毫秒)
text string | 文字内容
response.created.response.output.transcription.chunks.text
当前片段对应的文字内容。
text string | 转写文本
response.created.response.output.transcription.text
当前片段的转写文本。
网页搜索调用 object
模型发起的网页搜索调用记录。
id string | 条目 ID
response.created.response.output.id
输出条目唯一标识。
status string | 状态
response.created.response.output.status
网页搜索调用的当前状态。可选值:in_progress、searching、completed、incomplete、failed。
type string | 类型
response.created.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 web_search_call。
action object | 搜索动作
response.created.response.output.action
描述模型执行的网页搜索动作,包括搜索类型与查询关键字。
query string | 查询语句
response.created.response.output.action.query
模型实际发起的搜索查询语句。
type string | 类型
response.created.response.output.action.type
网页搜索动作的类型标识。
取值固定为 search。
queries string[] | 查询语句列表
response.created.response.output.action.queries
本次网页搜索产生的查询语句列表。
图像处理调用 object
模型发起的图像处理调用记录。
id string | 条目 ID
response.created.response.output.id
输出条目唯一标识。
status string | 状态
response.created.response.output.status
图像处理调用的当前状态。
completed:图像处理已完成。in_progress:图像处理正在执行中。incomplete:图像处理未完整执行(例如被中断或截断)。failed:图像处理执行失败,具体原因见error字段。
type string | 类型
response.created.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 image_process。
action object | 处理动作
response.created.response.output.action
图像处理动作详情。
type string | 类型
response.created.response.output.action.type
图像处理动作类型。
result_image_url string | 结果图地址
response.created.response.output.action.result_image_url
处理后图像的 URL 地址。
arguments object | 处理参数
response.created.response.output.arguments
图像处理动作的输入参数,以键值对形式承载具体处理选项。
error object | 图像处理错误
response.created.response.output.error
图像处理失败时的错误信息。
message string | 错误描述
response.created.response.output.error.message
错误的可读描述。
MCP 审批请求 object
MCP 工具调用前的审批请求记录。
arguments string | 调用参数
response.created.response.output.arguments
工具调用参数的 JSON 字符串。
name string | 工具名
response.created.response.output.name
待运行的工具名称。
server_label string | 服务标签
response.created.response.output.server_label
发起请求的 MCP Server 标签。
type string | 类型
response.created.response.output.type
输出项类型标识符,用于区分 OutputItem 的变体。
取值固定为 mcp_approval_request。
id string | 请求 ID
response.created.response.output.id
审批请求的唯一 ID。
MCP 工具清单 object
MCP Server 提供的工具清单输出。
server_label string | 服务标签
response.created.response.output.server_label
MCP Server 标签。
type string | 类型
response.created.response.output.type
输出项类型标识。
取值固定为 mcp_list_tools。
error string | 错误信息
response.created.response.output.error
当 MCP Server 无法返回工具列表时的错误信息。
id string | 列表 ID
response.created.response.output.id
工具列表的唯一 ID。
tools object[] | 工具列表
response.created.response.output.tools
该 MCP Server 上可用的工具列表。
name string | 工具名
response.created.response.output.tools.name
工具名称。
annotations object | 注解信息
response.created.response.output.tools.annotations
工具的附加注解信息。
description string | 工具描述
response.created.response.output.tools.description
工具的功能描述。
input_schema object | 入参 Schema
response.created.response.output.tools.input_schema
描述工具入参的 JSON Schema。
MCP 工具调用 object
模型对 MCP 工具的实际调用记录及结果。
name string | 工具名
response.created.response.output.name
实际运行的工具名称。
server_label string | 服务标签
response.created.response.output.server_label
运行工具的 MCP Server 标签。
type string | 类型
response.created.response.output.type
标识该输出项为 MCP 工具调用记录。
取值固定为 mcp_call。
arguments string | 调用参数
response.created.response.output.arguments
传递给 MCP 工具的调用参数,格式为 JSON 字符串。
error string | 错误信息
response.created.response.output.error
工具调用失败时的错误信息。
id string | 调用 ID
response.created.response.output.id
工具调用的唯一 ID。
output string | 返回结果
response.created.response.output.output
工具调用的返回结果。
知识库检索调用 object
模型发起的私域知识库检索调用记录。
knowledge_resource_id string | 知识库 ID
response.created.response.output.knowledge_resource_id
检索使用的知识库 ID。
queries string[] | 查询语句
response.created.response.output.queries
模型实际执行的检索查询语句。
status string | 状态
response.created.response.output.status
知识库检索调用的执行状态。可选值:in_progress、searching、completed、failed、incomplete。
type string | 类型
response.created.response.output.type
输出条目类型标识,用于区分不同类型的输出条目。
取值固定为 knowledge_search_call。
id string | 条目 ID
response.created.response.output.id
输出条目唯一标识。
豆包应用调用 object
模型对豆包助手能力的调用记录。
type string | 类型
response.created.response.output.type
输出条目类型标识。
取值固定为 doubao_app_call。
blocks object[] | 内容块
response.created.response.output.blocks
豆包应用调用产出的内容块列表。
文本输出 object
豆包应用产出的文本输出内容块。
type string | 类型
response.created.response.output.blocks.type
内容块类型标识符。
取值固定为 output_text。
id string | 块 ID
response.created.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.created.response.output.blocks.parent_id
所属父级条目的 ID。
status string | 状态
response.created.response.output.blocks.status
内容块状态。
text string | 文本内容
response.created.response.output.blocks.text
思维链文本 object
豆包应用产出的思维链文本内容块。
type string | 类型
response.created.response.output.blocks.type
内容块类型标识符。
取值固定为 reasoning_text。
id string | 块 ID
response.created.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.created.response.output.blocks.parent_id
所属父级条目的 ID。
reasoning_text string | 思考文本
response.created.response.output.blocks.reasoning_text
思维链文本内容。
status string | 状态
response.created.response.output.blocks.status
内容块状态。
搜索过程 object
豆包应用 AI 搜索过程产出的内容块。
type string | 类型
response.created.response.output.blocks.type
内容块类型标识符。
取值固定为 search。
id string | 块 ID
response.created.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.created.response.output.blocks.parent_id
所属父级条目的 ID。
queries string[] | 查询语句
response.created.response.output.blocks.queries
搜索查询语句列表。
results object[] | 搜索结果
response.created.response.output.blocks.results
搜索结果列表。
text_card object | 文本卡片
response.created.response.output.blocks.results.text_card
文本卡片形式的搜索结果。
sitename string | 站点名
response.created.response.output.blocks.results.text_card.sitename
来源站点名称。
title string | 标题
response.created.response.output.blocks.results.text_card.title
搜索结果标题。
url string | 网址
response.created.response.output.blocks.results.text_card.url
搜索结果 URL 地址。
status string | 状态
response.created.response.output.blocks.status
内容块状态。
summary string | 搜索总结
response.created.response.output.blocks.summary
AI 搜索过程中对本轮搜索结果的总结性文字,概括从搜索结果中提取的核心信息。
推理搜索过程 object
豆包应用推理搜索过程产出的内容块。
type string | 类型
response.created.response.output.blocks.type
内容块类型。
取值固定为 reasoning_search。
id string | 块 ID
response.created.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.created.response.output.blocks.parent_id
所属父级条目的 ID。
queries string[] | 查询语句
response.created.response.output.blocks.queries
搜索查询语句列表。
results object[] | 搜索结果
response.created.response.output.blocks.results
搜索结果列表。
text_card object | 文本卡片
response.created.response.output.blocks.results.text_card
文本卡片形式的搜索结果。
sitename string | 站点名
response.created.response.output.blocks.results.text_card.sitename
来源站点名称。
title string | 标题
response.created.response.output.blocks.results.text_card.title
搜索结果标题。
url string | 网址
response.created.response.output.blocks.results.text_card.url
搜索结果 URL 地址。
status string | 状态
response.created.response.output.blocks.status
推理搜索内容块的处理状态。可选值:in_progress、searching、completed、incomplete、failed。
summary string | 搜索总结
response.created.response.output.blocks.summary
推理搜索过程中对本轮搜索结果的总结性文字,概括从搜索结果中提取的核心信息。
feature string | 功能名
response.created.response.output.feature
本次调用触发的豆包子功能名称。可选值:chat、deep_chat、ai_search、reasoning_search。
id string | 条目 ID
response.created.response.output.id
输出条目唯一标识。
status string | 状态
response.created.response.output.status
输出状态。可选值:completed、failed、in_progress、incomplete。
智能体工具调用 object
模型发起的智能体工具调用记录。
name string | 工具名
response.created.response.output.name
被调用的智能体工具名称。
status string | 状态
response.created.response.output.status
智能体工具调用的执行状态。可选值:completed、failed、in_progress、incomplete。
type string | 类型
response.created.response.output.type
输出条目类型标识符,用于区分 OutputItem 的 variant。
取值固定为 agent_tool_call。
id string | 条目 ID
response.created.response.output.id
输出条目唯一标识。
caching object | 缓存配置
response.created.response.caching
本次响应生效的上下文缓存配置,回显请求中的 caching 设置。
prefix boolean | 仅写缓存
response.created.response.caching.prefix
是否仅写入前缀缓存,不生成回复。true 只写缓存,不返回模型输出;false 正常生成回复并写缓存。
type string | 缓存模式
response.created.response.caching.type
缓存模式。
enabled:开启上下文缓存。disabled:关闭上下文缓存。
context_management object | 上下文管理
response.created.response.context_management
本次响应实际执行的上下文管理编辑操作,回显请求中 context_management 生效后的结果。
applied_edits object[] | 已应用编辑
response.created.response.context_management.applied_edits
已应用的上下文编辑结果列表。
清理工具调用 object
已应用的清理工具调用编辑结果。
cleared_tool_uses integer | 清理次数
response.created.response.context_management.applied_edits.cleared_tool_uses
已清理的工具调用数量。
type string | 类型
response.created.response.context_management.applied_edits.type
编辑类型。
取值固定为 clear_tool_uses。
清理思维链 object
已应用的清理思维链编辑结果。
cleared_thinking_turns integer | 清理轮次
response.created.response.context_management.applied_edits.cleared_thinking_turns
已清理的思维链轮次数量。
type string | 类型
response.created.response.context_management.applied_edits.type
编辑类型。
取值固定为 clear_thinking。
error object | 错误信息
response.created.response.error
模型响应过程发生错误时的错误信息。仅当 status 为 failed 时返回。
code string | 错误码
response.created.response.error.code
message string | 错误描述
response.created.response.error.message
错误信息的可读描述。
expire_at integer | 过期时间戳
response.created.response.expire_at
响应储存的过期时刻 Unix 时间戳(秒),回显请求中的 expire_at 设置,对 store 与 caching 均生效。
incomplete_details object | 未完成详情
response.created.response.incomplete_details
响应未能完成的详细信息。仅当 status 为 incomplete 时返回。
reason string | 原因
response.created.response.incomplete_details.reason
响应未完成的原因。
content_filter object | 内容过滤
response.created.response.incomplete_details.content_filter
内容过滤详情。
details string | 详情
response.created.response.incomplete_details.content_filter.details
内容过滤命中的详细描述。
type string | 类型
response.created.response.incomplete_details.content_filter.type
内容过滤命中的类型。
instructions string | 系统指令
response.created.response.instructions
本次响应生效的系统指令,回显请求中的 instructions 设置。
max_output_tokens integer | 最大输出长度
response.created.response.max_output_tokens
回显请求中的 max_output_tokens 参数,即模型输出最大 token 数(含回答与思维链)。
max_tool_calls integer | 最大工具调用轮次
response.created.response.max_tool_calls
本次响应生效的最大工具调用轮次,回显请求中的 max_tool_calls 设置。
metadata object | 自定义元数据
response.created.response.metadata
回显请求中的 metadata 键值对元数据。最多支持 16 对键值,key 长度不超过 64 个字符,value 长度不超过 512 个字符,服务端不会解释其中内容。
parallel_tool_calls boolean | 并行工具调用
response.created.response.parallel_tool_calls
本次请求实际生效的并行工具调用设置,回显请求中的 parallel_tool_calls 值。
previous_response_id string | 上轮响应 ID
response.created.response.previous_response_id
回显请求中的 previous_response_id,即前一轮响应的唯一标识。仅在请求传入该字段时返回。
prompt_cache_key string | 缓存分桶键
response.created.response.prompt_cache_key
用于提升缓存命中率的分桶键,回显请求中的 prompt_cache_key 设置。
reasoning object | 推理配置
response.created.response.reasoning
本次响应生效的深度思考工作量配置,回显请求中的 reasoning 设置。
effort string | 思考深度
response.created.response.reasoning.effort
限制思考的工作量。减少思考深度可提升速度,思考花费的 token 更少。
none:关闭思考。minimal:关闭思考,直接回答。low:轻量思考,侧重快速响应。medium:均衡模式,兼顾速度与深度。high:深度分析,处理复杂问题。xhigh:更高程度思考。max:最高程度思考,适配高难度推理任务。
safety_identifier string | 安全标识
response.created.response.safety_identifier
回显请求中传入的终端用户稳定标识,用于安全策略与违规行为追踪关联。
service_tier string | 推理模式
response.created.response.service_tier
本次请求实际使用的推理模式。
fast:本次请求使用 在线推理(低延迟) 模式。auto:本次请求使用 在线推理(TPM 保障包) 模式。default:本次请求使用 在线推理(常规) 模式。flex:本次请求使用 在线推理(低优) 模式。
session object | 会话信息
response.created.response.session
本次响应关联的会话信息,回显请求中 session 生效后的结果。
id string | 会话 ID
response.created.response.session.id
会话的唯一 ID。
status string | 响应状态
response.created.response.status
本次响应的当前状态,标识生成流程处于进行中、已完成、未完成或已失败等阶段。
store boolean | 是否存储
response.created.response.store
是否储存生成的模型响应以供后续通过 API 检索,回显请求中的 store 设置。
temperature number | 采样温度
response.created.response.temperature
本次响应生效的采样温度,回显请求中的 temperature 设置。
text object | 输出格式
response.created.response.text
本次响应生效的输出格式定义,回显请求中的 text 设置。
format object | 输出格式
response.created.response.text.format
文本输出格式定义。
type string | 格式类型
response.created.response.text.format.type
输出格式类型。可选值:text、json_schema、json_object。
description string | 格式描述
response.created.response.text.format.description
格式描述信息。
name string | 格式名称
response.created.response.text.format.name
格式名称,作为 JSON Schema 输出格式的标识。
schema object | Schema 定义
response.created.response.text.format.schema
JSON Schema 定义。当 type 为 json_schema 时必填。
strict boolean | 严格模式
response.created.response.text.format.strict
是否严格按 JSON Schema 校验模型输出。
thinking object | 深度思考
response.created.response.thinking
本次响应生效的深度思考配置,回显请求中的 thinking 设置。
type string | 思考模式
response.created.response.thinking.type
深度思考模式。
enabled:开启深度思考。disabled:关闭深度思考。auto:由模型自行判断是否需要深度思考。
tool_choice string / object | 工具调用策略
response.created.response.tool_choice
本次请求实际生效的工具调用策略,回显请求中的 tool_choice 设置。
简单策略 string
直接传入字符串 none、auto 或 required,控制工具调用整体策略。
指定工具 object
通过对象指定具体工具类型或工具名进行调用。
type string | 工具类型
response.created.response.tool_choice.type
指定要调用的工具类型,用于精确路由到对应工具。可选值:
functionweb_searchimage_processmcpknowledge_searchdoubao_app
name string | 工具名称
response.created.response.tool_choice.name
指定要调用的具体工具名,如函数名或 MCP 服务下的工具名。
tools object[] | 工具列表
response.created.response.tools
本次响应生效的工具列表,回显请求中的 tools 设置。
函数调用 object
自定义函数调用(Function Calling),让模型生成结构化的函数参数。
name string | 函数名
response.created.response.tools.name
供模型调用的函数名称,模型在 function_call 输出中以该名称回传,用于匹配对应函数。
type string | 类型
response.created.response.tools.type
工具类型标识,用于在 union 中区分不同工具类别。
取值固定为 function。
description string | 函数描述
response.created.response.tools.description
函数的描述信息,帮助模型理解何时使用该函数。
parameters object | 参数定义
response.created.response.tools.parameters
函数参数定义,遵循 JSON Schema 格式。
联网搜索 object
联网搜索工具,让模型在需要时自动进行网页搜索获取实时信息。
type string | 类型
response.created.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 web_search。
limit integer | 最大结果数
response.created.response.tools.limit
每轮搜索最大返回结果数量。
取值范围:[1, 50]
max_keyword integer | 最大关键词数
response.created.response.tools.max_keyword
最大并行搜索关键词数量。
取值范围:[1, 50]
sources string[] | 搜索来源
response.created.response.tools.sources
搜索信息来源限制,指定模型可从哪些渠道检索网页内容。可选值:toutiao、douyin、moji、search_engine、doubao。
user_location object | 用户位置
response.created.response.tools.user_location
用户地理位置信息,用于搜索优化。
type string | 类型
response.created.response.tools.user_location.type
位置类型。
取值固定为 approximate。
city string | 城市
response.created.response.tools.user_location.city
用户所在城市。
country string | 国家
response.created.response.tools.user_location.country
用户所在国家。
region string | 地区
response.created.response.tools.user_location.region
用户所在地区。
timezone number | 时区
response.created.response.tools.user_location.timezone
用户所在时区。
图像处理 object
图像处理工具,让模型对图片进行画点、选区、缩放、旋转等操作。
type string | 类型
response.created.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 image_process。
grounding object | 选区功能
response.created.response.tools.grounding
选区/裁切功能配置,启用后模型可返回图像中目标的检测框或裁切区域坐标。
type string | 开关
response.created.response.tools.grounding.type
功能开关。可选值:enabled、disabled。
point object | 画点功能
response.created.response.tools.point
画点/画线功能开关。
type string | 开关
response.created.response.tools.point.type
功能开关。可选值:enabled、disabled。
rotate object | 旋转功能
response.created.response.tools.rotate
旋转功能开关。启用后模型可请求对图片按指定角度进行旋转。
type string | 开关
response.created.response.tools.rotate.type
功能开关。可选值:enabled、disabled。
zoom object | 缩放功能
response.created.response.tools.zoom
缩放功能开关,启用后模型可对图像目标区域执行缩放操作。
type string | 开关
response.created.response.tools.zoom.type
功能开关。可选值:enabled、disabled。
MCP 工具 object
MCP(Model Context Protocol)工具,让模型调用外部 MCP Server 提供的工具。
server_label string | 服务标签
response.created.response.tools.server_label
MCP Server 的唯一标识标签。模型在工具调用输出中通过该标签指向对应 Server,便于在多个 MCP Server 场景下区分调用来源。
server_url string | 服务地址
response.created.response.tools.server_url
MCP Server 的 HTTP(S) 访问地址,模型通过该地址向 Server 发起工具调用请求。
type string | 类型
response.created.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 mcp。
allowed_tools string[] / object | 允许工具
response.created.response.tools.allowed_tools
允许模型调用的工具范围。可传工具名称字符串数组,或包含 tool_names 字段的过滤器对象。
工具名数组 string[]
直接传入允许调用的工具名称数组。
工具过滤器 object
通过过滤器对象指定允许调用的工具范围。
tool_names string[] | 工具名列表
response.created.response.tools.allowed_tools.tool_names
允许调用的工具名称列表。
headers object | 请求头
response.created.response.tools.headers
调用 MCP Server 时附加的 HTTP 请求头,以字符串键值对形式指定 header 名与值。
require_approval string / object | 审批策略
response.created.response.tools.require_approval
MCP 工具调用前的审批策略;支持简单模式(字符串)或按工具粒度控制(过滤器对象)。
简单策略 string
直接传入字符串 always 或 never,对所有工具应用统一审批策略。
工具过滤器 object
通过过滤器对象按工具粒度配置审批策略。
always object | 始终审批
response.created.response.tools.require_approval.always
始终需要审批的工具过滤器。
tool_names string[] | 工具名列表
response.created.response.tools.require_approval.always.tool_names
始终需要审批的工具名称列表。
never object | 无需审批
response.created.response.tools.require_approval.never
无需审批的工具过滤器。
tool_names string[] | 工具名列表
response.created.response.tools.require_approval.never.tool_names
无需审批即可调用的工具名称列表。
server_description string | 服务描述
response.created.response.tools.server_description
MCP Server 的描述信息,帮助模型理解何时使用该 Server。
知识库搜索 object
私域知识库搜索工具,让模型检索企业内部知识库中的文档内容。
knowledge_resource_id string | 知识库 ID
response.created.response.tools.knowledge_resource_id
type string | 类型
response.created.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 knowledge_search。
dense_weight number | 稠密权重
response.created.response.tools.dense_weight
混合检索中稠密向量(语义)检索的权重,值越大越偏向语义匹配,越小越偏向关键词匹配。
取值范围:[0.2, 1]
description string | 知识库描述
response.created.response.tools.description
知识库描述信息,帮助模型理解何时使用该知识库。
doc_filter object | 文档过滤
response.created.response.tools.doc_filter
设置文档字段级别的检索过滤条件,确保只在符合条件的文档中检索。
limit integer | 最大结果数
response.created.response.tools.limit
最大搜索结果数量。
取值范围:[1, 200]
max_keyword integer | 最大关键词数
response.created.response.tools.max_keyword
最大并行搜索关键词数量。
取值范围:[1, 50]
ranking_options object | 排序选项
response.created.response.tools.ranking_options
检索后处理选项。可参考 知识库 API 文档 post_processing 字段。
chunk_diffusion_count integer | 切片扩散数
response.created.response.tools.ranking_options.chunk_diffusion_count
检索阶段返回命中切片的上下几片邻近切片。取 0 表示不进行 chunk diffusion。
取值范围:[0, 5]
chunk_group boolean | 文本聚合
response.created.response.tools.ranking_options.chunk_group
文本聚合。
- 默认不聚合。
- 对于非结构化文件,可开启文本聚合以更好保留原文档内容语序。
- 开启后,会根据文档及文档顺序,对切片重新聚合排序返回。
get_attachment_link boolean | 获取附件链接
response.created.response.tools.ranking_options.get_attachment_link
是否获取切片中图片的临时下载链接。
rerank_model string | Rerank 模型
response.created.response.tools.ranking_options.rerank_model
rerank 模型选择。默认值:base-multilingual-rerank。取值:base-multilingual-rerank / m3-v2-rerank。
rerank_only_chunk boolean | 仅切片重排
response.created.response.tools.ranking_options.rerank_only_chunk
是否仅根据 chunk 内容计算重排分数。true 只根据 chunk 内容计算分;false 根据 chunk title + 内容一起计算排序分。
rerank_switch boolean | 开启重排
response.created.response.tools.ranking_options.rerank_switch
是否自动对检索结果做 rerank。若设置为 true,则会自动请求 rerank 模型排序。
retrieve_count integer | 重排切片数
response.created.response.tools.ranking_options.retrieve_count
进入重排的切片数量。
豆包助手 object
豆包助手工具,让模型使用豆包的聊天、深度思考、AI 搜索和推理搜索能力。
feature object | 功能配置
response.created.response.tools.feature
豆包助手的子功能配置,用于按需开启聊天、深度思考、AI 搜索、推理搜索四类能力并设置对应角色描述。
ai_search object | AI 搜索
response.created.response.tools.feature.ai_search
AI 搜索功能配置。
role_description string | 角色描述
response.created.response.tools.feature.ai_search.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.created.response.tools.feature.ai_search.type
功能开关。可选值:enabled、disabled。
chat object | 普通聊天
response.created.response.tools.feature.chat
普通聊天功能配置。
role_description string | 角色描述
response.created.response.tools.feature.chat.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.created.response.tools.feature.chat.type
功能开关。可选值:enabled、disabled。
deep_chat object | 深度聊天
response.created.response.tools.feature.deep_chat
深度聊天功能配置。
role_description string | 角色描述
response.created.response.tools.feature.deep_chat.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.created.response.tools.feature.deep_chat.type
功能开关。可选值:enabled、disabled。
reasoning_search object | 推理搜索
response.created.response.tools.feature.reasoning_search
推理搜索功能配置。
role_description string | 角色描述
response.created.response.tools.feature.reasoning_search.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.created.response.tools.feature.reasoning_search.type
功能开关。可选值:enabled、disabled。
type string | 类型
response.created.response.tools.type
工具类型,此处固定为 doubao_app
user_location object | 用户位置
response.created.response.tools.user_location
用户地理位置信息,用于搜索优化。
type string | 类型
response.created.response.tools.user_location.type
位置类型。
取值固定为 approximate。
city string | 城市
response.created.response.tools.user_location.city
用户所在城市。
country string | 国家
response.created.response.tools.user_location.country
用户所在国家。
region string | 地区
response.created.response.tools.user_location.region
用户所在地区。
timezone number | 时区
response.created.response.tools.user_location.timezone
用户所在时区。
top_p number | 采样阈值
response.created.response.top_p
本次请求实际使用的核采样概率阈值。
usage object | 用量统计
response.created.response.usage
本次响应的 token 用量统计,包含输入、输出与总计 token 数等明细。
input_tokens integer | 输入 token 数
response.created.response.usage.input_tokens
输入消耗的 token 数量。
input_tokens_details object | 输入明细
response.created.response.usage.input_tokens_details
输入 token 用量明细。
cached_tokens integer | 缓存 token
response.created.response.usage.input_tokens_details.cached_tokens
命中缓存的 token 数量。
audio_cached_tokens integer | 音频缓存 Token 数
response.created.response.usage.input_tokens_details.audio_cached_tokens
缓存命中的音频输入内容所消耗的 token 数量。仅在隐式缓存模式且命中音频缓存时返回;开启显式缓存时该字段不返回。
audio_tokens integer | 音频 token
response.created.response.usage.input_tokens_details.audio_tokens
音频输入消耗的 token 数量。
output_tokens integer | 输出 token 数
response.created.response.usage.output_tokens
输出消耗的 token 数量。
output_tokens_details object | 输出明细
response.created.response.usage.output_tokens_details
输出 token 用量明细。
reasoning_tokens integer | 思考 token
response.created.response.usage.output_tokens_details.reasoning_tokens
深度思考消耗的 token 数量。
total_tokens integer | 总 token 数
response.created.response.usage.total_tokens
本次请求消耗的 token 总数。
tool_usage object | 工具用量
response.created.response.usage.tool_usage
工具调用用量统计。
doubao_app integer | 豆包次数
response.created.response.usage.tool_usage.doubao_app
豆包助手工具调用次数。
knowledge_search integer | 知识库次数
response.created.response.usage.tool_usage.knowledge_search
知识库搜索工具调用次数。
mcp integer | MCP 次数
response.created.response.usage.tool_usage.mcp
MCP 工具调用次数。
web_search integer | 搜索次数
response.created.response.usage.tool_usage.web_search
联网搜索工具调用次数。
tool_usage_details object | 工具明细
response.created.response.usage.tool_usage_details
工具调用用量明细。
doubao_app object | 豆包明细
response.created.response.usage.tool_usage_details.doubao_app
豆包助手工具用量明细。
knowledge_search object | 知识库明细
response.created.response.usage.tool_usage_details.knowledge_search
知识库搜索工具用量明细。
mcp object | MCP 明细
response.created.response.usage.tool_usage_details.mcp
MCP 工具用量明细。
web_search object | 搜索明细
response.created.response.usage.tool_usage_details.web_search
联网搜索工具用量明细。
sequence_number integer | 序列号
response.created.sequence_number
事件的序列号。
type string | 事件类型
response.created.type
事件的类型,总是 response.created
response.in_progress#
当响应在进程中触发的事件。
response object | 响应对象
response.in_progress.response
进行中状态的响应。包含参数与非流式调用返回的参数一致。
created_at integer | 创建时间戳
response.in_progress.response.created_at
该 Response 创建时的 Unix 时间戳(单位:秒)。
id string | 响应 ID
response.in_progress.response.id
本次 Response 的唯一标识,可用于后续查询、续接或删除该响应。
model string | 模型 ID
response.in_progress.response.model
生成本次响应所使用的模型标识,回显请求中的 model 字段。
object string | 对象类型
response.in_progress.response.object
返回对象的类型标识,用于区分响应对象种类。
取值固定为 response。
output object[] | 输出内容
response.in_progress.response.output
模型本次响应产出的 Item 列表,按生成顺序排列,可能包含消息、工具调用、推理等不同类型条目。
消息输出 object
模型生成的消息输出,包含文本内容。
content object[] | 输出内容
response.in_progress.response.output.content
输出内容列表。
模型回答文本 object
模型生成的最终回答文本。
type string | 类型
response.in_progress.response.output.content.type
内容类型判别字段,用于区分 union 变体。
取值固定为 output_text。
annotations object[] | 标注列表
response.in_progress.response.output.content.annotations
文本附带的标注信息列表(如引用来源等)
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.in_progress.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.in_progress.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.in_progress.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.in_progress.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.in_progress.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.in_progress.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.in_progress.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.in_progress.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.in_progress.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.in_progress.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.in_progress.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.in_progress.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.in_progress.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.in_progress.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.in_progress.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.in_progress.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.in_progress.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.in_progress.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.in_progress.response.output.content.text
模型生成的文本内容。
模型思维链文本 object
模型生成的思维链文本。
type string | 类型
response.in_progress.response.output.content.type
内容类型标识,用于区分 union 变体。
取值固定为 reasoning_text。
annotations object[] | 标注列表
response.in_progress.response.output.content.annotations
思维链附带的标注信息列表。
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.in_progress.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.in_progress.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.in_progress.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.in_progress.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.in_progress.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.in_progress.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.in_progress.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.in_progress.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.in_progress.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.in_progress.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.in_progress.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.in_progress.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.in_progress.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.in_progress.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.in_progress.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.in_progress.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.in_progress.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.in_progress.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.in_progress.response.output.content.text
模型思维链文本内容。
id string | 条目 ID
response.in_progress.response.output.id
输出条目唯一标识。
role string | 角色
response.in_progress.response.output.role
消息发送者的角色。
取值固定为 assistant。
status string | 状态
response.in_progress.response.output.status
消息输出条目的当前状态。
completed:消息已生成完毕。in_progress:消息正在生成中(流式场景)。incomplete:消息未完整生成(例如达到max_output_tokens上限)。failed:消息生成失败。
type string | 类型
response.in_progress.response.output.type
输出条目的类型标识。
取值固定为 message。
partial boolean | 增量片段
response.in_progress.response.output.partial
是否为流式增量片段。
phase string | 消息阶段
response.in_progress.response.output.phase
标记 assistant 消息属于中间讲解还是最终回答。在回放 assistant 历史消息时,建议保留并原样回传该字段。可选值:commentary、final_answer。
函数调用输出 object
模型发起的函数调用请求。
type string | 类型
response.in_progress.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 function_call。
arguments string | 参数
response.in_progress.response.output.arguments
函数参数的 JSON 字符串。
call_id string | 调用 ID
response.in_progress.response.output.call_id
函数调用的唯一标识 ID,用于将该 function_call 输出与后续回传的 function_call_output 关联匹配。
id string | 条目 ID
response.in_progress.response.output.id
输出条目唯一标识。
name string | 函数名
response.in_progress.response.output.name
调用的函数名称。
status string | 状态
response.in_progress.response.output.status
函数调用条目的当前状态。
completed:函数调用请求已生成完毕。in_progress:函数调用请求正在生成中(流式场景)。incomplete:函数调用请求未完整生成(例如达到max_output_tokens上限)。failed:函数调用生成失败。
思维链输出 object
模型的深度思考过程输出。
status string | 状态
response.in_progress.response.output.status
推理条目的处理状态,用于判断思维链是否生成完成。可选值:completed、failed、in_progress、incomplete。
summary object[] | 推理摘要
response.in_progress.response.output.summary
推理摘要内容列表。
type string | 类型
response.in_progress.response.output.summary.type
摘要片段类型标识。
取值固定为 summary_text。
text string | 摘要文本
response.in_progress.response.output.summary.text
思维链摘要文本内容。
type string | 类型
response.in_progress.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 reasoning。
content object[] | 推理内容
response.in_progress.response.output.content
思维链推理过程的内容元素列表。
模型回答文本 object
模型生成的最终回答文本。
type string | 类型
response.in_progress.response.output.content.type
内容类型判别字段,用于区分 union 变体。
取值固定为 output_text。
annotations object[] | 标注列表
response.in_progress.response.output.content.annotations
文本附带的标注信息列表(如引用来源等)
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.in_progress.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.in_progress.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.in_progress.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.in_progress.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.in_progress.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.in_progress.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.in_progress.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.in_progress.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.in_progress.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.in_progress.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.in_progress.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.in_progress.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.in_progress.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.in_progress.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.in_progress.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.in_progress.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.in_progress.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.in_progress.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.in_progress.response.output.content.text
模型生成的文本内容。
模型思维链文本 object
模型生成的思维链文本。
type string | 类型
response.in_progress.response.output.content.type
内容类型标识,用于区分 union 变体。
取值固定为 reasoning_text。
annotations object[] | 标注列表
response.in_progress.response.output.content.annotations
思维链附带的标注信息列表。
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.in_progress.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.in_progress.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.in_progress.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.in_progress.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.in_progress.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.in_progress.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.in_progress.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.in_progress.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.in_progress.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.in_progress.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.in_progress.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.in_progress.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.in_progress.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.in_progress.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.in_progress.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.in_progress.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.in_progress.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.in_progress.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.in_progress.response.output.content.text
模型思维链文本内容。
encrypted_content string | 加密思维链
response.in_progress.response.output.encrypted_content
思考内容加密原文。经加密及压缩处理后的思考内容原文。
相关文档:
模型支持:
doubao-seed-2-0-lite-260428 及后续版本
id string | 条目 ID
response.in_progress.response.output.id
输出条目唯一标识。
语音转写输出 object
模型返回的语音转写输出。
status string | 状态
response.in_progress.response.output.status
语音转写条目的当前状态。
completed:转写已生成完毕。in_progress:转写正在生成中(流式场景)。incomplete:转写未完整生成(例如达到输出上限而截断)。failed:转写生成失败。
type string | 类型
response.in_progress.response.output.type
输出条目类型标识。
取值固定为 transcription。
id string | 条目 ID
response.in_progress.response.output.id
输出条目唯一标识。
transcription object[] | 转写内容
response.in_progress.response.output.transcription
语音转写结果片段列表。
type string | 类型
response.in_progress.response.output.transcription.type
转写片段类型。
取值固定为 transcription_text。
chunks object[] | 音频小段
response.in_progress.response.output.transcription.chunks
当前片段对应的音频小段列表。
end_time integer | 结束时间
response.in_progress.response.output.transcription.chunks.end_time
片段结束时间(毫秒)
start_time integer | 开始时间
response.in_progress.response.output.transcription.chunks.start_time
片段开始时间(毫秒)
text string | 文字内容
response.in_progress.response.output.transcription.chunks.text
当前片段对应的文字内容。
text string | 转写文本
response.in_progress.response.output.transcription.text
当前片段的转写文本。
网页搜索调用 object
模型发起的网页搜索调用记录。
id string | 条目 ID
response.in_progress.response.output.id
输出条目唯一标识。
status string | 状态
response.in_progress.response.output.status
网页搜索调用的当前状态。可选值:in_progress、searching、completed、incomplete、failed。
type string | 类型
response.in_progress.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 web_search_call。
action object | 搜索动作
response.in_progress.response.output.action
描述模型执行的网页搜索动作,包括搜索类型与查询关键字。
query string | 查询语句
response.in_progress.response.output.action.query
模型实际发起的搜索查询语句。
type string | 类型
response.in_progress.response.output.action.type
网页搜索动作的类型标识。
取值固定为 search。
queries string[] | 查询语句列表
response.in_progress.response.output.action.queries
本次网页搜索产生的查询语句列表。
图像处理调用 object
模型发起的图像处理调用记录。
id string | 条目 ID
response.in_progress.response.output.id
输出条目唯一标识。
status string | 状态
response.in_progress.response.output.status
图像处理调用的当前状态。
completed:图像处理已完成。in_progress:图像处理正在执行中。incomplete:图像处理未完整执行(例如被中断或截断)。failed:图像处理执行失败,具体原因见error字段。
type string | 类型
response.in_progress.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 image_process。
action object | 处理动作
response.in_progress.response.output.action
图像处理动作详情。
type string | 类型
response.in_progress.response.output.action.type
图像处理动作类型。
result_image_url string | 结果图地址
response.in_progress.response.output.action.result_image_url
处理后图像的 URL 地址。
arguments object | 处理参数
response.in_progress.response.output.arguments
图像处理动作的输入参数,以键值对形式承载具体处理选项。
error object | 图像处理错误
response.in_progress.response.output.error
图像处理失败时的错误信息。
message string | 错误描述
response.in_progress.response.output.error.message
错误的可读描述。
MCP 审批请求 object
MCP 工具调用前的审批请求记录。
arguments string | 调用参数
response.in_progress.response.output.arguments
工具调用参数的 JSON 字符串。
name string | 工具名
response.in_progress.response.output.name
待运行的工具名称。
server_label string | 服务标签
response.in_progress.response.output.server_label
发起请求的 MCP Server 标签。
type string | 类型
response.in_progress.response.output.type
输出项类型标识符,用于区分 OutputItem 的变体。
取值固定为 mcp_approval_request。
id string | 请求 ID
response.in_progress.response.output.id
审批请求的唯一 ID。
MCP 工具清单 object
MCP Server 提供的工具清单输出。
server_label string | 服务标签
response.in_progress.response.output.server_label
MCP Server 标签。
type string | 类型
response.in_progress.response.output.type
输出项类型标识。
取值固定为 mcp_list_tools。
error string | 错误信息
response.in_progress.response.output.error
当 MCP Server 无法返回工具列表时的错误信息。
id string | 列表 ID
response.in_progress.response.output.id
工具列表的唯一 ID。
tools object[] | 工具列表
response.in_progress.response.output.tools
该 MCP Server 上可用的工具列表。
name string | 工具名
response.in_progress.response.output.tools.name
工具名称。
annotations object | 注解信息
response.in_progress.response.output.tools.annotations
工具的附加注解信息。
description string | 工具描述
response.in_progress.response.output.tools.description
工具的功能描述。
input_schema object | 入参 Schema
response.in_progress.response.output.tools.input_schema
描述工具入参的 JSON Schema。
MCP 工具调用 object
模型对 MCP 工具的实际调用记录及结果。
name string | 工具名
response.in_progress.response.output.name
实际运行的工具名称。
server_label string | 服务标签
response.in_progress.response.output.server_label
运行工具的 MCP Server 标签。
type string | 类型
response.in_progress.response.output.type
标识该输出项为 MCP 工具调用记录。
取值固定为 mcp_call。
arguments string | 调用参数
response.in_progress.response.output.arguments
传递给 MCP 工具的调用参数,格式为 JSON 字符串。
error string | 错误信息
response.in_progress.response.output.error
工具调用失败时的错误信息。
id string | 调用 ID
response.in_progress.response.output.id
工具调用的唯一 ID。
output string | 返回结果
response.in_progress.response.output.output
工具调用的返回结果。
知识库检索调用 object
模型发起的私域知识库检索调用记录。
knowledge_resource_id string | 知识库 ID
response.in_progress.response.output.knowledge_resource_id
检索使用的知识库 ID。
queries string[] | 查询语句
response.in_progress.response.output.queries
模型实际执行的检索查询语句。
status string | 状态
response.in_progress.response.output.status
知识库检索调用的执行状态。可选值:in_progress、searching、completed、failed、incomplete。
type string | 类型
response.in_progress.response.output.type
输出条目类型标识,用于区分不同类型的输出条目。
取值固定为 knowledge_search_call。
id string | 条目 ID
response.in_progress.response.output.id
输出条目唯一标识。
豆包应用调用 object
模型对豆包助手能力的调用记录。
type string | 类型
response.in_progress.response.output.type
输出条目类型标识。
取值固定为 doubao_app_call。
blocks object[] | 内容块
response.in_progress.response.output.blocks
豆包应用调用产出的内容块列表。
文本输出 object
豆包应用产出的文本输出内容块。
type string | 类型
response.in_progress.response.output.blocks.type
内容块类型标识符。
取值固定为 output_text。
id string | 块 ID
response.in_progress.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.in_progress.response.output.blocks.parent_id
所属父级条目的 ID。
status string | 状态
response.in_progress.response.output.blocks.status
内容块状态。
text string | 文本内容
response.in_progress.response.output.blocks.text
思维链文本 object
豆包应用产出的思维链文本内容块。
type string | 类型
response.in_progress.response.output.blocks.type
内容块类型标识符。
取值固定为 reasoning_text。
id string | 块 ID
response.in_progress.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.in_progress.response.output.blocks.parent_id
所属父级条目的 ID。
reasoning_text string | 思考文本
response.in_progress.response.output.blocks.reasoning_text
思维链文本内容。
status string | 状态
response.in_progress.response.output.blocks.status
内容块状态。
搜索过程 object
豆包应用 AI 搜索过程产出的内容块。
type string | 类型
response.in_progress.response.output.blocks.type
内容块类型标识符。
取值固定为 search。
id string | 块 ID
response.in_progress.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.in_progress.response.output.blocks.parent_id
所属父级条目的 ID。
queries string[] | 查询语句
response.in_progress.response.output.blocks.queries
搜索查询语句列表。
results object[] | 搜索结果
response.in_progress.response.output.blocks.results
搜索结果列表。
text_card object | 文本卡片
response.in_progress.response.output.blocks.results.text_card
文本卡片形式的搜索结果。
sitename string | 站点名
response.in_progress.response.output.blocks.results.text_card.sitename
来源站点名称。
title string | 标题
response.in_progress.response.output.blocks.results.text_card.title
搜索结果标题。
url string | 网址
response.in_progress.response.output.blocks.results.text_card.url
搜索结果 URL 地址。
status string | 状态
response.in_progress.response.output.blocks.status
内容块状态。
summary string | 搜索总结
response.in_progress.response.output.blocks.summary
AI 搜索过程中对本轮搜索结果的总结性文字,概括从搜索结果中提取的核心信息。
推理搜索过程 object
豆包应用推理搜索过程产出的内容块。
type string | 类型
response.in_progress.response.output.blocks.type
内容块类型。
取值固定为 reasoning_search。
id string | 块 ID
response.in_progress.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.in_progress.response.output.blocks.parent_id
所属父级条目的 ID。
queries string[] | 查询语句
response.in_progress.response.output.blocks.queries
搜索查询语句列表。
results object[] | 搜索结果
response.in_progress.response.output.blocks.results
搜索结果列表。
text_card object | 文本卡片
response.in_progress.response.output.blocks.results.text_card
文本卡片形式的搜索结果。
sitename string | 站点名
response.in_progress.response.output.blocks.results.text_card.sitename
来源站点名称。
title string | 标题
response.in_progress.response.output.blocks.results.text_card.title
搜索结果标题。
url string | 网址
response.in_progress.response.output.blocks.results.text_card.url
搜索结果 URL 地址。
status string | 状态
response.in_progress.response.output.blocks.status
推理搜索内容块的处理状态。可选值:in_progress、searching、completed、incomplete、failed。
summary string | 搜索总结
response.in_progress.response.output.blocks.summary
推理搜索过程中对本轮搜索结果的总结性文字,概括从搜索结果中提取的核心信息。
feature string | 功能名
response.in_progress.response.output.feature
本次调用触发的豆包子功能名称。可选值:chat、deep_chat、ai_search、reasoning_search。
id string | 条目 ID
response.in_progress.response.output.id
输出条目唯一标识。
status string | 状态
response.in_progress.response.output.status
输出状态。可选值:completed、failed、in_progress、incomplete。
智能体工具调用 object
模型发起的智能体工具调用记录。
name string | 工具名
response.in_progress.response.output.name
被调用的智能体工具名称。
status string | 状态
response.in_progress.response.output.status
智能体工具调用的执行状态。可选值:completed、failed、in_progress、incomplete。
type string | 类型
response.in_progress.response.output.type
输出条目类型标识符,用于区分 OutputItem 的 variant。
取值固定为 agent_tool_call。
id string | 条目 ID
response.in_progress.response.output.id
输出条目唯一标识。
caching object | 缓存配置
response.in_progress.response.caching
本次响应生效的上下文缓存配置,回显请求中的 caching 设置。
prefix boolean | 仅写缓存
response.in_progress.response.caching.prefix
是否仅写入前缀缓存,不生成回复。true 只写缓存,不返回模型输出;false 正常生成回复并写缓存。
type string | 缓存模式
response.in_progress.response.caching.type
缓存模式。
enabled:开启上下文缓存。disabled:关闭上下文缓存。
context_management object | 上下文管理
response.in_progress.response.context_management
本次响应实际执行的上下文管理编辑操作,回显请求中 context_management 生效后的结果。
applied_edits object[] | 已应用编辑
response.in_progress.response.context_management.applied_edits
已应用的上下文编辑结果列表。
清理工具调用 object
已应用的清理工具调用编辑结果。
cleared_tool_uses integer | 清理次数
response.in_progress.response.context_management.applied_edits.cleared_tool_uses
已清理的工具调用数量。
type string | 类型
response.in_progress.response.context_management.applied_edits.type
编辑类型。
取值固定为 clear_tool_uses。
清理思维链 object
已应用的清理思维链编辑结果。
cleared_thinking_turns integer | 清理轮次
response.in_progress.response.context_management.applied_edits.cleared_thinking_turns
已清理的思维链轮次数量。
type string | 类型
response.in_progress.response.context_management.applied_edits.type
编辑类型。
取值固定为 clear_thinking。
error object | 错误信息
response.in_progress.response.error
模型响应过程发生错误时的错误信息。仅当 status 为 failed 时返回。
code string | 错误码
response.in_progress.response.error.code
message string | 错误描述
response.in_progress.response.error.message
错误信息的可读描述。
expire_at integer | 过期时间戳
response.in_progress.response.expire_at
响应储存的过期时刻 Unix 时间戳(秒),回显请求中的 expire_at 设置,对 store 与 caching 均生效。
incomplete_details object | 未完成详情
response.in_progress.response.incomplete_details
响应未能完成的详细信息。仅当 status 为 incomplete 时返回。
reason string | 原因
response.in_progress.response.incomplete_details.reason
响应未完成的原因。
content_filter object | 内容过滤
response.in_progress.response.incomplete_details.content_filter
内容过滤详情。
details string | 详情
response.in_progress.response.incomplete_details.content_filter.details
内容过滤命中的详细描述。
type string | 类型
response.in_progress.response.incomplete_details.content_filter.type
内容过滤命中的类型。
instructions string | 系统指令
response.in_progress.response.instructions
本次响应生效的系统指令,回显请求中的 instructions 设置。
max_output_tokens integer | 最大输出长度
response.in_progress.response.max_output_tokens
回显请求中的 max_output_tokens 参数,即模型输出最大 token 数(含回答与思维链)。
max_tool_calls integer | 最大工具调用轮次
response.in_progress.response.max_tool_calls
本次响应生效的最大工具调用轮次,回显请求中的 max_tool_calls 设置。
metadata object | 自定义元数据
response.in_progress.response.metadata
回显请求中的 metadata 键值对元数据。最多支持 16 对键值,key 长度不超过 64 个字符,value 长度不超过 512 个字符,服务端不会解释其中内容。
parallel_tool_calls boolean | 并行工具调用
response.in_progress.response.parallel_tool_calls
本次请求实际生效的并行工具调用设置,回显请求中的 parallel_tool_calls 值。
previous_response_id string | 上轮响应 ID
response.in_progress.response.previous_response_id
回显请求中的 previous_response_id,即前一轮响应的唯一标识。仅在请求传入该字段时返回。
prompt_cache_key string | 缓存分桶键
response.in_progress.response.prompt_cache_key
用于提升缓存命中率的分桶键,回显请求中的 prompt_cache_key 设置。
reasoning object | 推理配置
response.in_progress.response.reasoning
本次响应生效的深度思考工作量配置,回显请求中的 reasoning 设置。
effort string | 思考深度
response.in_progress.response.reasoning.effort
限制思考的工作量。减少思考深度可提升速度,思考花费的 token 更少。
none:关闭思考。minimal:关闭思考,直接回答。low:轻量思考,侧重快速响应。medium:均衡模式,兼顾速度与深度。high:深度分析,处理复杂问题。xhigh:更高程度思考。max:最高程度思考,适配高难度推理任务。
safety_identifier string | 安全标识
response.in_progress.response.safety_identifier
回显请求中传入的终端用户稳定标识,用于安全策略与违规行为追踪关联。
service_tier string | 推理模式
response.in_progress.response.service_tier
本次请求实际使用的推理模式。
fast:本次请求使用 在线推理(低延迟) 模式。auto:本次请求使用 在线推理(TPM 保障包) 模式。default:本次请求使用 在线推理(常规) 模式。flex:本次请求使用 在线推理(低优) 模式。
session object | 会话信息
response.in_progress.response.session
本次响应关联的会话信息,回显请求中 session 生效后的结果。
id string | 会话 ID
response.in_progress.response.session.id
会话的唯一 ID。
status string | 响应状态
response.in_progress.response.status
本次响应的当前状态,标识生成流程处于进行中、已完成、未完成或已失败等阶段。
store boolean | 是否存储
response.in_progress.response.store
是否储存生成的模型响应以供后续通过 API 检索,回显请求中的 store 设置。
temperature number | 采样温度
response.in_progress.response.temperature
本次响应生效的采样温度,回显请求中的 temperature 设置。
text object | 输出格式
response.in_progress.response.text
本次响应生效的输出格式定义,回显请求中的 text 设置。
format object | 输出格式
response.in_progress.response.text.format
文本输出格式定义。
type string | 格式类型
response.in_progress.response.text.format.type
输出格式类型。可选值:text、json_schema、json_object。
description string | 格式描述
response.in_progress.response.text.format.description
格式描述信息。
name string | 格式名称
response.in_progress.response.text.format.name
格式名称,作为 JSON Schema 输出格式的标识。
schema object | Schema 定义
response.in_progress.response.text.format.schema
JSON Schema 定义。当 type 为 json_schema 时必填。
strict boolean | 严格模式
response.in_progress.response.text.format.strict
是否严格按 JSON Schema 校验模型输出。
thinking object | 深度思考
response.in_progress.response.thinking
本次响应生效的深度思考配置,回显请求中的 thinking 设置。
type string | 思考模式
response.in_progress.response.thinking.type
深度思考模式。
enabled:开启深度思考。disabled:关闭深度思考。auto:由模型自行判断是否需要深度思考。
tool_choice string / object | 工具调用策略
response.in_progress.response.tool_choice
本次请求实际生效的工具调用策略,回显请求中的 tool_choice 设置。
简单策略 string
直接传入字符串 none、auto 或 required,控制工具调用整体策略。
指定工具 object
通过对象指定具体工具类型或工具名进行调用。
type string | 工具类型
response.in_progress.response.tool_choice.type
指定要调用的工具类型,用于精确路由到对应工具。可选值:
functionweb_searchimage_processmcpknowledge_searchdoubao_app
name string | 工具名称
response.in_progress.response.tool_choice.name
指定要调用的具体工具名,如函数名或 MCP 服务下的工具名。
tools object[] | 工具列表
response.in_progress.response.tools
本次响应生效的工具列表,回显请求中的 tools 设置。
函数调用 object
自定义函数调用(Function Calling),让模型生成结构化的函数参数。
name string | 函数名
response.in_progress.response.tools.name
供模型调用的函数名称,模型在 function_call 输出中以该名称回传,用于匹配对应函数。
type string | 类型
response.in_progress.response.tools.type
工具类型标识,用于在 union 中区分不同工具类别。
取值固定为 function。
description string | 函数描述
response.in_progress.response.tools.description
函数的描述信息,帮助模型理解何时使用该函数。
parameters object | 参数定义
response.in_progress.response.tools.parameters
函数参数定义,遵循 JSON Schema 格式。
联网搜索 object
联网搜索工具,让模型在需要时自动进行网页搜索获取实时信息。
type string | 类型
response.in_progress.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 web_search。
limit integer | 最大结果数
response.in_progress.response.tools.limit
每轮搜索最大返回结果数量。
取值范围:[1, 50]
max_keyword integer | 最大关键词数
response.in_progress.response.tools.max_keyword
最大并行搜索关键词数量。
取值范围:[1, 50]
sources string[] | 搜索来源
response.in_progress.response.tools.sources
搜索信息来源限制,指定模型可从哪些渠道检索网页内容。可选值:toutiao、douyin、moji、search_engine、doubao。
user_location object | 用户位置
response.in_progress.response.tools.user_location
用户地理位置信息,用于搜索优化。
type string | 类型
response.in_progress.response.tools.user_location.type
位置类型。
取值固定为 approximate。
city string | 城市
response.in_progress.response.tools.user_location.city
用户所在城市。
country string | 国家
response.in_progress.response.tools.user_location.country
用户所在国家。
region string | 地区
response.in_progress.response.tools.user_location.region
用户所在地区。
timezone number | 时区
response.in_progress.response.tools.user_location.timezone
用户所在时区。
图像处理 object
图像处理工具,让模型对图片进行画点、选区、缩放、旋转等操作。
type string | 类型
response.in_progress.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 image_process。
grounding object | 选区功能
response.in_progress.response.tools.grounding
选区/裁切功能配置,启用后模型可返回图像中目标的检测框或裁切区域坐标。
type string | 开关
response.in_progress.response.tools.grounding.type
功能开关。可选值:enabled、disabled。
point object | 画点功能
response.in_progress.response.tools.point
画点/画线功能开关。
type string | 开关
response.in_progress.response.tools.point.type
功能开关。可选值:enabled、disabled。
rotate object | 旋转功能
response.in_progress.response.tools.rotate
旋转功能开关。启用后模型可请求对图片按指定角度进行旋转。
type string | 开关
response.in_progress.response.tools.rotate.type
功能开关。可选值:enabled、disabled。
zoom object | 缩放功能
response.in_progress.response.tools.zoom
缩放功能开关,启用后模型可对图像目标区域执行缩放操作。
type string | 开关
response.in_progress.response.tools.zoom.type
功能开关。可选值:enabled、disabled。
MCP 工具 object
MCP(Model Context Protocol)工具,让模型调用外部 MCP Server 提供的工具。
server_label string | 服务标签
response.in_progress.response.tools.server_label
MCP Server 的唯一标识标签。模型在工具调用输出中通过该标签指向对应 Server,便于在多个 MCP Server 场景下区分调用来源。
server_url string | 服务地址
response.in_progress.response.tools.server_url
MCP Server 的 HTTP(S) 访问地址,模型通过该地址向 Server 发起工具调用请求。
type string | 类型
response.in_progress.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 mcp。
allowed_tools string[] / object | 允许工具
response.in_progress.response.tools.allowed_tools
允许模型调用的工具范围。可传工具名称字符串数组,或包含 tool_names 字段的过滤器对象。
工具名数组 string[]
直接传入允许调用的工具名称数组。
工具过滤器 object
通过过滤器对象指定允许调用的工具范围。
tool_names string[] | 工具名列表
response.in_progress.response.tools.allowed_tools.tool_names
允许调用的工具名称列表。
headers object | 请求头
response.in_progress.response.tools.headers
调用 MCP Server 时附加的 HTTP 请求头,以字符串键值对形式指定 header 名与值。
require_approval string / object | 审批策略
response.in_progress.response.tools.require_approval
MCP 工具调用前的审批策略;支持简单模式(字符串)或按工具粒度控制(过滤器对象)。
简单策略 string
直接传入字符串 always 或 never,对所有工具应用统一审批策略。
工具过滤器 object
通过过滤器对象按工具粒度配置审批策略。
always object | 始终审批
response.in_progress.response.tools.require_approval.always
始终需要审批的工具过滤器。
tool_names string[] | 工具名列表
response.in_progress.response.tools.require_approval.always.tool_names
始终需要审批的工具名称列表。
never object | 无需审批
response.in_progress.response.tools.require_approval.never
无需审批的工具过滤器。
tool_names string[] | 工具名列表
response.in_progress.response.tools.require_approval.never.tool_names
无需审批即可调用的工具名称列表。
server_description string | 服务描述
response.in_progress.response.tools.server_description
MCP Server 的描述信息,帮助模型理解何时使用该 Server。
知识库搜索 object
私域知识库搜索工具,让模型检索企业内部知识库中的文档内容。
knowledge_resource_id string | 知识库 ID
response.in_progress.response.tools.knowledge_resource_id
type string | 类型
response.in_progress.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 knowledge_search。
dense_weight number | 稠密权重
response.in_progress.response.tools.dense_weight
混合检索中稠密向量(语义)检索的权重,值越大越偏向语义匹配,越小越偏向关键词匹配。
取值范围:[0.2, 1]
description string | 知识库描述
response.in_progress.response.tools.description
知识库描述信息,帮助模型理解何时使用该知识库。
doc_filter object | 文档过滤
response.in_progress.response.tools.doc_filter
设置文档字段级别的检索过滤条件,确保只在符合条件的文档中检索。
limit integer | 最大结果数
response.in_progress.response.tools.limit
最大搜索结果数量。
取值范围:[1, 200]
max_keyword integer | 最大关键词数
response.in_progress.response.tools.max_keyword
最大并行搜索关键词数量。
取值范围:[1, 50]
ranking_options object | 排序选项
response.in_progress.response.tools.ranking_options
检索后处理选项。可参考 知识库 API 文档 post_processing 字段。
chunk_diffusion_count integer | 切片扩散数
response.in_progress.response.tools.ranking_options.chunk_diffusion_count
检索阶段返回命中切片的上下几片邻近切片。取 0 表示不进行 chunk diffusion。
取值范围:[0, 5]
chunk_group boolean | 文本聚合
response.in_progress.response.tools.ranking_options.chunk_group
文本聚合。
- 默认不聚合。
- 对于非结构化文件,可开启文本聚合以更好保留原文档内容语序。
- 开启后,会根据文档及文档顺序,对切片重新聚合排序返回。
get_attachment_link boolean | 获取附件链接
response.in_progress.response.tools.ranking_options.get_attachment_link
是否获取切片中图片的临时下载链接。
rerank_model string | Rerank 模型
response.in_progress.response.tools.ranking_options.rerank_model
rerank 模型选择。默认值:base-multilingual-rerank。取值:base-multilingual-rerank / m3-v2-rerank。
rerank_only_chunk boolean | 仅切片重排
response.in_progress.response.tools.ranking_options.rerank_only_chunk
是否仅根据 chunk 内容计算重排分数。true 只根据 chunk 内容计算分;false 根据 chunk title + 内容一起计算排序分。
rerank_switch boolean | 开启重排
response.in_progress.response.tools.ranking_options.rerank_switch
是否自动对检索结果做 rerank。若设置为 true,则会自动请求 rerank 模型排序。
retrieve_count integer | 重排切片数
response.in_progress.response.tools.ranking_options.retrieve_count
进入重排的切片数量。
豆包助手 object
豆包助手工具,让模型使用豆包的聊天、深度思考、AI 搜索和推理搜索能力。
feature object | 功能配置
response.in_progress.response.tools.feature
豆包助手的子功能配置,用于按需开启聊天、深度思考、AI 搜索、推理搜索四类能力并设置对应角色描述。
ai_search object | AI 搜索
response.in_progress.response.tools.feature.ai_search
AI 搜索功能配置。
role_description string | 角色描述
response.in_progress.response.tools.feature.ai_search.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.in_progress.response.tools.feature.ai_search.type
功能开关。可选值:enabled、disabled。
chat object | 普通聊天
response.in_progress.response.tools.feature.chat
普通聊天功能配置。
role_description string | 角色描述
response.in_progress.response.tools.feature.chat.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.in_progress.response.tools.feature.chat.type
功能开关。可选值:enabled、disabled。
deep_chat object | 深度聊天
response.in_progress.response.tools.feature.deep_chat
深度聊天功能配置。
role_description string | 角色描述
response.in_progress.response.tools.feature.deep_chat.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.in_progress.response.tools.feature.deep_chat.type
功能开关。可选值:enabled、disabled。
reasoning_search object | 推理搜索
response.in_progress.response.tools.feature.reasoning_search
推理搜索功能配置。
role_description string | 角色描述
response.in_progress.response.tools.feature.reasoning_search.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.in_progress.response.tools.feature.reasoning_search.type
功能开关。可选值:enabled、disabled。
type string | 类型
response.in_progress.response.tools.type
工具类型,此处固定为 doubao_app
user_location object | 用户位置
response.in_progress.response.tools.user_location
用户地理位置信息,用于搜索优化。
type string | 类型
response.in_progress.response.tools.user_location.type
位置类型。
取值固定为 approximate。
city string | 城市
response.in_progress.response.tools.user_location.city
用户所在城市。
country string | 国家
response.in_progress.response.tools.user_location.country
用户所在国家。
region string | 地区
response.in_progress.response.tools.user_location.region
用户所在地区。
timezone number | 时区
response.in_progress.response.tools.user_location.timezone
用户所在时区。
top_p number | 采样阈值
response.in_progress.response.top_p
本次请求实际使用的核采样概率阈值。
usage object | 用量统计
response.in_progress.response.usage
本次响应的 token 用量统计,包含输入、输出与总计 token 数等明细。
input_tokens integer | 输入 token 数
response.in_progress.response.usage.input_tokens
输入消耗的 token 数量。
input_tokens_details object | 输入明细
response.in_progress.response.usage.input_tokens_details
输入 token 用量明细。
cached_tokens integer | 缓存 token
response.in_progress.response.usage.input_tokens_details.cached_tokens
命中缓存的 token 数量。
audio_cached_tokens integer | 音频缓存 Token 数
response.in_progress.response.usage.input_tokens_details.audio_cached_tokens
缓存命中的音频输入内容所消耗的 token 数量。仅在隐式缓存模式且命中音频缓存时返回;开启显式缓存时该字段不返回。
audio_tokens integer | 音频 token
response.in_progress.response.usage.input_tokens_details.audio_tokens
音频输入消耗的 token 数量。
output_tokens integer | 输出 token 数
response.in_progress.response.usage.output_tokens
输出消耗的 token 数量。
output_tokens_details object | 输出明细
response.in_progress.response.usage.output_tokens_details
输出 token 用量明细。
reasoning_tokens integer | 思考 token
response.in_progress.response.usage.output_tokens_details.reasoning_tokens
深度思考消耗的 token 数量。
total_tokens integer | 总 token 数
response.in_progress.response.usage.total_tokens
本次请求消耗的 token 总数。
tool_usage object | 工具用量
response.in_progress.response.usage.tool_usage
工具调用用量统计。
doubao_app integer | 豆包次数
response.in_progress.response.usage.tool_usage.doubao_app
豆包助手工具调用次数。
knowledge_search integer | 知识库次数
response.in_progress.response.usage.tool_usage.knowledge_search
知识库搜索工具调用次数。
mcp integer | MCP 次数
response.in_progress.response.usage.tool_usage.mcp
MCP 工具调用次数。
web_search integer | 搜索次数
response.in_progress.response.usage.tool_usage.web_search
联网搜索工具调用次数。
tool_usage_details object | 工具明细
response.in_progress.response.usage.tool_usage_details
工具调用用量明细。
doubao_app object | 豆包明细
response.in_progress.response.usage.tool_usage_details.doubao_app
豆包助手工具用量明细。
knowledge_search object | 知识库明细
response.in_progress.response.usage.tool_usage_details.knowledge_search
知识库搜索工具用量明细。
mcp object | MCP 明细
response.in_progress.response.usage.tool_usage_details.mcp
MCP 工具用量明细。
web_search object | 搜索明细
response.in_progress.response.usage.tool_usage_details.web_search
联网搜索工具用量明细。
sequence_number integer | 序列号
response.in_progress.sequence_number
事件的序列号。
type string | 事件类型
response.in_progress.type
事件的类型,总是 response.in_progress
response.completed#
当响应已完成触发的事件。
response object | 响应对象
response.completed.response
已完成状态的响应。包含参数与非流式调用返回的参数一致。
created_at integer | 创建时间戳
response.completed.response.created_at
该 Response 创建时的 Unix 时间戳(单位:秒)。
id string | 响应 ID
response.completed.response.id
本次 Response 的唯一标识,可用于后续查询、续接或删除该响应。
model string | 模型 ID
response.completed.response.model
生成本次响应所使用的模型标识,回显请求中的 model 字段。
object string | 对象类型
response.completed.response.object
返回对象的类型标识,用于区分响应对象种类。
取值固定为 response。
output object[] | 输出内容
response.completed.response.output
模型本次响应产出的 Item 列表,按生成顺序排列,可能包含消息、工具调用、推理等不同类型条目。
消息输出 object
模型生成的消息输出,包含文本内容。
content object[] | 输出内容
response.completed.response.output.content
输出内容列表。
模型回答文本 object
模型生成的最终回答文本。
type string | 类型
response.completed.response.output.content.type
内容类型判别字段,用于区分 union 变体。
取值固定为 output_text。
annotations object[] | 标注列表
response.completed.response.output.content.annotations
文本附带的标注信息列表(如引用来源等)
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.completed.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.completed.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.completed.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.completed.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.completed.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.completed.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.completed.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.completed.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.completed.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.completed.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.completed.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.completed.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.completed.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.completed.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.completed.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.completed.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.completed.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.completed.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.completed.response.output.content.text
模型生成的文本内容。
模型思维链文本 object
模型生成的思维链文本。
type string | 类型
response.completed.response.output.content.type
内容类型标识,用于区分 union 变体。
取值固定为 reasoning_text。
annotations object[] | 标注列表
response.completed.response.output.content.annotations
思维链附带的标注信息列表。
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.completed.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.completed.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.completed.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.completed.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.completed.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.completed.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.completed.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.completed.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.completed.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.completed.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.completed.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.completed.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.completed.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.completed.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.completed.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.completed.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.completed.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.completed.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.completed.response.output.content.text
模型思维链文本内容。
id string | 条目 ID
response.completed.response.output.id
输出条目唯一标识。
role string | 角色
response.completed.response.output.role
消息发送者的角色。
取值固定为 assistant。
status string | 状态
response.completed.response.output.status
消息输出条目的当前状态。
completed:消息已生成完毕。in_progress:消息正在生成中(流式场景)。incomplete:消息未完整生成(例如达到max_output_tokens上限)。failed:消息生成失败。
type string | 类型
response.completed.response.output.type
输出条目的类型标识。
取值固定为 message。
partial boolean | 增量片段
response.completed.response.output.partial
是否为流式增量片段。
phase string | 消息阶段
response.completed.response.output.phase
标记 assistant 消息属于中间讲解还是最终回答。在回放 assistant 历史消息时,建议保留并原样回传该字段。可选值:commentary、final_answer。
函数调用输出 object
模型发起的函数调用请求。
type string | 类型
response.completed.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 function_call。
arguments string | 参数
response.completed.response.output.arguments
函数参数的 JSON 字符串。
call_id string | 调用 ID
response.completed.response.output.call_id
函数调用的唯一标识 ID,用于将该 function_call 输出与后续回传的 function_call_output 关联匹配。
id string | 条目 ID
response.completed.response.output.id
输出条目唯一标识。
name string | 函数名
response.completed.response.output.name
调用的函数名称。
status string | 状态
response.completed.response.output.status
函数调用条目的当前状态。
completed:函数调用请求已生成完毕。in_progress:函数调用请求正在生成中(流式场景)。incomplete:函数调用请求未完整生成(例如达到max_output_tokens上限)。failed:函数调用生成失败。
思维链输出 object
模型的深度思考过程输出。
status string | 状态
response.completed.response.output.status
推理条目的处理状态,用于判断思维链是否生成完成。可选值:completed、failed、in_progress、incomplete。
summary object[] | 推理摘要
response.completed.response.output.summary
推理摘要内容列表。
type string | 类型
response.completed.response.output.summary.type
摘要片段类型标识。
取值固定为 summary_text。
text string | 摘要文本
response.completed.response.output.summary.text
思维链摘要文本内容。
type string | 类型
response.completed.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 reasoning。
content object[] | 推理内容
response.completed.response.output.content
思维链推理过程的内容元素列表。
模型回答文本 object
模型生成的最终回答文本。
type string | 类型
response.completed.response.output.content.type
内容类型判别字段,用于区分 union 变体。
取值固定为 output_text。
annotations object[] | 标注列表
response.completed.response.output.content.annotations
文本附带的标注信息列表(如引用来源等)
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.completed.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.completed.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.completed.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.completed.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.completed.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.completed.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.completed.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.completed.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.completed.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.completed.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.completed.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.completed.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.completed.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.completed.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.completed.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.completed.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.completed.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.completed.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.completed.response.output.content.text
模型生成的文本内容。
模型思维链文本 object
模型生成的思维链文本。
type string | 类型
response.completed.response.output.content.type
内容类型标识,用于区分 union 变体。
取值固定为 reasoning_text。
annotations object[] | 标注列表
response.completed.response.output.content.annotations
思维链附带的标注信息列表。
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.completed.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.completed.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.completed.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.completed.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.completed.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.completed.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.completed.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.completed.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.completed.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.completed.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.completed.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.completed.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.completed.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.completed.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.completed.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.completed.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.completed.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.completed.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.completed.response.output.content.text
模型思维链文本内容。
encrypted_content string | 加密思维链
response.completed.response.output.encrypted_content
思考内容加密原文。经加密及压缩处理后的思考内容原文。
相关文档:
模型支持:
doubao-seed-2-0-lite-260428 及后续版本
id string | 条目 ID
response.completed.response.output.id
输出条目唯一标识。
语音转写输出 object
模型返回的语音转写输出。
status string | 状态
response.completed.response.output.status
语音转写条目的当前状态。
completed:转写已生成完毕。in_progress:转写正在生成中(流式场景)。incomplete:转写未完整生成(例如达到输出上限而截断)。failed:转写生成失败。
type string | 类型
response.completed.response.output.type
输出条目类型标识。
取值固定为 transcription。
id string | 条目 ID
response.completed.response.output.id
输出条目唯一标识。
transcription object[] | 转写内容
response.completed.response.output.transcription
语音转写结果片段列表。
type string | 类型
response.completed.response.output.transcription.type
转写片段类型。
取值固定为 transcription_text。
chunks object[] | 音频小段
response.completed.response.output.transcription.chunks
当前片段对应的音频小段列表。
end_time integer | 结束时间
response.completed.response.output.transcription.chunks.end_time
片段结束时间(毫秒)
start_time integer | 开始时间
response.completed.response.output.transcription.chunks.start_time
片段开始时间(毫秒)
text string | 文字内容
response.completed.response.output.transcription.chunks.text
当前片段对应的文字内容。
text string | 转写文本
response.completed.response.output.transcription.text
当前片段的转写文本。
网页搜索调用 object
模型发起的网页搜索调用记录。
id string | 条目 ID
response.completed.response.output.id
输出条目唯一标识。
status string | 状态
response.completed.response.output.status
网页搜索调用的当前状态。可选值:in_progress、searching、completed、incomplete、failed。
type string | 类型
response.completed.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 web_search_call。
action object | 搜索动作
response.completed.response.output.action
描述模型执行的网页搜索动作,包括搜索类型与查询关键字。
query string | 查询语句
response.completed.response.output.action.query
模型实际发起的搜索查询语句。
type string | 类型
response.completed.response.output.action.type
网页搜索动作的类型标识。
取值固定为 search。
queries string[] | 查询语句列表
response.completed.response.output.action.queries
本次网页搜索产生的查询语句列表。
图像处理调用 object
模型发起的图像处理调用记录。
id string | 条目 ID
response.completed.response.output.id
输出条目唯一标识。
status string | 状态
response.completed.response.output.status
图像处理调用的当前状态。
completed:图像处理已完成。in_progress:图像处理正在执行中。incomplete:图像处理未完整执行(例如被中断或截断)。failed:图像处理执行失败,具体原因见error字段。
type string | 类型
response.completed.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 image_process。
action object | 处理动作
response.completed.response.output.action
图像处理动作详情。
type string | 类型
response.completed.response.output.action.type
图像处理动作类型。
result_image_url string | 结果图地址
response.completed.response.output.action.result_image_url
处理后图像的 URL 地址。
arguments object | 处理参数
response.completed.response.output.arguments
图像处理动作的输入参数,以键值对形式承载具体处理选项。
error object | 图像处理错误
response.completed.response.output.error
图像处理失败时的错误信息。
message string | 错误描述
response.completed.response.output.error.message
错误的可读描述。
MCP 审批请求 object
MCP 工具调用前的审批请求记录。
arguments string | 调用参数
response.completed.response.output.arguments
工具调用参数的 JSON 字符串。
name string | 工具名
response.completed.response.output.name
待运行的工具名称。
server_label string | 服务标签
response.completed.response.output.server_label
发起请求的 MCP Server 标签。
type string | 类型
response.completed.response.output.type
输出项类型标识符,用于区分 OutputItem 的变体。
取值固定为 mcp_approval_request。
id string | 请求 ID
response.completed.response.output.id
审批请求的唯一 ID。
MCP 工具清单 object
MCP Server 提供的工具清单输出。
server_label string | 服务标签
response.completed.response.output.server_label
MCP Server 标签。
type string | 类型
response.completed.response.output.type
输出项类型标识。
取值固定为 mcp_list_tools。
error string | 错误信息
response.completed.response.output.error
当 MCP Server 无法返回工具列表时的错误信息。
id string | 列表 ID
response.completed.response.output.id
工具列表的唯一 ID。
tools object[] | 工具列表
response.completed.response.output.tools
该 MCP Server 上可用的工具列表。
name string | 工具名
response.completed.response.output.tools.name
工具名称。
annotations object | 注解信息
response.completed.response.output.tools.annotations
工具的附加注解信息。
description string | 工具描述
response.completed.response.output.tools.description
工具的功能描述。
input_schema object | 入参 Schema
response.completed.response.output.tools.input_schema
描述工具入参的 JSON Schema。
MCP 工具调用 object
模型对 MCP 工具的实际调用记录及结果。
name string | 工具名
response.completed.response.output.name
实际运行的工具名称。
server_label string | 服务标签
response.completed.response.output.server_label
运行工具的 MCP Server 标签。
type string | 类型
response.completed.response.output.type
标识该输出项为 MCP 工具调用记录。
取值固定为 mcp_call。
arguments string | 调用参数
response.completed.response.output.arguments
传递给 MCP 工具的调用参数,格式为 JSON 字符串。
error string | 错误信息
response.completed.response.output.error
工具调用失败时的错误信息。
id string | 调用 ID
response.completed.response.output.id
工具调用的唯一 ID。
output string | 返回结果
response.completed.response.output.output
工具调用的返回结果。
知识库检索调用 object
模型发起的私域知识库检索调用记录。
knowledge_resource_id string | 知识库 ID
response.completed.response.output.knowledge_resource_id
检索使用的知识库 ID。
queries string[] | 查询语句
response.completed.response.output.queries
模型实际执行的检索查询语句。
status string | 状态
response.completed.response.output.status
知识库检索调用的执行状态。可选值:in_progress、searching、completed、failed、incomplete。
type string | 类型
response.completed.response.output.type
输出条目类型标识,用于区分不同类型的输出条目。
取值固定为 knowledge_search_call。
id string | 条目 ID
response.completed.response.output.id
输出条目唯一标识。
豆包应用调用 object
模型对豆包助手能力的调用记录。
type string | 类型
response.completed.response.output.type
输出条目类型标识。
取值固定为 doubao_app_call。
blocks object[] | 内容块
response.completed.response.output.blocks
豆包应用调用产出的内容块列表。
文本输出 object
豆包应用产出的文本输出内容块。
type string | 类型
response.completed.response.output.blocks.type
内容块类型标识符。
取值固定为 output_text。
id string | 块 ID
response.completed.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.completed.response.output.blocks.parent_id
所属父级条目的 ID。
status string | 状态
response.completed.response.output.blocks.status
内容块状态。
text string | 文本内容
response.completed.response.output.blocks.text
思维链文本 object
豆包应用产出的思维链文本内容块。
type string | 类型
response.completed.response.output.blocks.type
内容块类型标识符。
取值固定为 reasoning_text。
id string | 块 ID
response.completed.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.completed.response.output.blocks.parent_id
所属父级条目的 ID。
reasoning_text string | 思考文本
response.completed.response.output.blocks.reasoning_text
思维链文本内容。
status string | 状态
response.completed.response.output.blocks.status
内容块状态。
搜索过程 object
豆包应用 AI 搜索过程产出的内容块。
type string | 类型
response.completed.response.output.blocks.type
内容块类型标识符。
取值固定为 search。
id string | 块 ID
response.completed.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.completed.response.output.blocks.parent_id
所属父级条目的 ID。
queries string[] | 查询语句
response.completed.response.output.blocks.queries
搜索查询语句列表。
results object[] | 搜索结果
response.completed.response.output.blocks.results
搜索结果列表。
text_card object | 文本卡片
response.completed.response.output.blocks.results.text_card
文本卡片形式的搜索结果。
sitename string | 站点名
response.completed.response.output.blocks.results.text_card.sitename
来源站点名称。
title string | 标题
response.completed.response.output.blocks.results.text_card.title
搜索结果标题。
url string | 网址
response.completed.response.output.blocks.results.text_card.url
搜索结果 URL 地址。
status string | 状态
response.completed.response.output.blocks.status
内容块状态。
summary string | 搜索总结
response.completed.response.output.blocks.summary
AI 搜索过程中对本轮搜索结果的总结性文字,概括从搜索结果中提取的核心信息。
推理搜索过程 object
豆包应用推理搜索过程产出的内容块。
type string | 类型
response.completed.response.output.blocks.type
内容块类型。
取值固定为 reasoning_search。
id string | 块 ID
response.completed.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.completed.response.output.blocks.parent_id
所属父级条目的 ID。
queries string[] | 查询语句
response.completed.response.output.blocks.queries
搜索查询语句列表。
results object[] | 搜索结果
response.completed.response.output.blocks.results
搜索结果列表。
text_card object | 文本卡片
response.completed.response.output.blocks.results.text_card
文本卡片形式的搜索结果。
sitename string | 站点名
response.completed.response.output.blocks.results.text_card.sitename
来源站点名称。
title string | 标题
response.completed.response.output.blocks.results.text_card.title
搜索结果标题。
url string | 网址
response.completed.response.output.blocks.results.text_card.url
搜索结果 URL 地址。
status string | 状态
response.completed.response.output.blocks.status
推理搜索内容块的处理状态。可选值:in_progress、searching、completed、incomplete、failed。
summary string | 搜索总结
response.completed.response.output.blocks.summary
推理搜索过程中对本轮搜索结果的总结性文字,概括从搜索结果中提取的核心信息。
feature string | 功能名
response.completed.response.output.feature
本次调用触发的豆包子功能名称。可选值:chat、deep_chat、ai_search、reasoning_search。
id string | 条目 ID
response.completed.response.output.id
输出条目唯一标识。
status string | 状态
response.completed.response.output.status
输出状态。可选值:completed、failed、in_progress、incomplete。
智能体工具调用 object
模型发起的智能体工具调用记录。
name string | 工具名
response.completed.response.output.name
被调用的智能体工具名称。
status string | 状态
response.completed.response.output.status
智能体工具调用的执行状态。可选值:completed、failed、in_progress、incomplete。
type string | 类型
response.completed.response.output.type
输出条目类型标识符,用于区分 OutputItem 的 variant。
取值固定为 agent_tool_call。
id string | 条目 ID
response.completed.response.output.id
输出条目唯一标识。
caching object | 缓存配置
response.completed.response.caching
本次响应生效的上下文缓存配置,回显请求中的 caching 设置。
prefix boolean | 仅写缓存
response.completed.response.caching.prefix
是否仅写入前缀缓存,不生成回复。true 只写缓存,不返回模型输出;false 正常生成回复并写缓存。
type string | 缓存模式
response.completed.response.caching.type
缓存模式。
enabled:开启上下文缓存。disabled:关闭上下文缓存。
context_management object | 上下文管理
response.completed.response.context_management
本次响应实际执行的上下文管理编辑操作,回显请求中 context_management 生效后的结果。
applied_edits object[] | 已应用编辑
response.completed.response.context_management.applied_edits
已应用的上下文编辑结果列表。
清理工具调用 object
已应用的清理工具调用编辑结果。
cleared_tool_uses integer | 清理次数
response.completed.response.context_management.applied_edits.cleared_tool_uses
已清理的工具调用数量。
type string | 类型
response.completed.response.context_management.applied_edits.type
编辑类型。
取值固定为 clear_tool_uses。
清理思维链 object
已应用的清理思维链编辑结果。
cleared_thinking_turns integer | 清理轮次
response.completed.response.context_management.applied_edits.cleared_thinking_turns
已清理的思维链轮次数量。
type string | 类型
response.completed.response.context_management.applied_edits.type
编辑类型。
取值固定为 clear_thinking。
error object | 错误信息
response.completed.response.error
模型响应过程发生错误时的错误信息。仅当 status 为 failed 时返回。
code string | 错误码
response.completed.response.error.code
message string | 错误描述
response.completed.response.error.message
错误信息的可读描述。
expire_at integer | 过期时间戳
response.completed.response.expire_at
响应储存的过期时刻 Unix 时间戳(秒),回显请求中的 expire_at 设置,对 store 与 caching 均生效。
incomplete_details object | 未完成详情
response.completed.response.incomplete_details
响应未能完成的详细信息。仅当 status 为 incomplete 时返回。
reason string | 原因
response.completed.response.incomplete_details.reason
响应未完成的原因。
content_filter object | 内容过滤
response.completed.response.incomplete_details.content_filter
内容过滤详情。
details string | 详情
response.completed.response.incomplete_details.content_filter.details
内容过滤命中的详细描述。
type string | 类型
response.completed.response.incomplete_details.content_filter.type
内容过滤命中的类型。
instructions string | 系统指令
response.completed.response.instructions
本次响应生效的系统指令,回显请求中的 instructions 设置。
max_output_tokens integer | 最大输出长度
response.completed.response.max_output_tokens
回显请求中的 max_output_tokens 参数,即模型输出最大 token 数(含回答与思维链)。
max_tool_calls integer | 最大工具调用轮次
response.completed.response.max_tool_calls
本次响应生效的最大工具调用轮次,回显请求中的 max_tool_calls 设置。
metadata object | 自定义元数据
response.completed.response.metadata
回显请求中的 metadata 键值对元数据。最多支持 16 对键值,key 长度不超过 64 个字符,value 长度不超过 512 个字符,服务端不会解释其中内容。
parallel_tool_calls boolean | 并行工具调用
response.completed.response.parallel_tool_calls
本次请求实际生效的并行工具调用设置,回显请求中的 parallel_tool_calls 值。
previous_response_id string | 上轮响应 ID
response.completed.response.previous_response_id
回显请求中的 previous_response_id,即前一轮响应的唯一标识。仅在请求传入该字段时返回。
prompt_cache_key string | 缓存分桶键
response.completed.response.prompt_cache_key
用于提升缓存命中率的分桶键,回显请求中的 prompt_cache_key 设置。
reasoning object | 推理配置
response.completed.response.reasoning
本次响应生效的深度思考工作量配置,回显请求中的 reasoning 设置。
effort string | 思考深度
response.completed.response.reasoning.effort
限制思考的工作量。减少思考深度可提升速度,思考花费的 token 更少。
none:关闭思考。minimal:关闭思考,直接回答。low:轻量思考,侧重快速响应。medium:均衡模式,兼顾速度与深度。high:深度分析,处理复杂问题。xhigh:更高程度思考。max:最高程度思考,适配高难度推理任务。
safety_identifier string | 安全标识
response.completed.response.safety_identifier
回显请求中传入的终端用户稳定标识,用于安全策略与违规行为追踪关联。
service_tier string | 推理模式
response.completed.response.service_tier
本次请求实际使用的推理模式。
fast:本次请求使用 在线推理(低延迟) 模式。auto:本次请求使用 在线推理(TPM 保障包) 模式。default:本次请求使用 在线推理(常规) 模式。flex:本次请求使用 在线推理(低优) 模式。
session object | 会话信息
response.completed.response.session
本次响应关联的会话信息,回显请求中 session 生效后的结果。
id string | 会话 ID
response.completed.response.session.id
会话的唯一 ID。
status string | 响应状态
response.completed.response.status
本次响应的当前状态,标识生成流程处于进行中、已完成、未完成或已失败等阶段。
store boolean | 是否存储
response.completed.response.store
是否储存生成的模型响应以供后续通过 API 检索,回显请求中的 store 设置。
temperature number | 采样温度
response.completed.response.temperature
本次响应生效的采样温度,回显请求中的 temperature 设置。
text object | 输出格式
response.completed.response.text
本次响应生效的输出格式定义,回显请求中的 text 设置。
format object | 输出格式
response.completed.response.text.format
文本输出格式定义。
type string | 格式类型
response.completed.response.text.format.type
输出格式类型。可选值:text、json_schema、json_object。
description string | 格式描述
response.completed.response.text.format.description
格式描述信息。
name string | 格式名称
response.completed.response.text.format.name
格式名称,作为 JSON Schema 输出格式的标识。
schema object | Schema 定义
response.completed.response.text.format.schema
JSON Schema 定义。当 type 为 json_schema 时必填。
strict boolean | 严格模式
response.completed.response.text.format.strict
是否严格按 JSON Schema 校验模型输出。
thinking object | 深度思考
response.completed.response.thinking
本次响应生效的深度思考配置,回显请求中的 thinking 设置。
type string | 思考模式
response.completed.response.thinking.type
深度思考模式。
enabled:开启深度思考。disabled:关闭深度思考。auto:由模型自行判断是否需要深度思考。
tool_choice string / object | 工具调用策略
response.completed.response.tool_choice
本次请求实际生效的工具调用策略,回显请求中的 tool_choice 设置。
简单策略 string
直接传入字符串 none、auto 或 required,控制工具调用整体策略。
指定工具 object
通过对象指定具体工具类型或工具名进行调用。
type string | 工具类型
response.completed.response.tool_choice.type
指定要调用的工具类型,用于精确路由到对应工具。可选值:
functionweb_searchimage_processmcpknowledge_searchdoubao_app
name string | 工具名称
response.completed.response.tool_choice.name
指定要调用的具体工具名,如函数名或 MCP 服务下的工具名。
tools object[] | 工具列表
response.completed.response.tools
本次响应生效的工具列表,回显请求中的 tools 设置。
函数调用 object
自定义函数调用(Function Calling),让模型生成结构化的函数参数。
name string | 函数名
response.completed.response.tools.name
供模型调用的函数名称,模型在 function_call 输出中以该名称回传,用于匹配对应函数。
type string | 类型
response.completed.response.tools.type
工具类型标识,用于在 union 中区分不同工具类别。
取值固定为 function。
description string | 函数描述
response.completed.response.tools.description
函数的描述信息,帮助模型理解何时使用该函数。
parameters object | 参数定义
response.completed.response.tools.parameters
函数参数定义,遵循 JSON Schema 格式。
联网搜索 object
联网搜索工具,让模型在需要时自动进行网页搜索获取实时信息。
type string | 类型
response.completed.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 web_search。
limit integer | 最大结果数
response.completed.response.tools.limit
每轮搜索最大返回结果数量。
取值范围:[1, 50]
max_keyword integer | 最大关键词数
response.completed.response.tools.max_keyword
最大并行搜索关键词数量。
取值范围:[1, 50]
sources string[] | 搜索来源
response.completed.response.tools.sources
搜索信息来源限制,指定模型可从哪些渠道检索网页内容。可选值:toutiao、douyin、moji、search_engine、doubao。
user_location object | 用户位置
response.completed.response.tools.user_location
用户地理位置信息,用于搜索优化。
type string | 类型
response.completed.response.tools.user_location.type
位置类型。
取值固定为 approximate。
city string | 城市
response.completed.response.tools.user_location.city
用户所在城市。
country string | 国家
response.completed.response.tools.user_location.country
用户所在国家。
region string | 地区
response.completed.response.tools.user_location.region
用户所在地区。
timezone number | 时区
response.completed.response.tools.user_location.timezone
用户所在时区。
图像处理 object
图像处理工具,让模型对图片进行画点、选区、缩放、旋转等操作。
type string | 类型
response.completed.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 image_process。
grounding object | 选区功能
response.completed.response.tools.grounding
选区/裁切功能配置,启用后模型可返回图像中目标的检测框或裁切区域坐标。
type string | 开关
response.completed.response.tools.grounding.type
功能开关。可选值:enabled、disabled。
point object | 画点功能
response.completed.response.tools.point
画点/画线功能开关。
type string | 开关
response.completed.response.tools.point.type
功能开关。可选值:enabled、disabled。
rotate object | 旋转功能
response.completed.response.tools.rotate
旋转功能开关。启用后模型可请求对图片按指定角度进行旋转。
type string | 开关
response.completed.response.tools.rotate.type
功能开关。可选值:enabled、disabled。
zoom object | 缩放功能
response.completed.response.tools.zoom
缩放功能开关,启用后模型可对图像目标区域执行缩放操作。
type string | 开关
response.completed.response.tools.zoom.type
功能开关。可选值:enabled、disabled。
MCP 工具 object
MCP(Model Context Protocol)工具,让模型调用外部 MCP Server 提供的工具。
server_label string | 服务标签
response.completed.response.tools.server_label
MCP Server 的唯一标识标签。模型在工具调用输出中通过该标签指向对应 Server,便于在多个 MCP Server 场景下区分调用来源。
server_url string | 服务地址
response.completed.response.tools.server_url
MCP Server 的 HTTP(S) 访问地址,模型通过该地址向 Server 发起工具调用请求。
type string | 类型
response.completed.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 mcp。
allowed_tools string[] / object | 允许工具
response.completed.response.tools.allowed_tools
允许模型调用的工具范围。可传工具名称字符串数组,或包含 tool_names 字段的过滤器对象。
工具名数组 string[]
直接传入允许调用的工具名称数组。
工具过滤器 object
通过过滤器对象指定允许调用的工具范围。
tool_names string[] | 工具名列表
response.completed.response.tools.allowed_tools.tool_names
允许调用的工具名称列表。
headers object | 请求头
response.completed.response.tools.headers
调用 MCP Server 时附加的 HTTP 请求头,以字符串键值对形式指定 header 名与值。
require_approval string / object | 审批策略
response.completed.response.tools.require_approval
MCP 工具调用前的审批策略;支持简单模式(字符串)或按工具粒度控制(过滤器对象)。
简单策略 string
直接传入字符串 always 或 never,对所有工具应用统一审批策略。
工具过滤器 object
通过过滤器对象按工具粒度配置审批策略。
always object | 始终审批
response.completed.response.tools.require_approval.always
始终需要审批的工具过滤器。
tool_names string[] | 工具名列表
response.completed.response.tools.require_approval.always.tool_names
始终需要审批的工具名称列表。
never object | 无需审批
response.completed.response.tools.require_approval.never
无需审批的工具过滤器。
tool_names string[] | 工具名列表
response.completed.response.tools.require_approval.never.tool_names
无需审批即可调用的工具名称列表。
server_description string | 服务描述
response.completed.response.tools.server_description
MCP Server 的描述信息,帮助模型理解何时使用该 Server。
知识库搜索 object
私域知识库搜索工具,让模型检索企业内部知识库中的文档内容。
knowledge_resource_id string | 知识库 ID
response.completed.response.tools.knowledge_resource_id
type string | 类型
response.completed.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 knowledge_search。
dense_weight number | 稠密权重
response.completed.response.tools.dense_weight
混合检索中稠密向量(语义)检索的权重,值越大越偏向语义匹配,越小越偏向关键词匹配。
取值范围:[0.2, 1]
description string | 知识库描述
response.completed.response.tools.description
知识库描述信息,帮助模型理解何时使用该知识库。
doc_filter object | 文档过滤
response.completed.response.tools.doc_filter
设置文档字段级别的检索过滤条件,确保只在符合条件的文档中检索。
limit integer | 最大结果数
response.completed.response.tools.limit
最大搜索结果数量。
取值范围:[1, 200]
max_keyword integer | 最大关键词数
response.completed.response.tools.max_keyword
最大并行搜索关键词数量。
取值范围:[1, 50]
ranking_options object | 排序选项
response.completed.response.tools.ranking_options
检索后处理选项。可参考 知识库 API 文档 post_processing 字段。
chunk_diffusion_count integer | 切片扩散数
response.completed.response.tools.ranking_options.chunk_diffusion_count
检索阶段返回命中切片的上下几片邻近切片。取 0 表示不进行 chunk diffusion。
取值范围:[0, 5]
chunk_group boolean | 文本聚合
response.completed.response.tools.ranking_options.chunk_group
文本聚合。
- 默认不聚合。
- 对于非结构化文件,可开启文本聚合以更好保留原文档内容语序。
- 开启后,会根据文档及文档顺序,对切片重新聚合排序返回。
get_attachment_link boolean | 获取附件链接
response.completed.response.tools.ranking_options.get_attachment_link
是否获取切片中图片的临时下载链接。
rerank_model string | Rerank 模型
response.completed.response.tools.ranking_options.rerank_model
rerank 模型选择。默认值:base-multilingual-rerank。取值:base-multilingual-rerank / m3-v2-rerank。
rerank_only_chunk boolean | 仅切片重排
response.completed.response.tools.ranking_options.rerank_only_chunk
是否仅根据 chunk 内容计算重排分数。true 只根据 chunk 内容计算分;false 根据 chunk title + 内容一起计算排序分。
rerank_switch boolean | 开启重排
response.completed.response.tools.ranking_options.rerank_switch
是否自动对检索结果做 rerank。若设置为 true,则会自动请求 rerank 模型排序。
retrieve_count integer | 重排切片数
response.completed.response.tools.ranking_options.retrieve_count
进入重排的切片数量。
豆包助手 object
豆包助手工具,让模型使用豆包的聊天、深度思考、AI 搜索和推理搜索能力。
feature object | 功能配置
response.completed.response.tools.feature
豆包助手的子功能配置,用于按需开启聊天、深度思考、AI 搜索、推理搜索四类能力并设置对应角色描述。
ai_search object | AI 搜索
response.completed.response.tools.feature.ai_search
AI 搜索功能配置。
role_description string | 角色描述
response.completed.response.tools.feature.ai_search.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.completed.response.tools.feature.ai_search.type
功能开关。可选值:enabled、disabled。
chat object | 普通聊天
response.completed.response.tools.feature.chat
普通聊天功能配置。
role_description string | 角色描述
response.completed.response.tools.feature.chat.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.completed.response.tools.feature.chat.type
功能开关。可选值:enabled、disabled。
deep_chat object | 深度聊天
response.completed.response.tools.feature.deep_chat
深度聊天功能配置。
role_description string | 角色描述
response.completed.response.tools.feature.deep_chat.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.completed.response.tools.feature.deep_chat.type
功能开关。可选值:enabled、disabled。
reasoning_search object | 推理搜索
response.completed.response.tools.feature.reasoning_search
推理搜索功能配置。
role_description string | 角色描述
response.completed.response.tools.feature.reasoning_search.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.completed.response.tools.feature.reasoning_search.type
功能开关。可选值:enabled、disabled。
type string | 类型
response.completed.response.tools.type
工具类型,此处固定为 doubao_app
user_location object | 用户位置
response.completed.response.tools.user_location
用户地理位置信息,用于搜索优化。
type string | 类型
response.completed.response.tools.user_location.type
位置类型。
取值固定为 approximate。
city string | 城市
response.completed.response.tools.user_location.city
用户所在城市。
country string | 国家
response.completed.response.tools.user_location.country
用户所在国家。
region string | 地区
response.completed.response.tools.user_location.region
用户所在地区。
timezone number | 时区
response.completed.response.tools.user_location.timezone
用户所在时区。
top_p number | 采样阈值
response.completed.response.top_p
本次请求实际使用的核采样概率阈值。
usage object | 用量统计
response.completed.response.usage
本次响应的 token 用量统计,包含输入、输出与总计 token 数等明细。
input_tokens integer | 输入 token 数
response.completed.response.usage.input_tokens
输入消耗的 token 数量。
input_tokens_details object | 输入明细
response.completed.response.usage.input_tokens_details
输入 token 用量明细。
cached_tokens integer | 缓存 token
response.completed.response.usage.input_tokens_details.cached_tokens
命中缓存的 token 数量。
audio_cached_tokens integer | 音频缓存 Token 数
response.completed.response.usage.input_tokens_details.audio_cached_tokens
缓存命中的音频输入内容所消耗的 token 数量。仅在隐式缓存模式且命中音频缓存时返回;开启显式缓存时该字段不返回。
audio_tokens integer | 音频 token
response.completed.response.usage.input_tokens_details.audio_tokens
音频输入消耗的 token 数量。
output_tokens integer | 输出 token 数
response.completed.response.usage.output_tokens
输出消耗的 token 数量。
output_tokens_details object | 输出明细
response.completed.response.usage.output_tokens_details
输出 token 用量明细。
reasoning_tokens integer | 思考 token
response.completed.response.usage.output_tokens_details.reasoning_tokens
深度思考消耗的 token 数量。
total_tokens integer | 总 token 数
response.completed.response.usage.total_tokens
本次请求消耗的 token 总数。
tool_usage object | 工具用量
response.completed.response.usage.tool_usage
工具调用用量统计。
doubao_app integer | 豆包次数
response.completed.response.usage.tool_usage.doubao_app
豆包助手工具调用次数。
knowledge_search integer | 知识库次数
response.completed.response.usage.tool_usage.knowledge_search
知识库搜索工具调用次数。
mcp integer | MCP 次数
response.completed.response.usage.tool_usage.mcp
MCP 工具调用次数。
web_search integer | 搜索次数
response.completed.response.usage.tool_usage.web_search
联网搜索工具调用次数。
tool_usage_details object | 工具明细
response.completed.response.usage.tool_usage_details
工具调用用量明细。
doubao_app object | 豆包明细
response.completed.response.usage.tool_usage_details.doubao_app
豆包助手工具用量明细。
knowledge_search object | 知识库明细
response.completed.response.usage.tool_usage_details.knowledge_search
知识库搜索工具用量明细。
mcp object | MCP 明细
response.completed.response.usage.tool_usage_details.mcp
MCP 工具用量明细。
web_search object | 搜索明细
response.completed.response.usage.tool_usage_details.web_search
联网搜索工具用量明细。
sequence_number integer | 序列号
response.completed.sequence_number
事件的序列号。
type string | 事件类型
response.completed.type
事件的类型,总是 response.completed
response.incomplete#
当响应以未完成状态结束时触发的事件。
response object | 响应对象
response.incomplete.response
未完成状态的响应。包含参数与非流式调用返回的参数一致。
created_at integer | 创建时间戳
response.incomplete.response.created_at
该 Response 创建时的 Unix 时间戳(单位:秒)。
id string | 响应 ID
response.incomplete.response.id
本次 Response 的唯一标识,可用于后续查询、续接或删除该响应。
model string | 模型 ID
response.incomplete.response.model
生成本次响应所使用的模型标识,回显请求中的 model 字段。
object string | 对象类型
response.incomplete.response.object
返回对象的类型标识,用于区分响应对象种类。
取值固定为 response。
output object[] | 输出内容
response.incomplete.response.output
模型本次响应产出的 Item 列表,按生成顺序排列,可能包含消息、工具调用、推理等不同类型条目。
消息输出 object
模型生成的消息输出,包含文本内容。
content object[] | 输出内容
response.incomplete.response.output.content
输出内容列表。
模型回答文本 object
模型生成的最终回答文本。
type string | 类型
response.incomplete.response.output.content.type
内容类型判别字段,用于区分 union 变体。
取值固定为 output_text。
annotations object[] | 标注列表
response.incomplete.response.output.content.annotations
文本附带的标注信息列表(如引用来源等)
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.incomplete.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.incomplete.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.incomplete.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.incomplete.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.incomplete.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.incomplete.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.incomplete.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.incomplete.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.incomplete.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.incomplete.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.incomplete.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.incomplete.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.incomplete.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.incomplete.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.incomplete.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.incomplete.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.incomplete.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.incomplete.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.incomplete.response.output.content.text
模型生成的文本内容。
模型思维链文本 object
模型生成的思维链文本。
type string | 类型
response.incomplete.response.output.content.type
内容类型标识,用于区分 union 变体。
取值固定为 reasoning_text。
annotations object[] | 标注列表
response.incomplete.response.output.content.annotations
思维链附带的标注信息列表。
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.incomplete.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.incomplete.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.incomplete.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.incomplete.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.incomplete.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.incomplete.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.incomplete.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.incomplete.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.incomplete.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.incomplete.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.incomplete.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.incomplete.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.incomplete.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.incomplete.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.incomplete.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.incomplete.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.incomplete.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.incomplete.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.incomplete.response.output.content.text
模型思维链文本内容。
id string | 条目 ID
response.incomplete.response.output.id
输出条目唯一标识。
role string | 角色
response.incomplete.response.output.role
消息发送者的角色。
取值固定为 assistant。
status string | 状态
response.incomplete.response.output.status
消息输出条目的当前状态。
completed:消息已生成完毕。in_progress:消息正在生成中(流式场景)。incomplete:消息未完整生成(例如达到max_output_tokens上限)。failed:消息生成失败。
type string | 类型
response.incomplete.response.output.type
输出条目的类型标识。
取值固定为 message。
partial boolean | 增量片段
response.incomplete.response.output.partial
是否为流式增量片段。
phase string | 消息阶段
response.incomplete.response.output.phase
标记 assistant 消息属于中间讲解还是最终回答。在回放 assistant 历史消息时,建议保留并原样回传该字段。可选值:commentary、final_answer。
函数调用输出 object
模型发起的函数调用请求。
type string | 类型
response.incomplete.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 function_call。
arguments string | 参数
response.incomplete.response.output.arguments
函数参数的 JSON 字符串。
call_id string | 调用 ID
response.incomplete.response.output.call_id
函数调用的唯一标识 ID,用于将该 function_call 输出与后续回传的 function_call_output 关联匹配。
id string | 条目 ID
response.incomplete.response.output.id
输出条目唯一标识。
name string | 函数名
response.incomplete.response.output.name
调用的函数名称。
status string | 状态
response.incomplete.response.output.status
函数调用条目的当前状态。
completed:函数调用请求已生成完毕。in_progress:函数调用请求正在生成中(流式场景)。incomplete:函数调用请求未完整生成(例如达到max_output_tokens上限)。failed:函数调用生成失败。
思维链输出 object
模型的深度思考过程输出。
status string | 状态
response.incomplete.response.output.status
推理条目的处理状态,用于判断思维链是否生成完成。可选值:completed、failed、in_progress、incomplete。
summary object[] | 推理摘要
response.incomplete.response.output.summary
推理摘要内容列表。
type string | 类型
response.incomplete.response.output.summary.type
摘要片段类型标识。
取值固定为 summary_text。
text string | 摘要文本
response.incomplete.response.output.summary.text
思维链摘要文本内容。
type string | 类型
response.incomplete.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 reasoning。
content object[] | 推理内容
response.incomplete.response.output.content
思维链推理过程的内容元素列表。
模型回答文本 object
模型生成的最终回答文本。
type string | 类型
response.incomplete.response.output.content.type
内容类型判别字段,用于区分 union 变体。
取值固定为 output_text。
annotations object[] | 标注列表
response.incomplete.response.output.content.annotations
文本附带的标注信息列表(如引用来源等)
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.incomplete.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.incomplete.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.incomplete.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.incomplete.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.incomplete.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.incomplete.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.incomplete.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.incomplete.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.incomplete.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.incomplete.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.incomplete.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.incomplete.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.incomplete.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.incomplete.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.incomplete.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.incomplete.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.incomplete.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.incomplete.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.incomplete.response.output.content.text
模型生成的文本内容。
模型思维链文本 object
模型生成的思维链文本。
type string | 类型
response.incomplete.response.output.content.type
内容类型标识,用于区分 union 变体。
取值固定为 reasoning_text。
annotations object[] | 标注列表
response.incomplete.response.output.content.annotations
思维链附带的标注信息列表。
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.incomplete.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.incomplete.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.incomplete.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.incomplete.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.incomplete.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.incomplete.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.incomplete.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.incomplete.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.incomplete.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.incomplete.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.incomplete.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.incomplete.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.incomplete.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.incomplete.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.incomplete.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.incomplete.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.incomplete.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.incomplete.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.incomplete.response.output.content.text
模型思维链文本内容。
encrypted_content string | 加密思维链
response.incomplete.response.output.encrypted_content
思考内容加密原文。经加密及压缩处理后的思考内容原文。
相关文档:
模型支持:
doubao-seed-2-0-lite-260428 及后续版本
id string | 条目 ID
response.incomplete.response.output.id
输出条目唯一标识。
语音转写输出 object
模型返回的语音转写输出。
status string | 状态
response.incomplete.response.output.status
语音转写条目的当前状态。
completed:转写已生成完毕。in_progress:转写正在生成中(流式场景)。incomplete:转写未完整生成(例如达到输出上限而截断)。failed:转写生成失败。
type string | 类型
response.incomplete.response.output.type
输出条目类型标识。
取值固定为 transcription。
id string | 条目 ID
response.incomplete.response.output.id
输出条目唯一标识。
transcription object[] | 转写内容
response.incomplete.response.output.transcription
语音转写结果片段列表。
type string | 类型
response.incomplete.response.output.transcription.type
转写片段类型。
取值固定为 transcription_text。
chunks object[] | 音频小段
response.incomplete.response.output.transcription.chunks
当前片段对应的音频小段列表。
end_time integer | 结束时间
response.incomplete.response.output.transcription.chunks.end_time
片段结束时间(毫秒)
start_time integer | 开始时间
response.incomplete.response.output.transcription.chunks.start_time
片段开始时间(毫秒)
text string | 文字内容
response.incomplete.response.output.transcription.chunks.text
当前片段对应的文字内容。
text string | 转写文本
response.incomplete.response.output.transcription.text
当前片段的转写文本。
网页搜索调用 object
模型发起的网页搜索调用记录。
id string | 条目 ID
response.incomplete.response.output.id
输出条目唯一标识。
status string | 状态
response.incomplete.response.output.status
网页搜索调用的当前状态。可选值:in_progress、searching、completed、incomplete、failed。
type string | 类型
response.incomplete.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 web_search_call。
action object | 搜索动作
response.incomplete.response.output.action
描述模型执行的网页搜索动作,包括搜索类型与查询关键字。
query string | 查询语句
response.incomplete.response.output.action.query
模型实际发起的搜索查询语句。
type string | 类型
response.incomplete.response.output.action.type
网页搜索动作的类型标识。
取值固定为 search。
queries string[] | 查询语句列表
response.incomplete.response.output.action.queries
本次网页搜索产生的查询语句列表。
图像处理调用 object
模型发起的图像处理调用记录。
id string | 条目 ID
response.incomplete.response.output.id
输出条目唯一标识。
status string | 状态
response.incomplete.response.output.status
图像处理调用的当前状态。
completed:图像处理已完成。in_progress:图像处理正在执行中。incomplete:图像处理未完整执行(例如被中断或截断)。failed:图像处理执行失败,具体原因见error字段。
type string | 类型
response.incomplete.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 image_process。
action object | 处理动作
response.incomplete.response.output.action
图像处理动作详情。
type string | 类型
response.incomplete.response.output.action.type
图像处理动作类型。
result_image_url string | 结果图地址
response.incomplete.response.output.action.result_image_url
处理后图像的 URL 地址。
arguments object | 处理参数
response.incomplete.response.output.arguments
图像处理动作的输入参数,以键值对形式承载具体处理选项。
error object | 图像处理错误
response.incomplete.response.output.error
图像处理失败时的错误信息。
message string | 错误描述
response.incomplete.response.output.error.message
错误的可读描述。
MCP 审批请求 object
MCP 工具调用前的审批请求记录。
arguments string | 调用参数
response.incomplete.response.output.arguments
工具调用参数的 JSON 字符串。
name string | 工具名
response.incomplete.response.output.name
待运行的工具名称。
server_label string | 服务标签
response.incomplete.response.output.server_label
发起请求的 MCP Server 标签。
type string | 类型
response.incomplete.response.output.type
输出项类型标识符,用于区分 OutputItem 的变体。
取值固定为 mcp_approval_request。
id string | 请求 ID
response.incomplete.response.output.id
审批请求的唯一 ID。
MCP 工具清单 object
MCP Server 提供的工具清单输出。
server_label string | 服务标签
response.incomplete.response.output.server_label
MCP Server 标签。
type string | 类型
response.incomplete.response.output.type
输出项类型标识。
取值固定为 mcp_list_tools。
error string | 错误信息
response.incomplete.response.output.error
当 MCP Server 无法返回工具列表时的错误信息。
id string | 列表 ID
response.incomplete.response.output.id
工具列表的唯一 ID。
tools object[] | 工具列表
response.incomplete.response.output.tools
该 MCP Server 上可用的工具列表。
name string | 工具名
response.incomplete.response.output.tools.name
工具名称。
annotations object | 注解信息
response.incomplete.response.output.tools.annotations
工具的附加注解信息。
description string | 工具描述
response.incomplete.response.output.tools.description
工具的功能描述。
input_schema object | 入参 Schema
response.incomplete.response.output.tools.input_schema
描述工具入参的 JSON Schema。
MCP 工具调用 object
模型对 MCP 工具的实际调用记录及结果。
name string | 工具名
response.incomplete.response.output.name
实际运行的工具名称。
server_label string | 服务标签
response.incomplete.response.output.server_label
运行工具的 MCP Server 标签。
type string | 类型
response.incomplete.response.output.type
标识该输出项为 MCP 工具调用记录。
取值固定为 mcp_call。
arguments string | 调用参数
response.incomplete.response.output.arguments
传递给 MCP 工具的调用参数,格式为 JSON 字符串。
error string | 错误信息
response.incomplete.response.output.error
工具调用失败时的错误信息。
id string | 调用 ID
response.incomplete.response.output.id
工具调用的唯一 ID。
output string | 返回结果
response.incomplete.response.output.output
工具调用的返回结果。
知识库检索调用 object
模型发起的私域知识库检索调用记录。
knowledge_resource_id string | 知识库 ID
response.incomplete.response.output.knowledge_resource_id
检索使用的知识库 ID。
queries string[] | 查询语句
response.incomplete.response.output.queries
模型实际执行的检索查询语句。
status string | 状态
response.incomplete.response.output.status
知识库检索调用的执行状态。可选值:in_progress、searching、completed、failed、incomplete。
type string | 类型
response.incomplete.response.output.type
输出条目类型标识,用于区分不同类型的输出条目。
取值固定为 knowledge_search_call。
id string | 条目 ID
response.incomplete.response.output.id
输出条目唯一标识。
豆包应用调用 object
模型对豆包助手能力的调用记录。
type string | 类型
response.incomplete.response.output.type
输出条目类型标识。
取值固定为 doubao_app_call。
blocks object[] | 内容块
response.incomplete.response.output.blocks
豆包应用调用产出的内容块列表。
文本输出 object
豆包应用产出的文本输出内容块。
type string | 类型
response.incomplete.response.output.blocks.type
内容块类型标识符。
取值固定为 output_text。
id string | 块 ID
response.incomplete.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.incomplete.response.output.blocks.parent_id
所属父级条目的 ID。
status string | 状态
response.incomplete.response.output.blocks.status
内容块状态。
text string | 文本内容
response.incomplete.response.output.blocks.text
思维链文本 object
豆包应用产出的思维链文本内容块。
type string | 类型
response.incomplete.response.output.blocks.type
内容块类型标识符。
取值固定为 reasoning_text。
id string | 块 ID
response.incomplete.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.incomplete.response.output.blocks.parent_id
所属父级条目的 ID。
reasoning_text string | 思考文本
response.incomplete.response.output.blocks.reasoning_text
思维链文本内容。
status string | 状态
response.incomplete.response.output.blocks.status
内容块状态。
搜索过程 object
豆包应用 AI 搜索过程产出的内容块。
type string | 类型
response.incomplete.response.output.blocks.type
内容块类型标识符。
取值固定为 search。
id string | 块 ID
response.incomplete.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.incomplete.response.output.blocks.parent_id
所属父级条目的 ID。
queries string[] | 查询语句
response.incomplete.response.output.blocks.queries
搜索查询语句列表。
results object[] | 搜索结果
response.incomplete.response.output.blocks.results
搜索结果列表。
text_card object | 文本卡片
response.incomplete.response.output.blocks.results.text_card
文本卡片形式的搜索结果。
sitename string | 站点名
response.incomplete.response.output.blocks.results.text_card.sitename
来源站点名称。
title string | 标题
response.incomplete.response.output.blocks.results.text_card.title
搜索结果标题。
url string | 网址
response.incomplete.response.output.blocks.results.text_card.url
搜索结果 URL 地址。
status string | 状态
response.incomplete.response.output.blocks.status
内容块状态。
summary string | 搜索总结
response.incomplete.response.output.blocks.summary
AI 搜索过程中对本轮搜索结果的总结性文字,概括从搜索结果中提取的核心信息。
推理搜索过程 object
豆包应用推理搜索过程产出的内容块。
type string | 类型
response.incomplete.response.output.blocks.type
内容块类型。
取值固定为 reasoning_search。
id string | 块 ID
response.incomplete.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.incomplete.response.output.blocks.parent_id
所属父级条目的 ID。
queries string[] | 查询语句
response.incomplete.response.output.blocks.queries
搜索查询语句列表。
results object[] | 搜索结果
response.incomplete.response.output.blocks.results
搜索结果列表。
text_card object | 文本卡片
response.incomplete.response.output.blocks.results.text_card
文本卡片形式的搜索结果。
sitename string | 站点名
response.incomplete.response.output.blocks.results.text_card.sitename
来源站点名称。
title string | 标题
response.incomplete.response.output.blocks.results.text_card.title
搜索结果标题。
url string | 网址
response.incomplete.response.output.blocks.results.text_card.url
搜索结果 URL 地址。
status string | 状态
response.incomplete.response.output.blocks.status
推理搜索内容块的处理状态。可选值:in_progress、searching、completed、incomplete、failed。
summary string | 搜索总结
response.incomplete.response.output.blocks.summary
推理搜索过程中对本轮搜索结果的总结性文字,概括从搜索结果中提取的核心信息。
feature string | 功能名
response.incomplete.response.output.feature
本次调用触发的豆包子功能名称。可选值:chat、deep_chat、ai_search、reasoning_search。
id string | 条目 ID
response.incomplete.response.output.id
输出条目唯一标识。
status string | 状态
response.incomplete.response.output.status
输出状态。可选值:completed、failed、in_progress、incomplete。
智能体工具调用 object
模型发起的智能体工具调用记录。
name string | 工具名
response.incomplete.response.output.name
被调用的智能体工具名称。
status string | 状态
response.incomplete.response.output.status
智能体工具调用的执行状态。可选值:completed、failed、in_progress、incomplete。
type string | 类型
response.incomplete.response.output.type
输出条目类型标识符,用于区分 OutputItem 的 variant。
取值固定为 agent_tool_call。
id string | 条目 ID
response.incomplete.response.output.id
输出条目唯一标识。
caching object | 缓存配置
response.incomplete.response.caching
本次响应生效的上下文缓存配置,回显请求中的 caching 设置。
prefix boolean | 仅写缓存
response.incomplete.response.caching.prefix
是否仅写入前缀缓存,不生成回复。true 只写缓存,不返回模型输出;false 正常生成回复并写缓存。
type string | 缓存模式
response.incomplete.response.caching.type
缓存模式。
enabled:开启上下文缓存。disabled:关闭上下文缓存。
context_management object | 上下文管理
response.incomplete.response.context_management
本次响应实际执行的上下文管理编辑操作,回显请求中 context_management 生效后的结果。
applied_edits object[] | 已应用编辑
response.incomplete.response.context_management.applied_edits
已应用的上下文编辑结果列表。
清理工具调用 object
已应用的清理工具调用编辑结果。
cleared_tool_uses integer | 清理次数
response.incomplete.response.context_management.applied_edits.cleared_tool_uses
已清理的工具调用数量。
type string | 类型
response.incomplete.response.context_management.applied_edits.type
编辑类型。
取值固定为 clear_tool_uses。
清理思维链 object
已应用的清理思维链编辑结果。
cleared_thinking_turns integer | 清理轮次
response.incomplete.response.context_management.applied_edits.cleared_thinking_turns
已清理的思维链轮次数量。
type string | 类型
response.incomplete.response.context_management.applied_edits.type
编辑类型。
取值固定为 clear_thinking。
error object | 错误信息
response.incomplete.response.error
模型响应过程发生错误时的错误信息。仅当 status 为 failed 时返回。
code string | 错误码
response.incomplete.response.error.code
message string | 错误描述
response.incomplete.response.error.message
错误信息的可读描述。
expire_at integer | 过期时间戳
response.incomplete.response.expire_at
响应储存的过期时刻 Unix 时间戳(秒),回显请求中的 expire_at 设置,对 store 与 caching 均生效。
incomplete_details object | 未完成详情
response.incomplete.response.incomplete_details
响应未能完成的详细信息。仅当 status 为 incomplete 时返回。
reason string | 原因
response.incomplete.response.incomplete_details.reason
响应未完成的原因。
content_filter object | 内容过滤
response.incomplete.response.incomplete_details.content_filter
内容过滤详情。
details string | 详情
response.incomplete.response.incomplete_details.content_filter.details
内容过滤命中的详细描述。
type string | 类型
response.incomplete.response.incomplete_details.content_filter.type
内容过滤命中的类型。
instructions string | 系统指令
response.incomplete.response.instructions
本次响应生效的系统指令,回显请求中的 instructions 设置。
max_output_tokens integer | 最大输出长度
response.incomplete.response.max_output_tokens
回显请求中的 max_output_tokens 参数,即模型输出最大 token 数(含回答与思维链)。
max_tool_calls integer | 最大工具调用轮次
response.incomplete.response.max_tool_calls
本次响应生效的最大工具调用轮次,回显请求中的 max_tool_calls 设置。
metadata object | 自定义元数据
response.incomplete.response.metadata
回显请求中的 metadata 键值对元数据。最多支持 16 对键值,key 长度不超过 64 个字符,value 长度不超过 512 个字符,服务端不会解释其中内容。
parallel_tool_calls boolean | 并行工具调用
response.incomplete.response.parallel_tool_calls
本次请求实际生效的并行工具调用设置,回显请求中的 parallel_tool_calls 值。
previous_response_id string | 上轮响应 ID
response.incomplete.response.previous_response_id
回显请求中的 previous_response_id,即前一轮响应的唯一标识。仅在请求传入该字段时返回。
prompt_cache_key string | 缓存分桶键
response.incomplete.response.prompt_cache_key
用于提升缓存命中率的分桶键,回显请求中的 prompt_cache_key 设置。
reasoning object | 推理配置
response.incomplete.response.reasoning
本次响应生效的深度思考工作量配置,回显请求中的 reasoning 设置。
effort string | 思考深度
response.incomplete.response.reasoning.effort
限制思考的工作量。减少思考深度可提升速度,思考花费的 token 更少。
none:关闭思考。minimal:关闭思考,直接回答。low:轻量思考,侧重快速响应。medium:均衡模式,兼顾速度与深度。high:深度分析,处理复杂问题。xhigh:更高程度思考。max:最高程度思考,适配高难度推理任务。
safety_identifier string | 安全标识
response.incomplete.response.safety_identifier
回显请求中传入的终端用户稳定标识,用于安全策略与违规行为追踪关联。
service_tier string | 推理模式
response.incomplete.response.service_tier
本次请求实际使用的推理模式。
fast:本次请求使用 在线推理(低延迟) 模式。auto:本次请求使用 在线推理(TPM 保障包) 模式。default:本次请求使用 在线推理(常规) 模式。flex:本次请求使用 在线推理(低优) 模式。
session object | 会话信息
response.incomplete.response.session
本次响应关联的会话信息,回显请求中 session 生效后的结果。
id string | 会话 ID
response.incomplete.response.session.id
会话的唯一 ID。
status string | 响应状态
response.incomplete.response.status
本次响应的当前状态,标识生成流程处于进行中、已完成、未完成或已失败等阶段。
store boolean | 是否存储
response.incomplete.response.store
是否储存生成的模型响应以供后续通过 API 检索,回显请求中的 store 设置。
temperature number | 采样温度
response.incomplete.response.temperature
本次响应生效的采样温度,回显请求中的 temperature 设置。
text object | 输出格式
response.incomplete.response.text
本次响应生效的输出格式定义,回显请求中的 text 设置。
format object | 输出格式
response.incomplete.response.text.format
文本输出格式定义。
type string | 格式类型
response.incomplete.response.text.format.type
输出格式类型。可选值:text、json_schema、json_object。
description string | 格式描述
response.incomplete.response.text.format.description
格式描述信息。
name string | 格式名称
response.incomplete.response.text.format.name
格式名称,作为 JSON Schema 输出格式的标识。
schema object | Schema 定义
response.incomplete.response.text.format.schema
JSON Schema 定义。当 type 为 json_schema 时必填。
strict boolean | 严格模式
response.incomplete.response.text.format.strict
是否严格按 JSON Schema 校验模型输出。
thinking object | 深度思考
response.incomplete.response.thinking
本次响应生效的深度思考配置,回显请求中的 thinking 设置。
type string | 思考模式
response.incomplete.response.thinking.type
深度思考模式。
enabled:开启深度思考。disabled:关闭深度思考。auto:由模型自行判断是否需要深度思考。
tool_choice string / object | 工具调用策略
response.incomplete.response.tool_choice
本次请求实际生效的工具调用策略,回显请求中的 tool_choice 设置。
简单策略 string
直接传入字符串 none、auto 或 required,控制工具调用整体策略。
指定工具 object
通过对象指定具体工具类型或工具名进行调用。
type string | 工具类型
response.incomplete.response.tool_choice.type
指定要调用的工具类型,用于精确路由到对应工具。可选值:
functionweb_searchimage_processmcpknowledge_searchdoubao_app
name string | 工具名称
response.incomplete.response.tool_choice.name
指定要调用的具体工具名,如函数名或 MCP 服务下的工具名。
tools object[] | 工具列表
response.incomplete.response.tools
本次响应生效的工具列表,回显请求中的 tools 设置。
函数调用 object
自定义函数调用(Function Calling),让模型生成结构化的函数参数。
name string | 函数名
response.incomplete.response.tools.name
供模型调用的函数名称,模型在 function_call 输出中以该名称回传,用于匹配对应函数。
type string | 类型
response.incomplete.response.tools.type
工具类型标识,用于在 union 中区分不同工具类别。
取值固定为 function。
description string | 函数描述
response.incomplete.response.tools.description
函数的描述信息,帮助模型理解何时使用该函数。
parameters object | 参数定义
response.incomplete.response.tools.parameters
函数参数定义,遵循 JSON Schema 格式。
联网搜索 object
联网搜索工具,让模型在需要时自动进行网页搜索获取实时信息。
type string | 类型
response.incomplete.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 web_search。
limit integer | 最大结果数
response.incomplete.response.tools.limit
每轮搜索最大返回结果数量。
取值范围:[1, 50]
max_keyword integer | 最大关键词数
response.incomplete.response.tools.max_keyword
最大并行搜索关键词数量。
取值范围:[1, 50]
sources string[] | 搜索来源
response.incomplete.response.tools.sources
搜索信息来源限制,指定模型可从哪些渠道检索网页内容。可选值:toutiao、douyin、moji、search_engine、doubao。
user_location object | 用户位置
response.incomplete.response.tools.user_location
用户地理位置信息,用于搜索优化。
type string | 类型
response.incomplete.response.tools.user_location.type
位置类型。
取值固定为 approximate。
city string | 城市
response.incomplete.response.tools.user_location.city
用户所在城市。
country string | 国家
response.incomplete.response.tools.user_location.country
用户所在国家。
region string | 地区
response.incomplete.response.tools.user_location.region
用户所在地区。
timezone number | 时区
response.incomplete.response.tools.user_location.timezone
用户所在时区。
图像处理 object
图像处理工具,让模型对图片进行画点、选区、缩放、旋转等操作。
type string | 类型
response.incomplete.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 image_process。
grounding object | 选区功能
response.incomplete.response.tools.grounding
选区/裁切功能配置,启用后模型可返回图像中目标的检测框或裁切区域坐标。
type string | 开关
response.incomplete.response.tools.grounding.type
功能开关。可选值:enabled、disabled。
point object | 画点功能
response.incomplete.response.tools.point
画点/画线功能开关。
type string | 开关
response.incomplete.response.tools.point.type
功能开关。可选值:enabled、disabled。
rotate object | 旋转功能
response.incomplete.response.tools.rotate
旋转功能开关。启用后模型可请求对图片按指定角度进行旋转。
type string | 开关
response.incomplete.response.tools.rotate.type
功能开关。可选值:enabled、disabled。
zoom object | 缩放功能
response.incomplete.response.tools.zoom
缩放功能开关,启用后模型可对图像目标区域执行缩放操作。
type string | 开关
response.incomplete.response.tools.zoom.type
功能开关。可选值:enabled、disabled。
MCP 工具 object
MCP(Model Context Protocol)工具,让模型调用外部 MCP Server 提供的工具。
server_label string | 服务标签
response.incomplete.response.tools.server_label
MCP Server 的唯一标识标签。模型在工具调用输出中通过该标签指向对应 Server,便于在多个 MCP Server 场景下区分调用来源。
server_url string | 服务地址
response.incomplete.response.tools.server_url
MCP Server 的 HTTP(S) 访问地址,模型通过该地址向 Server 发起工具调用请求。
type string | 类型
response.incomplete.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 mcp。
allowed_tools string[] / object | 允许工具
response.incomplete.response.tools.allowed_tools
允许模型调用的工具范围。可传工具名称字符串数组,或包含 tool_names 字段的过滤器对象。
工具名数组 string[]
直接传入允许调用的工具名称数组。
工具过滤器 object
通过过滤器对象指定允许调用的工具范围。
tool_names string[] | 工具名列表
response.incomplete.response.tools.allowed_tools.tool_names
允许调用的工具名称列表。
headers object | 请求头
response.incomplete.response.tools.headers
调用 MCP Server 时附加的 HTTP 请求头,以字符串键值对形式指定 header 名与值。
require_approval string / object | 审批策略
response.incomplete.response.tools.require_approval
MCP 工具调用前的审批策略;支持简单模式(字符串)或按工具粒度控制(过滤器对象)。
简单策略 string
直接传入字符串 always 或 never,对所有工具应用统一审批策略。
工具过滤器 object
通过过滤器对象按工具粒度配置审批策略。
always object | 始终审批
response.incomplete.response.tools.require_approval.always
始终需要审批的工具过滤器。
tool_names string[] | 工具名列表
response.incomplete.response.tools.require_approval.always.tool_names
始终需要审批的工具名称列表。
never object | 无需审批
response.incomplete.response.tools.require_approval.never
无需审批的工具过滤器。
tool_names string[] | 工具名列表
response.incomplete.response.tools.require_approval.never.tool_names
无需审批即可调用的工具名称列表。
server_description string | 服务描述
response.incomplete.response.tools.server_description
MCP Server 的描述信息,帮助模型理解何时使用该 Server。
知识库搜索 object
私域知识库搜索工具,让模型检索企业内部知识库中的文档内容。
knowledge_resource_id string | 知识库 ID
response.incomplete.response.tools.knowledge_resource_id
type string | 类型
response.incomplete.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 knowledge_search。
dense_weight number | 稠密权重
response.incomplete.response.tools.dense_weight
混合检索中稠密向量(语义)检索的权重,值越大越偏向语义匹配,越小越偏向关键词匹配。
取值范围:[0.2, 1]
description string | 知识库描述
response.incomplete.response.tools.description
知识库描述信息,帮助模型理解何时使用该知识库。
doc_filter object | 文档过滤
response.incomplete.response.tools.doc_filter
设置文档字段级别的检索过滤条件,确保只在符合条件的文档中检索。
limit integer | 最大结果数
response.incomplete.response.tools.limit
最大搜索结果数量。
取值范围:[1, 200]
max_keyword integer | 最大关键词数
response.incomplete.response.tools.max_keyword
最大并行搜索关键词数量。
取值范围:[1, 50]
ranking_options object | 排序选项
response.incomplete.response.tools.ranking_options
检索后处理选项。可参考 知识库 API 文档 post_processing 字段。
chunk_diffusion_count integer | 切片扩散数
response.incomplete.response.tools.ranking_options.chunk_diffusion_count
检索阶段返回命中切片的上下几片邻近切片。取 0 表示不进行 chunk diffusion。
取值范围:[0, 5]
chunk_group boolean | 文本聚合
response.incomplete.response.tools.ranking_options.chunk_group
文本聚合。
- 默认不聚合。
- 对于非结构化文件,可开启文本聚合以更好保留原文档内容语序。
- 开启后,会根据文档及文档顺序,对切片重新聚合排序返回。
get_attachment_link boolean | 获取附件链接
response.incomplete.response.tools.ranking_options.get_attachment_link
是否获取切片中图片的临时下载链接。
rerank_model string | Rerank 模型
response.incomplete.response.tools.ranking_options.rerank_model
rerank 模型选择。默认值:base-multilingual-rerank。取值:base-multilingual-rerank / m3-v2-rerank。
rerank_only_chunk boolean | 仅切片重排
response.incomplete.response.tools.ranking_options.rerank_only_chunk
是否仅根据 chunk 内容计算重排分数。true 只根据 chunk 内容计算分;false 根据 chunk title + 内容一起计算排序分。
rerank_switch boolean | 开启重排
response.incomplete.response.tools.ranking_options.rerank_switch
是否自动对检索结果做 rerank。若设置为 true,则会自动请求 rerank 模型排序。
retrieve_count integer | 重排切片数
response.incomplete.response.tools.ranking_options.retrieve_count
进入重排的切片数量。
豆包助手 object
豆包助手工具,让模型使用豆包的聊天、深度思考、AI 搜索和推理搜索能力。
feature object | 功能配置
response.incomplete.response.tools.feature
豆包助手的子功能配置,用于按需开启聊天、深度思考、AI 搜索、推理搜索四类能力并设置对应角色描述。
ai_search object | AI 搜索
response.incomplete.response.tools.feature.ai_search
AI 搜索功能配置。
role_description string | 角色描述
response.incomplete.response.tools.feature.ai_search.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.incomplete.response.tools.feature.ai_search.type
功能开关。可选值:enabled、disabled。
chat object | 普通聊天
response.incomplete.response.tools.feature.chat
普通聊天功能配置。
role_description string | 角色描述
response.incomplete.response.tools.feature.chat.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.incomplete.response.tools.feature.chat.type
功能开关。可选值:enabled、disabled。
deep_chat object | 深度聊天
response.incomplete.response.tools.feature.deep_chat
深度聊天功能配置。
role_description string | 角色描述
response.incomplete.response.tools.feature.deep_chat.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.incomplete.response.tools.feature.deep_chat.type
功能开关。可选值:enabled、disabled。
reasoning_search object | 推理搜索
response.incomplete.response.tools.feature.reasoning_search
推理搜索功能配置。
role_description string | 角色描述
response.incomplete.response.tools.feature.reasoning_search.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.incomplete.response.tools.feature.reasoning_search.type
功能开关。可选值:enabled、disabled。
type string | 类型
response.incomplete.response.tools.type
工具类型,此处固定为 doubao_app
user_location object | 用户位置
response.incomplete.response.tools.user_location
用户地理位置信息,用于搜索优化。
type string | 类型
response.incomplete.response.tools.user_location.type
位置类型。
取值固定为 approximate。
city string | 城市
response.incomplete.response.tools.user_location.city
用户所在城市。
country string | 国家
response.incomplete.response.tools.user_location.country
用户所在国家。
region string | 地区
response.incomplete.response.tools.user_location.region
用户所在地区。
timezone number | 时区
response.incomplete.response.tools.user_location.timezone
用户所在时区。
top_p number | 采样阈值
response.incomplete.response.top_p
本次请求实际使用的核采样概率阈值。
usage object | 用量统计
response.incomplete.response.usage
本次响应的 token 用量统计,包含输入、输出与总计 token 数等明细。
input_tokens integer | 输入 token 数
response.incomplete.response.usage.input_tokens
输入消耗的 token 数量。
input_tokens_details object | 输入明细
response.incomplete.response.usage.input_tokens_details
输入 token 用量明细。
cached_tokens integer | 缓存 token
response.incomplete.response.usage.input_tokens_details.cached_tokens
命中缓存的 token 数量。
audio_cached_tokens integer | 音频缓存 Token 数
response.incomplete.response.usage.input_tokens_details.audio_cached_tokens
缓存命中的音频输入内容所消耗的 token 数量。仅在隐式缓存模式且命中音频缓存时返回;开启显式缓存时该字段不返回。
audio_tokens integer | 音频 token
response.incomplete.response.usage.input_tokens_details.audio_tokens
音频输入消耗的 token 数量。
output_tokens integer | 输出 token 数
response.incomplete.response.usage.output_tokens
输出消耗的 token 数量。
output_tokens_details object | 输出明细
response.incomplete.response.usage.output_tokens_details
输出 token 用量明细。
reasoning_tokens integer | 思考 token
response.incomplete.response.usage.output_tokens_details.reasoning_tokens
深度思考消耗的 token 数量。
total_tokens integer | 总 token 数
response.incomplete.response.usage.total_tokens
本次请求消耗的 token 总数。
tool_usage object | 工具用量
response.incomplete.response.usage.tool_usage
工具调用用量统计。
doubao_app integer | 豆包次数
response.incomplete.response.usage.tool_usage.doubao_app
豆包助手工具调用次数。
knowledge_search integer | 知识库次数
response.incomplete.response.usage.tool_usage.knowledge_search
知识库搜索工具调用次数。
mcp integer | MCP 次数
response.incomplete.response.usage.tool_usage.mcp
MCP 工具调用次数。
web_search integer | 搜索次数
response.incomplete.response.usage.tool_usage.web_search
联网搜索工具调用次数。
tool_usage_details object | 工具明细
response.incomplete.response.usage.tool_usage_details
工具调用用量明细。
doubao_app object | 豆包明细
response.incomplete.response.usage.tool_usage_details.doubao_app
豆包助手工具用量明细。
knowledge_search object | 知识库明细
response.incomplete.response.usage.tool_usage_details.knowledge_search
知识库搜索工具用量明细。
mcp object | MCP 明细
response.incomplete.response.usage.tool_usage_details.mcp
MCP 工具用量明细。
web_search object | 搜索明细
response.incomplete.response.usage.tool_usage_details.web_search
联网搜索工具用量明细。
sequence_number integer | 序列号
response.incomplete.sequence_number
事件的序列号。
type string | 事件类型
response.incomplete.type
事件的类型,总是 response.incomplete
response.failed#
当响应失败触发的事件。
response object | 响应对象
response.failed.response
失败状态的响应。包含参数与非流式调用返回的参数一致。
created_at integer | 创建时间戳
response.failed.response.created_at
该 Response 创建时的 Unix 时间戳(单位:秒)。
id string | 响应 ID
response.failed.response.id
本次 Response 的唯一标识,可用于后续查询、续接或删除该响应。
model string | 模型 ID
response.failed.response.model
生成本次响应所使用的模型标识,回显请求中的 model 字段。
object string | 对象类型
response.failed.response.object
返回对象的类型标识,用于区分响应对象种类。
取值固定为 response。
output object[] | 输出内容
response.failed.response.output
模型本次响应产出的 Item 列表,按生成顺序排列,可能包含消息、工具调用、推理等不同类型条目。
消息输出 object
模型生成的消息输出,包含文本内容。
content object[] | 输出内容
response.failed.response.output.content
输出内容列表。
模型回答文本 object
模型生成的最终回答文本。
type string | 类型
response.failed.response.output.content.type
内容类型判别字段,用于区分 union 变体。
取值固定为 output_text。
annotations object[] | 标注列表
response.failed.response.output.content.annotations
文本附带的标注信息列表(如引用来源等)
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.failed.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.failed.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.failed.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.failed.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.failed.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.failed.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.failed.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.failed.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.failed.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.failed.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.failed.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.failed.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.failed.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.failed.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.failed.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.failed.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.failed.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.failed.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.failed.response.output.content.text
模型生成的文本内容。
模型思维链文本 object
模型生成的思维链文本。
type string | 类型
response.failed.response.output.content.type
内容类型标识,用于区分 union 变体。
取值固定为 reasoning_text。
annotations object[] | 标注列表
response.failed.response.output.content.annotations
思维链附带的标注信息列表。
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.failed.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.failed.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.failed.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.failed.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.failed.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.failed.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.failed.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.failed.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.failed.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.failed.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.failed.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.failed.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.failed.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.failed.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.failed.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.failed.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.failed.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.failed.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.failed.response.output.content.text
模型思维链文本内容。
id string | 条目 ID
response.failed.response.output.id
输出条目唯一标识。
role string | 角色
response.failed.response.output.role
消息发送者的角色。
取值固定为 assistant。
status string | 状态
response.failed.response.output.status
消息输出条目的当前状态。
completed:消息已生成完毕。in_progress:消息正在生成中(流式场景)。incomplete:消息未完整生成(例如达到max_output_tokens上限)。failed:消息生成失败。
type string | 类型
response.failed.response.output.type
输出条目的类型标识。
取值固定为 message。
partial boolean | 增量片段
response.failed.response.output.partial
是否为流式增量片段。
phase string | 消息阶段
response.failed.response.output.phase
标记 assistant 消息属于中间讲解还是最终回答。在回放 assistant 历史消息时,建议保留并原样回传该字段。可选值:commentary、final_answer。
函数调用输出 object
模型发起的函数调用请求。
type string | 类型
response.failed.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 function_call。
arguments string | 参数
response.failed.response.output.arguments
函数参数的 JSON 字符串。
call_id string | 调用 ID
response.failed.response.output.call_id
函数调用的唯一标识 ID,用于将该 function_call 输出与后续回传的 function_call_output 关联匹配。
id string | 条目 ID
response.failed.response.output.id
输出条目唯一标识。
name string | 函数名
response.failed.response.output.name
调用的函数名称。
status string | 状态
response.failed.response.output.status
函数调用条目的当前状态。
completed:函数调用请求已生成完毕。in_progress:函数调用请求正在生成中(流式场景)。incomplete:函数调用请求未完整生成(例如达到max_output_tokens上限)。failed:函数调用生成失败。
思维链输出 object
模型的深度思考过程输出。
status string | 状态
response.failed.response.output.status
推理条目的处理状态,用于判断思维链是否生成完成。可选值:completed、failed、in_progress、incomplete。
summary object[] | 推理摘要
response.failed.response.output.summary
推理摘要内容列表。
type string | 类型
response.failed.response.output.summary.type
摘要片段类型标识。
取值固定为 summary_text。
text string | 摘要文本
response.failed.response.output.summary.text
思维链摘要文本内容。
type string | 类型
response.failed.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 reasoning。
content object[] | 推理内容
response.failed.response.output.content
思维链推理过程的内容元素列表。
模型回答文本 object
模型生成的最终回答文本。
type string | 类型
response.failed.response.output.content.type
内容类型判别字段,用于区分 union 变体。
取值固定为 output_text。
annotations object[] | 标注列表
response.failed.response.output.content.annotations
文本附带的标注信息列表(如引用来源等)
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.failed.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.failed.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.failed.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.failed.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.failed.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.failed.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.failed.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.failed.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.failed.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.failed.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.failed.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.failed.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.failed.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.failed.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.failed.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.failed.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.failed.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.failed.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.failed.response.output.content.text
模型生成的文本内容。
模型思维链文本 object
模型生成的思维链文本。
type string | 类型
response.failed.response.output.content.type
内容类型标识,用于区分 union 变体。
取值固定为 reasoning_text。
annotations object[] | 标注列表
response.failed.response.output.content.annotations
思维链附带的标注信息列表。
网页引用 object
引用自互联网网页的标注信息。
title string | 标题
response.failed.response.output.content.annotations.title
引用网页的标题。
type string | 类型
response.failed.response.output.content.annotations.type
标注类型的判别字段(discriminator)。
取值固定为 url_citation。
url string | 网址
response.failed.response.output.content.annotations.url
引用网页的 URL 地址。
cover_image object | 封面图
response.failed.response.output.content.annotations.cover_image
网页封面图片信息。
height integer | 高度
response.failed.response.output.content.annotations.cover_image.height
封面图片高度(像素)
url string | 图片地址
response.failed.response.output.content.annotations.cover_image.url
封面图片的 URL 地址。
width integer | 宽度
response.failed.response.output.content.annotations.cover_image.width
封面图片宽度(像素)
freshness_info string | 新鲜度
response.failed.response.output.content.annotations.freshness_info
内容新鲜度信息。
logo_url string | Logo 地址
response.failed.response.output.content.annotations.logo_url
网站 Logo 图标地址。
mobile_url string | 移动端地址
response.failed.response.output.content.annotations.mobile_url
移动端访问地址。
publish_time string | 发布时间
response.failed.response.output.content.annotations.publish_time
网页发布时间。
site_name string | 站点名
response.failed.response.output.content.annotations.site_name
站点名称。
summary string | 摘要
response.failed.response.output.content.annotations.summary
网页内容摘要。
文档引用 object
引用自私域知识库文档的标注信息。
type string | 类型
response.failed.response.output.content.annotations.type
标注类型。
取值固定为 doc_citation。
chunk_attachment object[] | 分块附件
response.failed.response.output.content.annotations.chunk_attachment
引用分块附带的附件信息列表。
chunk_id integer | 分块 ID
response.failed.response.output.content.annotations.chunk_id
引用文档分块的 ID。
doc_id string | 文档 ID
response.failed.response.output.content.annotations.doc_id
引用文档的 ID。
doc_name string | 文档名
response.failed.response.output.content.annotations.doc_name
引用文档的名称。
text string | 文本内容
response.failed.response.output.content.text
模型思维链文本内容。
encrypted_content string | 加密思维链
response.failed.response.output.encrypted_content
思考内容加密原文。经加密及压缩处理后的思考内容原文。
相关文档:
模型支持:
doubao-seed-2-0-lite-260428 及后续版本
id string | 条目 ID
response.failed.response.output.id
输出条目唯一标识。
语音转写输出 object
模型返回的语音转写输出。
status string | 状态
response.failed.response.output.status
语音转写条目的当前状态。
completed:转写已生成完毕。in_progress:转写正在生成中(流式场景)。incomplete:转写未完整生成(例如达到输出上限而截断)。failed:转写生成失败。
type string | 类型
response.failed.response.output.type
输出条目类型标识。
取值固定为 transcription。
id string | 条目 ID
response.failed.response.output.id
输出条目唯一标识。
transcription object[] | 转写内容
response.failed.response.output.transcription
语音转写结果片段列表。
type string | 类型
response.failed.response.output.transcription.type
转写片段类型。
取值固定为 transcription_text。
chunks object[] | 音频小段
response.failed.response.output.transcription.chunks
当前片段对应的音频小段列表。
end_time integer | 结束时间
response.failed.response.output.transcription.chunks.end_time
片段结束时间(毫秒)
start_time integer | 开始时间
response.failed.response.output.transcription.chunks.start_time
片段开始时间(毫秒)
text string | 文字内容
response.failed.response.output.transcription.chunks.text
当前片段对应的文字内容。
text string | 转写文本
response.failed.response.output.transcription.text
当前片段的转写文本。
网页搜索调用 object
模型发起的网页搜索调用记录。
id string | 条目 ID
response.failed.response.output.id
输出条目唯一标识。
status string | 状态
response.failed.response.output.status
网页搜索调用的当前状态。可选值:in_progress、searching、completed、incomplete、failed。
type string | 类型
response.failed.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 web_search_call。
action object | 搜索动作
response.failed.response.output.action
描述模型执行的网页搜索动作,包括搜索类型与查询关键字。
query string | 查询语句
response.failed.response.output.action.query
模型实际发起的搜索查询语句。
type string | 类型
response.failed.response.output.action.type
网页搜索动作的类型标识。
取值固定为 search。
queries string[] | 查询语句列表
response.failed.response.output.action.queries
本次网页搜索产生的查询语句列表。
图像处理调用 object
模型发起的图像处理调用记录。
id string | 条目 ID
response.failed.response.output.id
输出条目唯一标识。
status string | 状态
response.failed.response.output.status
图像处理调用的当前状态。
completed:图像处理已完成。in_progress:图像处理正在执行中。incomplete:图像处理未完整执行(例如被中断或截断)。failed:图像处理执行失败,具体原因见error字段。
type string | 类型
response.failed.response.output.type
输出条目类型标识,用于区分 OutputItem 变体。
取值固定为 image_process。
action object | 处理动作
response.failed.response.output.action
图像处理动作详情。
type string | 类型
response.failed.response.output.action.type
图像处理动作类型。
result_image_url string | 结果图地址
response.failed.response.output.action.result_image_url
处理后图像的 URL 地址。
arguments object | 处理参数
response.failed.response.output.arguments
图像处理动作的输入参数,以键值对形式承载具体处理选项。
error object | 图像处理错误
response.failed.response.output.error
图像处理失败时的错误信息。
message string | 错误描述
response.failed.response.output.error.message
错误的可读描述。
MCP 审批请求 object
MCP 工具调用前的审批请求记录。
arguments string | 调用参数
response.failed.response.output.arguments
工具调用参数的 JSON 字符串。
name string | 工具名
response.failed.response.output.name
待运行的工具名称。
server_label string | 服务标签
response.failed.response.output.server_label
发起请求的 MCP Server 标签。
type string | 类型
response.failed.response.output.type
输出项类型标识符,用于区分 OutputItem 的变体。
取值固定为 mcp_approval_request。
id string | 请求 ID
response.failed.response.output.id
审批请求的唯一 ID。
MCP 工具清单 object
MCP Server 提供的工具清单输出。
server_label string | 服务标签
response.failed.response.output.server_label
MCP Server 标签。
type string | 类型
response.failed.response.output.type
输出项类型标识。
取值固定为 mcp_list_tools。
error string | 错误信息
response.failed.response.output.error
当 MCP Server 无法返回工具列表时的错误信息。
id string | 列表 ID
response.failed.response.output.id
工具列表的唯一 ID。
tools object[] | 工具列表
response.failed.response.output.tools
该 MCP Server 上可用的工具列表。
name string | 工具名
response.failed.response.output.tools.name
工具名称。
annotations object | 注解信息
response.failed.response.output.tools.annotations
工具的附加注解信息。
description string | 工具描述
response.failed.response.output.tools.description
工具的功能描述。
input_schema object | 入参 Schema
response.failed.response.output.tools.input_schema
描述工具入参的 JSON Schema。
MCP 工具调用 object
模型对 MCP 工具的实际调用记录及结果。
name string | 工具名
response.failed.response.output.name
实际运行的工具名称。
server_label string | 服务标签
response.failed.response.output.server_label
运行工具的 MCP Server 标签。
type string | 类型
response.failed.response.output.type
标识该输出项为 MCP 工具调用记录。
取值固定为 mcp_call。
arguments string | 调用参数
response.failed.response.output.arguments
传递给 MCP 工具的调用参数,格式为 JSON 字符串。
error string | 错误信息
response.failed.response.output.error
工具调用失败时的错误信息。
id string | 调用 ID
response.failed.response.output.id
工具调用的唯一 ID。
output string | 返回结果
response.failed.response.output.output
工具调用的返回结果。
知识库检索调用 object
模型发起的私域知识库检索调用记录。
knowledge_resource_id string | 知识库 ID
response.failed.response.output.knowledge_resource_id
检索使用的知识库 ID。
queries string[] | 查询语句
response.failed.response.output.queries
模型实际执行的检索查询语句。
status string | 状态
response.failed.response.output.status
知识库检索调用的执行状态。可选值:in_progress、searching、completed、failed、incomplete。
type string | 类型
response.failed.response.output.type
输出条目类型标识,用于区分不同类型的输出条目。
取值固定为 knowledge_search_call。
id string | 条目 ID
response.failed.response.output.id
输出条目唯一标识。
豆包应用调用 object
模型对豆包助手能力的调用记录。
type string | 类型
response.failed.response.output.type
输出条目类型标识。
取值固定为 doubao_app_call。
blocks object[] | 内容块
response.failed.response.output.blocks
豆包应用调用产出的内容块列表。
文本输出 object
豆包应用产出的文本输出内容块。
type string | 类型
response.failed.response.output.blocks.type
内容块类型标识符。
取值固定为 output_text。
id string | 块 ID
response.failed.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.failed.response.output.blocks.parent_id
所属父级条目的 ID。
status string | 状态
response.failed.response.output.blocks.status
内容块状态。
text string | 文本内容
response.failed.response.output.blocks.text
思维链文本 object
豆包应用产出的思维链文本内容块。
type string | 类型
response.failed.response.output.blocks.type
内容块类型标识符。
取值固定为 reasoning_text。
id string | 块 ID
response.failed.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.failed.response.output.blocks.parent_id
所属父级条目的 ID。
reasoning_text string | 思考文本
response.failed.response.output.blocks.reasoning_text
思维链文本内容。
status string | 状态
response.failed.response.output.blocks.status
内容块状态。
搜索过程 object
豆包应用 AI 搜索过程产出的内容块。
type string | 类型
response.failed.response.output.blocks.type
内容块类型标识符。
取值固定为 search。
id string | 块 ID
response.failed.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.failed.response.output.blocks.parent_id
所属父级条目的 ID。
queries string[] | 查询语句
response.failed.response.output.blocks.queries
搜索查询语句列表。
results object[] | 搜索结果
response.failed.response.output.blocks.results
搜索结果列表。
text_card object | 文本卡片
response.failed.response.output.blocks.results.text_card
文本卡片形式的搜索结果。
sitename string | 站点名
response.failed.response.output.blocks.results.text_card.sitename
来源站点名称。
title string | 标题
response.failed.response.output.blocks.results.text_card.title
搜索结果标题。
url string | 网址
response.failed.response.output.blocks.results.text_card.url
搜索结果 URL 地址。
status string | 状态
response.failed.response.output.blocks.status
内容块状态。
summary string | 搜索总结
response.failed.response.output.blocks.summary
AI 搜索过程中对本轮搜索结果的总结性文字,概括从搜索结果中提取的核心信息。
推理搜索过程 object
豆包应用推理搜索过程产出的内容块。
type string | 类型
response.failed.response.output.blocks.type
内容块类型。
取值固定为 reasoning_search。
id string | 块 ID
response.failed.response.output.blocks.id
内容块的唯一标识。
parent_id string | 父级 ID
response.failed.response.output.blocks.parent_id
所属父级条目的 ID。
queries string[] | 查询语句
response.failed.response.output.blocks.queries
搜索查询语句列表。
results object[] | 搜索结果
response.failed.response.output.blocks.results
搜索结果列表。
text_card object | 文本卡片
response.failed.response.output.blocks.results.text_card
文本卡片形式的搜索结果。
sitename string | 站点名
response.failed.response.output.blocks.results.text_card.sitename
来源站点名称。
title string | 标题
response.failed.response.output.blocks.results.text_card.title
搜索结果标题。
url string | 网址
response.failed.response.output.blocks.results.text_card.url
搜索结果 URL 地址。
status string | 状态
response.failed.response.output.blocks.status
推理搜索内容块的处理状态。可选值:in_progress、searching、completed、incomplete、failed。
summary string | 搜索总结
response.failed.response.output.blocks.summary
推理搜索过程中对本轮搜索结果的总结性文字,概括从搜索结果中提取的核心信息。
feature string | 功能名
response.failed.response.output.feature
本次调用触发的豆包子功能名称。可选值:chat、deep_chat、ai_search、reasoning_search。
id string | 条目 ID
response.failed.response.output.id
输出条目唯一标识。
status string | 状态
response.failed.response.output.status
输出状态。可选值:completed、failed、in_progress、incomplete。
智能体工具调用 object
模型发起的智能体工具调用记录。
name string | 工具名
response.failed.response.output.name
被调用的智能体工具名称。
status string | 状态
response.failed.response.output.status
智能体工具调用的执行状态。可选值:completed、failed、in_progress、incomplete。
type string | 类型
response.failed.response.output.type
输出条目类型标识符,用于区分 OutputItem 的 variant。
取值固定为 agent_tool_call。
id string | 条目 ID
response.failed.response.output.id
输出条目唯一标识。
caching object | 缓存配置
response.failed.response.caching
本次响应生效的上下文缓存配置,回显请求中的 caching 设置。
prefix boolean | 仅写缓存
response.failed.response.caching.prefix
是否仅写入前缀缓存,不生成回复。true 只写缓存,不返回模型输出;false 正常生成回复并写缓存。
type string | 缓存模式
response.failed.response.caching.type
缓存模式。
enabled:开启上下文缓存。disabled:关闭上下文缓存。
context_management object | 上下文管理
response.failed.response.context_management
本次响应实际执行的上下文管理编辑操作,回显请求中 context_management 生效后的结果。
applied_edits object[] | 已应用编辑
response.failed.response.context_management.applied_edits
已应用的上下文编辑结果列表。
清理工具调用 object
已应用的清理工具调用编辑结果。
cleared_tool_uses integer | 清理次数
response.failed.response.context_management.applied_edits.cleared_tool_uses
已清理的工具调用数量。
type string | 类型
response.failed.response.context_management.applied_edits.type
编辑类型。
取值固定为 clear_tool_uses。
清理思维链 object
已应用的清理思维链编辑结果。
cleared_thinking_turns integer | 清理轮次
response.failed.response.context_management.applied_edits.cleared_thinking_turns
已清理的思维链轮次数量。
type string | 类型
response.failed.response.context_management.applied_edits.type
编辑类型。
取值固定为 clear_thinking。
error object | 错误信息
response.failed.response.error
模型响应过程发生错误时的错误信息。仅当 status 为 failed 时返回。
code string | 错误码
response.failed.response.error.code
message string | 错误描述
response.failed.response.error.message
错误信息的可读描述。
expire_at integer | 过期时间戳
response.failed.response.expire_at
响应储存的过期时刻 Unix 时间戳(秒),回显请求中的 expire_at 设置,对 store 与 caching 均生效。
incomplete_details object | 未完成详情
response.failed.response.incomplete_details
响应未能完成的详细信息。仅当 status 为 incomplete 时返回。
reason string | 原因
response.failed.response.incomplete_details.reason
响应未完成的原因。
content_filter object | 内容过滤
response.failed.response.incomplete_details.content_filter
内容过滤详情。
details string | 详情
response.failed.response.incomplete_details.content_filter.details
内容过滤命中的详细描述。
type string | 类型
response.failed.response.incomplete_details.content_filter.type
内容过滤命中的类型。
instructions string | 系统指令
response.failed.response.instructions
本次响应生效的系统指令,回显请求中的 instructions 设置。
max_output_tokens integer | 最大输出长度
response.failed.response.max_output_tokens
回显请求中的 max_output_tokens 参数,即模型输出最大 token 数(含回答与思维链)。
max_tool_calls integer | 最大工具调用轮次
response.failed.response.max_tool_calls
本次响应生效的最大工具调用轮次,回显请求中的 max_tool_calls 设置。
metadata object | 自定义元数据
response.failed.response.metadata
回显请求中的 metadata 键值对元数据。最多支持 16 对键值,key 长度不超过 64 个字符,value 长度不超过 512 个字符,服务端不会解释其中内容。
parallel_tool_calls boolean | 并行工具调用
response.failed.response.parallel_tool_calls
本次请求实际生效的并行工具调用设置,回显请求中的 parallel_tool_calls 值。
previous_response_id string | 上轮响应 ID
response.failed.response.previous_response_id
回显请求中的 previous_response_id,即前一轮响应的唯一标识。仅在请求传入该字段时返回。
prompt_cache_key string | 缓存分桶键
response.failed.response.prompt_cache_key
用于提升缓存命中率的分桶键,回显请求中的 prompt_cache_key 设置。
reasoning object | 推理配置
response.failed.response.reasoning
本次响应生效的深度思考工作量配置,回显请求中的 reasoning 设置。
effort string | 思考深度
response.failed.response.reasoning.effort
限制思考的工作量。减少思考深度可提升速度,思考花费的 token 更少。
none:关闭思考。minimal:关闭思考,直接回答。low:轻量思考,侧重快速响应。medium:均衡模式,兼顾速度与深度。high:深度分析,处理复杂问题。xhigh:更高程度思考。max:最高程度思考,适配高难度推理任务。
safety_identifier string | 安全标识
response.failed.response.safety_identifier
回显请求中传入的终端用户稳定标识,用于安全策略与违规行为追踪关联。
service_tier string | 推理模式
response.failed.response.service_tier
本次请求实际使用的推理模式。
fast:本次请求使用 在线推理(低延迟) 模式。auto:本次请求使用 在线推理(TPM 保障包) 模式。default:本次请求使用 在线推理(常规) 模式。flex:本次请求使用 在线推理(低优) 模式。
session object | 会话信息
response.failed.response.session
本次响应关联的会话信息,回显请求中 session 生效后的结果。
id string | 会话 ID
response.failed.response.session.id
会话的唯一 ID。
status string | 响应状态
response.failed.response.status
本次响应的当前状态,标识生成流程处于进行中、已完成、未完成或已失败等阶段。
store boolean | 是否存储
response.failed.response.store
是否储存生成的模型响应以供后续通过 API 检索,回显请求中的 store 设置。
temperature number | 采样温度
response.failed.response.temperature
本次响应生效的采样温度,回显请求中的 temperature 设置。
text object | 输出格式
response.failed.response.text
本次响应生效的输出格式定义,回显请求中的 text 设置。
format object | 输出格式
response.failed.response.text.format
文本输出格式定义。
type string | 格式类型
response.failed.response.text.format.type
输出格式类型。可选值:text、json_schema、json_object。
description string | 格式描述
response.failed.response.text.format.description
格式描述信息。
name string | 格式名称
response.failed.response.text.format.name
格式名称,作为 JSON Schema 输出格式的标识。
schema object | Schema 定义
response.failed.response.text.format.schema
JSON Schema 定义。当 type 为 json_schema 时必填。
strict boolean | 严格模式
response.failed.response.text.format.strict
是否严格按 JSON Schema 校验模型输出。
thinking object | 深度思考
response.failed.response.thinking
本次响应生效的深度思考配置,回显请求中的 thinking 设置。
type string | 思考模式
response.failed.response.thinking.type
深度思考模式。
enabled:开启深度思考。disabled:关闭深度思考。auto:由模型自行判断是否需要深度思考。
tool_choice string / object | 工具调用策略
response.failed.response.tool_choice
本次请求实际生效的工具调用策略,回显请求中的 tool_choice 设置。
简单策略 string
直接传入字符串 none、auto 或 required,控制工具调用整体策略。
指定工具 object
通过对象指定具体工具类型或工具名进行调用。
type string | 工具类型
response.failed.response.tool_choice.type
指定要调用的工具类型,用于精确路由到对应工具。可选值:
functionweb_searchimage_processmcpknowledge_searchdoubao_app
name string | 工具名称
response.failed.response.tool_choice.name
指定要调用的具体工具名,如函数名或 MCP 服务下的工具名。
tools object[] | 工具列表
response.failed.response.tools
本次响应生效的工具列表,回显请求中的 tools 设置。
函数调用 object
自定义函数调用(Function Calling),让模型生成结构化的函数参数。
name string | 函数名
response.failed.response.tools.name
供模型调用的函数名称,模型在 function_call 输出中以该名称回传,用于匹配对应函数。
type string | 类型
response.failed.response.tools.type
工具类型标识,用于在 union 中区分不同工具类别。
取值固定为 function。
description string | 函数描述
response.failed.response.tools.description
函数的描述信息,帮助模型理解何时使用该函数。
parameters object | 参数定义
response.failed.response.tools.parameters
函数参数定义,遵循 JSON Schema 格式。
联网搜索 object
联网搜索工具,让模型在需要时自动进行网页搜索获取实时信息。
type string | 类型
response.failed.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 web_search。
limit integer | 最大结果数
response.failed.response.tools.limit
每轮搜索最大返回结果数量。
取值范围:[1, 50]
max_keyword integer | 最大关键词数
response.failed.response.tools.max_keyword
最大并行搜索关键词数量。
取值范围:[1, 50]
sources string[] | 搜索来源
response.failed.response.tools.sources
搜索信息来源限制,指定模型可从哪些渠道检索网页内容。可选值:toutiao、douyin、moji、search_engine、doubao。
user_location object | 用户位置
response.failed.response.tools.user_location
用户地理位置信息,用于搜索优化。
type string | 类型
response.failed.response.tools.user_location.type
位置类型。
取值固定为 approximate。
city string | 城市
response.failed.response.tools.user_location.city
用户所在城市。
country string | 国家
response.failed.response.tools.user_location.country
用户所在国家。
region string | 地区
response.failed.response.tools.user_location.region
用户所在地区。
timezone number | 时区
response.failed.response.tools.user_location.timezone
用户所在时区。
图像处理 object
图像处理工具,让模型对图片进行画点、选区、缩放、旋转等操作。
type string | 类型
response.failed.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 image_process。
grounding object | 选区功能
response.failed.response.tools.grounding
选区/裁切功能配置,启用后模型可返回图像中目标的检测框或裁切区域坐标。
type string | 开关
response.failed.response.tools.grounding.type
功能开关。可选值:enabled、disabled。
point object | 画点功能
response.failed.response.tools.point
画点/画线功能开关。
type string | 开关
response.failed.response.tools.point.type
功能开关。可选值:enabled、disabled。
rotate object | 旋转功能
response.failed.response.tools.rotate
旋转功能开关。启用后模型可请求对图片按指定角度进行旋转。
type string | 开关
response.failed.response.tools.rotate.type
功能开关。可选值:enabled、disabled。
zoom object | 缩放功能
response.failed.response.tools.zoom
缩放功能开关,启用后模型可对图像目标区域执行缩放操作。
type string | 开关
response.failed.response.tools.zoom.type
功能开关。可选值:enabled、disabled。
MCP 工具 object
MCP(Model Context Protocol)工具,让模型调用外部 MCP Server 提供的工具。
server_label string | 服务标签
response.failed.response.tools.server_label
MCP Server 的唯一标识标签。模型在工具调用输出中通过该标签指向对应 Server,便于在多个 MCP Server 场景下区分调用来源。
server_url string | 服务地址
response.failed.response.tools.server_url
MCP Server 的 HTTP(S) 访问地址,模型通过该地址向 Server 发起工具调用请求。
type string | 类型
response.failed.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 mcp。
allowed_tools string[] / object | 允许工具
response.failed.response.tools.allowed_tools
允许模型调用的工具范围。可传工具名称字符串数组,或包含 tool_names 字段的过滤器对象。
工具名数组 string[]
直接传入允许调用的工具名称数组。
工具过滤器 object
通过过滤器对象指定允许调用的工具范围。
tool_names string[] | 工具名列表
response.failed.response.tools.allowed_tools.tool_names
允许调用的工具名称列表。
headers object | 请求头
response.failed.response.tools.headers
调用 MCP Server 时附加的 HTTP 请求头,以字符串键值对形式指定 header 名与值。
require_approval string / object | 审批策略
response.failed.response.tools.require_approval
MCP 工具调用前的审批策略;支持简单模式(字符串)或按工具粒度控制(过滤器对象)。
简单策略 string
直接传入字符串 always 或 never,对所有工具应用统一审批策略。
工具过滤器 object
通过过滤器对象按工具粒度配置审批策略。
always object | 始终审批
response.failed.response.tools.require_approval.always
始终需要审批的工具过滤器。
tool_names string[] | 工具名列表
response.failed.response.tools.require_approval.always.tool_names
始终需要审批的工具名称列表。
never object | 无需审批
response.failed.response.tools.require_approval.never
无需审批的工具过滤器。
tool_names string[] | 工具名列表
response.failed.response.tools.require_approval.never.tool_names
无需审批即可调用的工具名称列表。
server_description string | 服务描述
response.failed.response.tools.server_description
MCP Server 的描述信息,帮助模型理解何时使用该 Server。
知识库搜索 object
私域知识库搜索工具,让模型检索企业内部知识库中的文档内容。
knowledge_resource_id string | 知识库 ID
response.failed.response.tools.knowledge_resource_id
type string | 类型
response.failed.response.tools.type
工具类型标识,用于区分 Tool 的不同变体。
取值固定为 knowledge_search。
dense_weight number | 稠密权重
response.failed.response.tools.dense_weight
混合检索中稠密向量(语义)检索的权重,值越大越偏向语义匹配,越小越偏向关键词匹配。
取值范围:[0.2, 1]
description string | 知识库描述
response.failed.response.tools.description
知识库描述信息,帮助模型理解何时使用该知识库。
doc_filter object | 文档过滤
response.failed.response.tools.doc_filter
设置文档字段级别的检索过滤条件,确保只在符合条件的文档中检索。
limit integer | 最大结果数
response.failed.response.tools.limit
最大搜索结果数量。
取值范围:[1, 200]
max_keyword integer | 最大关键词数
response.failed.response.tools.max_keyword
最大并行搜索关键词数量。
取值范围:[1, 50]
ranking_options object | 排序选项
response.failed.response.tools.ranking_options
检索后处理选项。可参考 知识库 API 文档 post_processing 字段。
chunk_diffusion_count integer | 切片扩散数
response.failed.response.tools.ranking_options.chunk_diffusion_count
检索阶段返回命中切片的上下几片邻近切片。取 0 表示不进行 chunk diffusion。
取值范围:[0, 5]
chunk_group boolean | 文本聚合
response.failed.response.tools.ranking_options.chunk_group
文本聚合。
- 默认不聚合。
- 对于非结构化文件,可开启文本聚合以更好保留原文档内容语序。
- 开启后,会根据文档及文档顺序,对切片重新聚合排序返回。
get_attachment_link boolean | 获取附件链接
response.failed.response.tools.ranking_options.get_attachment_link
是否获取切片中图片的临时下载链接。
rerank_model string | Rerank 模型
response.failed.response.tools.ranking_options.rerank_model
rerank 模型选择。默认值:base-multilingual-rerank。取值:base-multilingual-rerank / m3-v2-rerank。
rerank_only_chunk boolean | 仅切片重排
response.failed.response.tools.ranking_options.rerank_only_chunk
是否仅根据 chunk 内容计算重排分数。true 只根据 chunk 内容计算分;false 根据 chunk title + 内容一起计算排序分。
rerank_switch boolean | 开启重排
response.failed.response.tools.ranking_options.rerank_switch
是否自动对检索结果做 rerank。若设置为 true,则会自动请求 rerank 模型排序。
retrieve_count integer | 重排切片数
response.failed.response.tools.ranking_options.retrieve_count
进入重排的切片数量。
豆包助手 object
豆包助手工具,让模型使用豆包的聊天、深度思考、AI 搜索和推理搜索能力。
feature object | 功能配置
response.failed.response.tools.feature
豆包助手的子功能配置,用于按需开启聊天、深度思考、AI 搜索、推理搜索四类能力并设置对应角色描述。
ai_search object | AI 搜索
response.failed.response.tools.feature.ai_search
AI 搜索功能配置。
role_description string | 角色描述
response.failed.response.tools.feature.ai_search.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.failed.response.tools.feature.ai_search.type
功能开关。可选值:enabled、disabled。
chat object | 普通聊天
response.failed.response.tools.feature.chat
普通聊天功能配置。
role_description string | 角色描述
response.failed.response.tools.feature.chat.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.failed.response.tools.feature.chat.type
功能开关。可选值:enabled、disabled。
deep_chat object | 深度聊天
response.failed.response.tools.feature.deep_chat
深度聊天功能配置。
role_description string | 角色描述
response.failed.response.tools.feature.deep_chat.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.failed.response.tools.feature.deep_chat.type
功能开关。可选值:enabled、disabled。
reasoning_search object | 推理搜索
response.failed.response.tools.feature.reasoning_search
推理搜索功能配置。
role_description string | 角色描述
response.failed.response.tools.feature.reasoning_search.role_description
使用豆包助手时修改角色设定。默认值:你的名字是豆包,有很强的专业性。
type string | 开关
response.failed.response.tools.feature.reasoning_search.type
功能开关。可选值:enabled、disabled。
type string | 类型
response.failed.response.tools.type
工具类型,此处固定为 doubao_app
user_location object | 用户位置
response.failed.response.tools.user_location
用户地理位置信息,用于搜索优化。
type string | 类型
response.failed.response.tools.user_location.type
位置类型。
取值固定为 approximate。
city string | 城市
response.failed.response.tools.user_location.city
用户所在城市。
country string | 国家
response.failed.response.tools.user_location.country
用户所在国家。
region string | 地区
response.failed.response.tools.user_location.region
用户所在地区。
timezone number | 时区
response.failed.response.tools.user_location.timezone
用户所在时区。
top_p number | 采样阈值
response.failed.response.top_p
本次请求实际使用的核采样概率阈值。
usage object | 用量统计
response.failed.response.usage
本次响应的 token 用量统计,包含输入、输出与总计 token 数等明细。
input_tokens integer | 输入 token 数
response.failed.response.usage.input_tokens
输入消耗的 token 数量。
input_tokens_details object | 输入明细
response.failed.response.usage.input_tokens_details
输入 token 用量明细。
cached_tokens integer | 缓存 token
response.failed.response.usage.input_tokens_details.cached_tokens
命中缓存的 token 数量。
audio_cached_tokens integer | 音频缓存 Token 数
response.failed.response.usage.input_tokens_details.audio_cached_tokens
缓存命中的音频输入内容所消耗的 token 数量。仅在隐式缓存模式且命中音频缓存时返回;开启显式缓存时该字段不返回。
audio_tokens integer | 音频 token
response.failed.response.usage.input_tokens_details.audio_tokens
音频输入消耗的 token 数量。
output_tokens integer | 输出 token 数
response.failed.response.usage.output_tokens
输出消耗的 token 数量。
output_tokens_details object | 输出明细
response.failed.response.usage.output_tokens_details
输出 token 用量明细。
reasoning_tokens integer | 思考 token
response.failed.response.usage.output_tokens_details.reasoning_tokens
深度思考消耗的 token 数量。
total_tokens integer | 总 token 数
response.failed.response.usage.total_tokens
本次请求消耗的 token 总数。
tool_usage object | 工具用量
response.failed.response.usage.tool_usage
工具调用用量统计。
doubao_app integer | 豆包次数
response.failed.response.usage.tool_usage.doubao_app
豆包助手工具调用次数。
knowledge_search integer | 知识库次数
response.failed.response.usage.tool_usage.knowledge_search
知识库搜索工具调用次数。
mcp integer | MCP 次数
response.failed.response.usage.tool_usage.mcp
MCP 工具调用次数。
web_search integer | 搜索次数
response.failed.response.usage.tool_usage.web_search
联网搜索工具调用次数。
tool_usage_details object | 工具明细
response.failed.response.usage.tool_usage_details
工具调用用量明细。
doubao_app object | 豆包明细
response.failed.response.usage.tool_usage_details.doubao_app
豆包助手工具用量明细。
knowledge_search object | 知识库明细
response.failed.response.usage.tool_usage_details.knowledge_search
知识库搜索工具用量明细。
mcp object | MCP 明细
response.failed.response.usage.tool_usage_details.mcp
MCP 工具用量明细。
web_search object | 搜索明细
response.failed.response.usage.tool_usage_details.web_search
联网搜索工具用量明细。
sequence_number integer | 序列号
response.failed.sequence_number
事件的序列号。
type string | 事件类型
response.failed.type
事件的类型,总是 response.failed