跳到主要内容

Response 对象

创建模型响应查询模型响应后,模型会返回一个 Response 对象。本文为您介绍 Response 对象包含的详细参数。

说明

Response 对象包含模型的输出内容,包括模型回答、思维链(如果启用了深度思考模式)以及工具调用信息。

基础字段

字段类型说明
idstring本次请求的唯一标识。
objectstring对象类型,固定为 response
created_atinteger本次请求创建时间的 Unix 时间戳(秒)。
modelstring本次请求实际使用的模型名称和版本。
statusstring生成响应的状态。可选值:
  • in_progress:响应中
  • completed:响应已完成
  • incomplete:响应未完成
  • failed:响应失败

请求配置字段

字段类型说明
instructionsstring/null在模型上下文中插入一条系统(或开发者)消息,作为首项。当与 previous_response_id 一起使用时,前一响应中的指令不会延续到下一响应。
previous_response_idstring/null本次请求时传入的历史响应 ID。
max_output_tokensinteger/null可生成的最大 token 数上限,不包括思考 token。
temperaturefloat/null采样温度。
top_pfloat/null核采样概率阈值。

功能控制字段

字段类型说明
thinkingobject/null是否开启深度思考模式。包含 type 字段,取值范围:
  • enabled:开启思考模式,模型一定先思考后回答
  • disabled:关闭思考模式,模型直接回答问题,不会进行思考
  • auto:自动思考模式,模型根据问题自主判断是否需要思考,简单题目直接回答
storeboolean是否存储生成的模型响应,以便后续通过 API 检索。
  • true:存储当前模型响应,对话内容能被后续的 API 检索到
  • false:不存储,对话内容不能被后续的 API 检索到
默认值:true
cachingobject是否开启缓存。包含 type 字段,取值范围:
  • enabled:开启缓存
  • disabled:关闭缓存
expire_atinteger/null存储的有效期,Unix 时间戳(秒)。
service_tierstring本次请求是否使用了 TPM 保障包。
  • default:本次请求未使用 TPM 保障包额度

输出字段

output

模型的输出消息列表,包含模型响应本次请求生成的回答、思维链、工具调用。

类型array

输出项可以是以下类型之一:

模型回答(message)

模型回答,不包含思维链。

字段类型说明
typestring输出消息的类型,固定为 message
idstring此回答的唯一标识。
rolestring输出信息的角色,固定为 assistant
statusstring输出消息的状态。
contentarray输出消息的内容。

content 字段说明

文本回答(output_text)
字段类型说明
typestring模型回答的类型,固定为 output_text
textstring模型回答的文本内容。

示例

JSON
{
"type": "message",
"id": "msg_001",
"role": "assistant",
"status": "completed",
"content": [
{
"type": "output_text",
"text": "融云 AI API 服务是一个强大的人工智能接口平台..."
}
]
}

模型思维链(reasoning)

本次请求,当触发深度思考时,模型会返回问题拆解的思维链内容。

字段类型说明
typestring本输出对象的类型,固定为 reasoning
idstring本思维链消息的唯一标识。
statusstring本次思维链内容返回的状态。
summaryarray思维链内容。

summary 字段说明

字段类型说明
typestring对象的类型,固定为 summary_text
textstring思维链内容的文本部分。

示例

JSON
{
"type": "reasoning",
"id": "reason_001",
"status": "completed",
"summary": [
{
"type": "summary_text",
"text": "用户询问融云 AI API 的主要功能,需要系统性地介绍其核心能力。首先应该说明这是一个 AI 服务平台,然后列举主要功能模块,包括多模型支持、工具调用、多轮对话等特性..."
}
]
}

工具调用(function_call)

本次请求,模型根据信息认为需要调用的工具信息以及对应参数。

字段类型说明
typestring工具调用的类型,固定为 function_call
idstring本次输出的唯一标识。
call_idstring本次工具调用信息的唯一 ID。
namestring要运行的函数的名称。
argumentsstring要传递给函数的参数,格式为 JSON 字符串。
statusstring此时消息返回的状态。

示例

JSON
{
"type": "function_call",
"id": "call_001",
"call_id": "call_abc123",
"name": "get_weather",
"arguments": "{\"city\":\"北京\"}",
"status": "completed"
}

输出格式字段

text

用于定义输出的格式,可以是纯文本,也可以是结构化的 JSON 数据。

类型object

text.format

指定模型必须输出的格式的对象。

自然语言输出(text)

模型回复以自然语言输出。

字段类型说明
typestring回复格式的类型,固定为 text

示例

JSON
{
"text": {
"format": {
"type": "text"
}
}
}
JSON 模式(json_object)

响应格式为 JSON 对象。

字段类型说明
typestring回复格式的类型,固定为 json_object

示例

JSON
{
"text": {
"format": {
"type": "json_object"
}
}
}

工具字段

tools

模型可以调用的工具列表。

类型array

tools.function

模型可以调用的类型为 function 的工具列表。

字段类型说明
typestring工具调用的类型,固定为 function
namestring调用的函数的名称。
descriptionstring调用的函数的描述,大模型会使用它来判断是否调用这个函数。
parametersobject函数请求参数,以 JSON Schema 格式描述。格式如下:

parameters 格式

JSON
{
"type": "object",
"properties": {
"参数名": {
"type": "string | number | boolean | object | array",
"description": "参数说明"
}
},
"required": ["必填参数"]
}
提示
  • 所有字段名大小写敏感
  • parameters 须是合规的 JSON Schema 对象
  • 建议用英文字段名,中文置于 description 字段中

示例

JSON
{
"tools": [
{
"type": "function",
"function": {
"name": "get_weather",
"description": "获取指定城市的天气信息",
"parameters": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "城市名称"
}
},
"required": ["city"]
}
}
}
]
}

使用统计字段

usage

本次请求的 token 用量,包括输入 token 数量、输入 token 的详细分解、输出 token 数量、输出 token 的详细分解,以及总共使用的 token 数。如果使用了工具,还会输出使用的工具类型和次数,以及工具的使用详情。

类型object

字段类型说明
input_tokensinteger输入的 token 量。
output_tokensinteger输出的 token 量。
total_tokensinteger消耗 token 的总量。
input_tokens_detailsobject输入 token 的详细信息。
output_tokens_detailsobject输出 token 的详细信息。
tool_usageobject使用工具的信息。
tool_usage_detailsobject使用工具的详细信息。

input_tokens_details

字段类型说明
cached_tokensinteger缓存 token 的数量。

output_tokens_details

字段类型说明
reasoning_tokensinteger思考用 token 的数量。

tool_usage

字段类型说明
web_searchinteger调用网络搜索工具的数量。
image_processinteger调用图像处理工具的数量。
mcpinteger调用 MCP 工具的数量。

tool_usage_details

web_search 详情
JSON
{
"tool_usage_details": {
"web_search": {
"toutiao": 1,
"moji": 1,
"search_engine": 1
}
}
}
image_process 详情
JSON
{
"tool_usage_details": {
"image_process": {
"zoom": 1,
"point": 1,
"grounding": 1
}
}
}
mcp 详情
JSON
{
"tool_usage_details": {
"mcp": {
"mcp_server_tos": 1,
"mcp_server_tls": 1
}
}
}

完整示例

JSON
{
"usage": {
"input_tokens": 100,
"output_tokens": 200,
"total_tokens": 300,
"input_tokens_details": {
"cached_tokens": 50
},
"output_tokens_details": {
"reasoning_tokens": 30
},
"tool_usage": {
"web_search": 1,
"image_process": 0,
"mcp": 0
},
"tool_usage_details": {
"web_search": {
"search_engine": 1
}
}
}
}

错误字段

error

模型未能生成响应时返回的错误对象。

类型object/null

字段类型说明
codestring相应的错误码。
messagestring错误描述。

示例

JSON
{
"error": {
"code": "rate_limit_exceeded",
"message": "请求频率超过限制,请稍后重试"
}
}

incomplete_details

响应未能完成的细节。

类型object/null

字段类型说明
reasonstring响应未能完成的原因。

完整 Response 对象示例

JSON
{
"created_at": 1754571504,
"id": "resp_0217******",
"max_output_tokens": 32768,
"model": "Doubao/Doubao-seed-1.6",
"object": "response",
"output": [
{
"id": "rs_0217******",
"type": "reasoning",
"summary": [
{
"type": "summary_text",
"text": "用户询问融云 AI API 服务的主要功能和特点,需要系统性地介绍其核心能力。首先,应该明确这是一个什么样的服务平台,它的定位是什么。融云 AI API 是一个人工智能接口平台,主要用于提供大语言模型的调用能力。\n\n接下来,需要梳理其主要功能特性。从技术角度看,应该包括以下几个方面:\n\n1. 模型支持:支持多种大语言模型,目前主要支持 Doubao 系列模型,包括标准版、思考版和快速版,满足不同场景的需求。\n\n2. 核心功能:包括文本生成、多轮对话、工具调用(Function Calling)、联网搜索、图像处理等能力,可以处理复杂的 AI 应用场景。\n\n3. 技术特性:支持流式输出、缓存机制、深度思考模式、结构化输出(JSON Schema)等高级特性,提升性能和用户体验。\n\n4. 集成能力:提供标准的 RESTful API 接口,支持多种编程语言接入,方便开发者快速集成到自己的应用中。\n\n5. 应用场景:适用于智能客服、内容生成、知识问答、代码辅助、数据分析等多种场景。\n\n现在组织语言,按照逻辑顺序清晰地介绍融云 AI API 服务的主要功能和优势。"
}
],
"status": "completed"
},
{
"type": "message",
"role": "assistant",
"content": [
{
"type": "output_text",
"text": "融云 AI API 服务是一个强大的人工智能接口平台,提供多种大语言模型的调用能力。以下是其主要功能和特点:\n\n## 核心功能\n\n### 1. 多模型支持\n- **Doubao/Doubao-seed-1.6**:标准版模型,适用于通用对话场景\n- **Doubao/Doubao-seed-1.6-thinking**:思考版模型,支持深度推理和复杂问题解决\n- **Doubao/Doubao-seed-1.6-flash**:快速版模型,响应速度更快,适合实时交互场景\n\n### 2. 丰富的功能特性\n- **多轮对话**:通过 `previous_response_id` 参数实现上下文连贯的多轮对话\n- **工具调用**:支持 Function Calling、联网搜索、图像处理、私域知识库检索等多种工具\n- **流式输出**:支持流式返回,实时获取模型生成内容\n- **结构化输出**:支持 JSON Schema 格式化输出,便于数据处理\n- **缓存机制**:智能缓存技术,降低重复请求的 Token 消耗\n- **深度思考**:可选的深度推理模式,提升复杂问题的解答质量\n\n### 3. 灵活的接口设计\n- 提供标准的 RESTful API 接口\n- 支持自定义参数(temperature、top_p)控制生成效果\n- 灵活的输入格式,支持文本、图片、视频等多模态内容\n- 完善的错误处理和状态管理机制\n\n### 4. 广泛的应用场景\n- 智能客服与对话机器人\n- 内容创作与文案生成\n- 知识问答与信息检索\n- 代码生成与编程辅助\n- 数据分析与报告生成\n\n融云 AI API 服务致力于为开发者提供简单易用、功能强大的 AI 能力,助力各类 AI 应用的快速开发和部署。"
}
],
"status": "completed",
"id": "msg_0217******"
}
],
"thinking": {
"type": "enabled"
},
"service_tier": "default",
"status": "completed",
"usage": {
"input_tokens": 88,
"output_tokens": 650,
"total_tokens": 738,
"input_tokens_details": {
"cached_tokens": 0
},
"output_tokens_details": {
"reasoning_tokens": 280
}
},
"caching": {
"type": "disabled"
},
"store": true,
"expire_at": 1754830704
}