火山方舟
火山方舟
API参考
请输入
- 文档首页
火山方舟应用(Bot) API应用(bot) API
复制全文
下载 pdf应用(bot) API
文档反馈
问问助手本文介绍方舟应用 API 的输入输出参数，供您使用接口时查阅字段含义。
请求参数
请求体
- model string 必选
- 您需要调用的应用的 ID （Bot ID），获取 Bot ID 。
- messages object[] 必选
- 到目前为止的对话组成的消息列表。不同模型支持不同类型的消息，如文本、图片等。
object
系统消息，开发人员提供的指令，模型应遵循这些指令。如模型扮演的角色或者目标等。
- messages.role string 必选
- 发送消息的角色，此处应为system。
- messages.content string / object[] 必选
- 系统信息内容。
- `string`纯文本的消息内容。`object[]`视觉理解模型等多模态模型、部分大语言模型支持此类型。文本消息部分 `object`
- messages.content.**text **`string` `必选`
- 文本消息内容部分。
- messages.content.**type **`string` `必选`
- 文本消息类型，此次应为 `text`。
- 图像消息部分 `object`
- 多模态消息中，图像内容部分。视觉理解模型支持此类型消息。
- messages.content.**image_url **`object` `必选`
- 图片消息的内容部分。
- messages.content.image_url.**url **`string` `必选`
- 支持传入图片链接或图片的Base64编码，不同模型支持图片大小略有不同，具体请参见使用说明。
- 传入图片URL：传入图片的可访问链接，推荐使用 TOS（火山引擎对象存储） 存储图片，并生成图片链接。
- 传入Base64编码：请遵循格式`data:image/<图片格式>;base64,<Base64编码>`，可见示例。
- messages.content.image_url.**detail **`string` `默认值 auto`
- 支持手动设置图片的质量，取值范围`high`、`low`、`auto`。
- `high`：高细节模式，适用于需要理解图像细节信息的场景，如对图像的多个局部信息/特征提取、复杂/丰富细节的图像理解等场景，理解更全面。
- `low`：低细节模式，适用于简单的图像分类/识别、整体内容理解/描述等场景，理解更快速。
- `auto`：默认模式，不同模型选择的模式略有不同，具体请参见理解图像的深度控制。
- messages.content.**type **`string` `必选`
- 图像消息类型，此次应为 `image_url`。
object
用户发送的消息，包含提示或附加上下文信息。
- messages.role string 必选
- 发送消息的角色，此处应为user。
- messages.content string / object[] 必选
- 用户信息内容。
- `string`大语言模型支持此类型。`object[]`视觉理解模型等多模态模型、部分大语言模型支持此类型。文本消息部分 `object`
- messages.content.**text **`string` `必选`
- 文本消息内容部分。
- messages.content.**type **`string` `必选`
- 文本消息类型，此次应为 `text`。
- 图像消息部分 `object`
- 多模态消息中，图像内容部分。视觉理解模型支持此类型消息。
- messages.content.**image_url **`object` `必选`
- 图片消息的内容部分。
- messages.content.image_url.**url **`string` `必选`
- 支持传入图片链接或图片的Base64编码，不同模型支持图片大小略有不同，具体请参见使用说明。
- 传入图片URL：传入图片的可访问链接，推荐使用 TOS（火山引擎对象存储） 存储图片，并生成图片链接。
- 传入Base64编码：请遵循格式`data:image/<图片格式>;base64,<Base64编码>`，可见示例。
- messages.content.image_url.**detail **`string / null` `默认值 auto`
- 支持手动设置图片的质量，取值范围`high`、`low`、`auto`。
- `high`：高细节模式，适用于需要理解图像细节信息的场景，如对图像的多个局部信息/特征提取、复杂/丰富细节的图像理解等场景，理解更全面。
- `low`：低细节模式，适用于简单的图像分类/识别、整体内容理解/描述等场景，理解更快速。
- `auto`：默认模式，不同模型选择的模式略有不同，具体请参见理解图像的深度控制。
- messages.content.**type **`string` `必选`
- 图像消息类型，此次应为 `image_url`。
- messages.name string
- 发送此消息的角色的姓名。用于区别同一个角色但是不同主体发送的消息。
object
模型响应用户消息而回复的消息。
说明
messages.content 与 messages.tool_calls 字段二者至少填写其一。
- messages.role string 必选
- 发送消息的角色，此处应为assistant。
- messages.content string / array
- 模型回复的消息。
- messages.tool_calls object[]
- 模型回复的工具调用信息。
- messages.tool_calls**.function **object 必选
- 模型调用工具对应的函数信息。
- messages.tool_calls**.**function.**name **string 必选
- 模型需要调用的函数名称。
- messages.tool_calls**.**function.**arguments **string 必选
- 模型生成的用于调用函数的参数，JSON 格式。
说明
模型并不总是生成有效的 JSON，并且可能会虚构出一些您的函数参数规范中未定义的参数。在调用函数之前，请在您的代码中验证这些参数是否有效。
object
模型调用工具的消息。
- messages.role string 必选
- 发送消息的角色，此处应为tool。
- messages.content string / array 必选
- 工具返回的消息。
- messages.**tool_call_id **string 必选
- 模型调用的工具的 ID。
- thinking object 默认值 {"type":"enabled"}
- 控制模型是否开启深度思考模式。默认开启深度思考模式，可以手动关闭。
属性
thinking.type string 必选
取值范围：enabled， disabled，auto。
- enabled：开启思考模式，模型一定先思考后回答。
- disabled：关闭思考模式，模型直接回答问题，不会进行思考。
- auto：自动思考模式，模型根据问题自主判断是否需要思考，简单题目直接回答。
- stream boolean / null 默认值 false
- 响应内容是否流式返回：
- false：模型生成完所有内容后一次性返回结果。
- true：按 SSE 协议逐块返回模型生成内容，并以一条 data: [DONE]消息结束。
- stream_options object / null 默认值 null
- 流式响应的选项。当 stream 为 true 时可设置 stream_options 字段。
- stream_options.include_usage boolean / null 默认值 false
- 是否包含本次请求的 token 用量统计信息。
- false：不返回 token 用量信息。
- true：在 data: [DONE] 消息之前会返回一个额外的块，此块上的 usage 字段代表整个请求的 token 用量，choices 字段为空数组。所有其他块也将包含 usage 字段，但值为 null。
- max_tokens integer / null 默认值 4096
- 模型回复最大长度（单位 token），取值范围各个模型不同，详细见模型列表。
- 输入 token 和输出 token 的总长度还受模型的上下文长度限制。
- stop string / string[] / null 默认值 null
- 模型遇到 stop 字段所指定的字符串时将停止继续生成，这个词语本身不会输出。
- 默认最多支持 4 个停止词。
- deepseek-v4-pro-ga-260813、deepseek-v4-flash-ga-260731 最多支持 16 个停止词。
- 示例：["你好", "天气"]
- frequency_penalty float / null 默认值 0
- 取值范围为 [-2.0, 2.0]。
- 频率惩罚系数。如果值为正，会根据新 token 在文本中的出现频率对其进行惩罚，从而降低模型逐字重复的可能性。
- presence_penalty float / null 默认值 0
- 取值范围为 [-2.0, 2.0]。
- 存在惩罚系数。如果值为正，会根据新 token 到目前为止是否出现在文本中对其进行惩罚，从而增加模型谈论新主题的可能性。
- temperature float / null 默认值 1
- 取值范围为 [0, 2]。
- 采样温度。控制了生成文本时对每个候选词的概率分布进行平滑的程度。。当取值为 0 时模型仅考虑对数概率最大的一个 token。
- 较高的值（如 0.8）会使输出更加随机，而较低的值（如 0.2）会使输出更加集中确定。
- 通常建议仅调整 temperature 或 top_p 其中之一，不建议两者都修改。
- top_p float / null 默认值 0.7
- 取值范围为 [0, 1]。
- 核采样概率阈值。模型会考虑概率质量在 top_p 内的 token 结果。当取值为 0 时模型仅考虑对数概率最大的一个 token。
- 0.1 意味着只考虑概率质量最高的前 10% 的 token，取值越大生成的随机性越高，取值越低生成的确定性越高。通常建议仅调整 temperature 或 top_p 其中之一，不建议两者都修改。
- logprobs boolean / null 默认值 false
- 是否返回输出 tokens 的对数概率。
- false：不返回对数概率信息。
- true：返回消息内容中每个输出 token 的对数概率。
- top_logprobs integer / null 默认值 0
- 取值范围为 [0, 20]。
- 指定每个输出 token 位置最有可能返回的 token 数量，每个 token 都有关联的对数概率。仅当 logprobs 为true 时可以设置** top_logprobs** 参数。
- logit_bias map / null 默认值 null
- 调整指定 token 在模型输出内容中出现的概率，使模型生成的内容更加符合特定的偏好。logit_bias 字段接受一个 map 值，其中每个键为词表中的 token ID（使用 tokenization 接口获取），每个值为该 token 的偏差值，取值范围为 [-100, 100]。
- -1 会减少选择的可能性，1 会增加选择的可能性；-100 会完全禁止选择该 token，100 会导致仅可选择该 token。该参数的实际效果可能因模型而异。
- { "1234": -100}
- tools object[] / null 默认值 null
- 模型可以调用的工具列表。目前仅函数作为工具被支持。用这个来提供模型可能为其生成 JSON 输入的函数列表。支持该字段的模型请参见 文档。
- tools.type string 必选
- 工具类型，当前仅支持 function。
- tools.function object 必选
- 模型可以调用的类型为function的工具列表。
- tools.function.name string 必选
- 调用的函数的名称。
- tools.function.description string 必选
- 调用的函数的描述，大模型会使用它来判断是否调用这个函数。
- tools.function.parameters object 必选
- 函数请求参数，以 JSON Schema 格式描述。具体格式请参考 JSON Schema 文档。
- metadata object / null 默认值 null
- 额外参数。
- metadata.group_chat_config object 必选
- 运行时动态传入的角色配置。
- metadata.group_chat_config.characters object[] 必选
- 群聊角色列表。
- metadata.group_chat_config.characters.name string 必选
- 群聊角色名称。
- metadata.group_chat_config.characters.system_prompt string 必选
- 群聊角色设定，用于告知应用需要扮演的角色。
- metadata.group_chat_config.characters.model_desc object 必选
- 模型说明。
- metadata.group_chat_config.characters.model_desc.endpoint_id string 必选
- 您创建的 推理接入点 ID。
- metadata.group_chat_config.description string / null 默认值 null
- 群聊场景描述，可设定群聊的主题、时间地点、事件场景、用户扮演的角色等信息。
- metadata.group_chat_config.user_name string / null 默认值 用户
- 表示“我”所扮演的角色名称 ，默认值为“用户”。
- metadata.user_info string / null 默认值 null
- 联网的智能体可使用，如查询天气场景，前端可以直接通过该字段传地点信息给模型，方便查对应地点的天气。
- 传入的信息需满足条件：可以被反序列化成 json 的字符串，并需包含 city 和 district 两个字段。
- metadata.emit_intention_signal_extra string / null 默认值 "false"
- 值是 "true" 时，会中途返回intention状态 "正在搜索"。
- metadata.target_character_name string / null 默认值 null
- 群聊Bot对话时填写，指定本次要发言的角色名，必须是存在于characters里的角色。
-
响应参数
- id string
- 本次请求的唯一标识。
- model string
- 本次请求实际使用的模型名称和版本。
- doubao 1.5 代模型的模型名称格式为 doubao-1-5-**。如调用部署doubao-1.5-pro-32k 250115模型的推理接入点，返回model字段信息doubao-1-5-pro-32k-250115。
- created integer
- 本次请求创建时间的 Unix 时间戳（秒）。
- object string
- 固定为 chat.completion。
- choices object[]
- 本次请求的模型输出内容。
- choices.**index **integer
- 当前元素在 choices 列表的索引。
- choices.**finish_reason **string
- 模型停止生成 token 的原因。取值范围：
- stop：模型输出自然结束，或因命中请求参数 stop 中指定的字段而被截断。
- length：模型输出因达到模型输出限制而被截断，有下面几种原因：
- 触发max_token限制（回答内容的长度限制）。
- 触发max_completion_tokens限制（思维链内容+回答内容的长度限制）。
- 触发context_window 限制（输入内容+思维链内容+回答内容的长度限制）。
- content_filter：模型输出被内容审核拦截。
- tool_calls：模型调用了工具。
- choices.**message **object
- 模型输出的内容。
- choices.message.**role **string
- 内容输出的角色，此处固定为 assistant。
- choices.message.**content **string
- 模型生成的消息内容。
- choices.message.**reasoning_content **string / null
- 模型处理问题的思维链内容。
- 仅深度推理模型支持返回此字段，深度推理模型请参见支持模型。
- choices.message.**tool_calls **object[] / null
- 模型生成的工具调用。
- choices.message.tool_calls.**i****d **string
- 调用的工具的 ID。
- choices.message.tool_calls.**type **string
- 工具类型，当前仅支持function。
- choices.message.tool_calls.**function **object
- 模型调用的函数。
- choices.message.tool_calls.function.**name **string
- 模型调用的函数的名称。
- choices.message.tool_calls.function.**arguments **string
- 模型生成的用于调用函数的参数，JSON 格式。
- 模型并不总是生成有效的 JSON，并且可能会虚构出一些您的函数参数规范中未定义的参数。在调用函数之前，请在您的代码中验证这些参数是否有效。
- choices.**logprobs **object / null
- 当前内容的对数概率信息。
- choices.logprobs.**content **object[] / null
- message列表中每个 content 元素中的 token 对数概率信息。
- choices.logprobs.content.**token **string
- 当前 token。
- choices.logprobs.content.**bytes **integer[] / null
- 当前 token 的 UTF-8 值，格式为整数列表。当一个字符由多个 token 组成（表情符号或特殊字符等）时可以用于字符的编码和解码。如果 token 没有 UTF-8 值则为空。
- choices.logprobs.content.**logprob **float
- 当前 token 的对数概率。
- choices.logprobs.content.**top_logprobs **object[]
- 在当前 token 位置最有可能的标记及其对数概率的列表。在一些情况下，返回的数量可能比请求参数 top_logprobs 指定的数量要少。
- choices.logprobs.content.top_logprobs.**token **string
- 当前 token。
- choices.logprobs.content.top_logprobs.**bytes **integer[] / null
- 当前 token 的 UTF-8 值，格式为整数列表。当一个字符由多个 token 组成（表情符号或特殊字符等）时可以用于字符的编码和解码。如果 token 没有 UTF-8 值则为空。
- choices.logprobs.content.top_logprobs.**logprob **float
- 当前 token 的对数概率。
- choices.**moderation_hit_type **string / null
- 模型输出文字含有敏感信息时，会返回模型输出文字命中的风险分类标签。
- 返回值及含义：
- severe_violation：模型输出文字涉及严重违规。
- violence：模型输出文字涉及激进行为。
- 注意：当前只有视觉理解模型支持返回该字段，且只有在方舟控制台接入点配置页面或者 CreateEndpoint 接口中，将内容护栏方案（ModerationStrategy）设置为基础方案（Basic）时，才会返回风险分类标签。
- bot_usage object
- 本次请求的 token 用量。
- bot_usage.**model_usage **object[]
- 本次请求不同 endpoint 的 token 消耗。
- bot_usage.model_usage**.name** string
- 调用的模型 ID。
- bot_usage.model_usage**.prompt_tokens** integer
- 输入的 prompt token 数量，包含用户输入的提示词和调用插件返回的信息。
- bot_usage.model_usage**.completion_tokens** integer
- 模型生成的 token 数量。
- bot_usage.model_usage**.total_tokens** integer
- 本次请求消耗的总 token 数量（输入 + 输出）。
- action_usage object[]
- 本次请求插件用量信息。
- action_usage.action_name string
- 插件分类名称，如 content_plugin（内容插件）等。
- action_usage.count integer
- 本次请求某插件分类插件总调用次数。
- action_details object[]
- 本次请求插件调用详情。
- action_details.name string
- 插件分类名称，如 content_plugin（内容插件）等。
- action_details.count integer
- 本次请求某插件分类中插件调用次数。
- action_details.tool_details object[]
- 某插件分类中插件调用详细信息。
- action_details.tool_details.name string
- 具体调用的工具名称。
- action_details.tool_details.input object
- 插件输入参数，调用插件的数据结构。
- action_details.tool_details.output object
- 插件输出结果，调用插件返回的数据结构。
- action_details.tool_details.created_at integer 插件调用开始时间的 Unix 时间戳（秒）。
- 插件调用开始时间。
- action_details.tool_details.completed_at integer 插件调用结束时间的 Unix 时间戳（秒）。
- 插件调用结束时间。
- metadata object / null
- 额外参数。
- metadata**.**group_chat_config object 必选
- 运行时动态传入的角色配置。
- metadata**.**group_chat_config.characters object[] 必选
- 群聊角色列表。
- metadata**.**group_chat_config.characters.name string 必选
- 群聊角色名称。
- metadata**.**group_chat_config.characters.system_prompt string 必选
- 群聊角色设定，用于告知应用需要扮演的角色。
- metadata**.**group_chat_config.characters.model_desc object 必选
- 模型说明。
- metadata**.**group_chat_config.characters.model_desc.endpoint_id string 必选
- 您创建的推理接入点ID。
- metadata**.**group_chat_config.description string / null 默认值 null
- 群聊场景描述，可设定群聊的主题、时间地点、事件场景、用户扮演的角色等信息。
- metadata**.**group_chat_config.user_name string / null 默认值 用户
- 表示“我”所扮演的角色名称 ，默认值为“用户”。
- metadata**.**user_info string / null 默认值 null
- 可以被反序列化成 json 的字符串，需要包含 city 和 district 两个字段。
- metadata**.**emit_intention_signal_extra string / null 默认值 "false"
- 值是 "true" 时，会中途返回intention状态 "正在搜索"。
- metadata**.**target_character_name string / null 默认值 null
- 群聊Bot对话时填写，指定本次要发言的角色名，必须是存在于characters里的角色。
- references object[]
- 本次请求中应用调用了插件的信息。字段参考具体见各个插件的数据结构。
- 联网插件
- id string
- 本次请求的唯一标识。
- model string
- 本次请求实际使用的模型名称和版本。
- doubao 1.5 代模型的模型名称格式为 doubao-1-5-**。如调用部署doubao-1.5-pro-32k 250115模型的推理接入点，返回model字段信息doubao-1-5-pro-32k-250115。
- created integer
- 本次请求创建时间的 Unix 时间戳（秒）。
- object string
- 固定为 chat.completion.chunk。
- choices object[]
- 本次请求的模型输出内容。
- choices.**index **integer
- 当前元素在 choices 列表的索引。
- choices.**finish_reason **string
- 模型停止生成 token 的原因。取值范围：
- stop：模型输出自然结束，或因命中请求参数 stop 中指定的字段而被截断。
- length：模型输出因达到模型输出限制而被截断，有下面几种原因：
- 触发max_token限制（回答内容的长度限制）。
- 触发max_completion_tokens限制（思维链内容+回答内容的长度限制）。
- 触发context_window 限制（输入内容+思维链内容+回答内容的长度限制）。
- content_filter：模型输出被内容审核拦截。
- tool_calls：模型调用了工具。
- choices.**delta **object
- 模型输出的增量内容。
- choices.delta.**role **string
- 内容输出的角色，此处固定为 assistant。
- choices.delta.**content **string
- 模型生成的消息内容。
- choices.delta.**reasoning_content **string / null
- 模型处理问题的思维链内容。
- 仅深度推理模型支持返回此字段，深度推理模型请参见支持模型。
- choices.delta.**tool_calls **object[] / null
- 模型调用的工具列表。
- choices.delta.tool_calls.**i****d **string
- 调用的工具的 ID。
- choices.delta.tool_calls.index integer
- 当前元素在模型调用的工具列表的索引。
- choices.delta.tool_calls.**type **string
- 工具类型，当前仅支持function。
- choices.delta.tool_calls.**function **object
- 模型调用的函数。
- choices.delta.tool_calls.function.**name **string
- 模型调用的函数的名称。
- choices.delta.tool_calls.function.**arguments **string
- 模型生成的用于调用函数的参数，JSON 格式。
- 模型并不总是生成有效的 JSON，并且可能会虚构出一些您的函数参数规范中未定义的参数。在调用函数之前，请在您的代码中验证这些参数是否有效。
- choices.**logprobs **object / null
- 当前内容的对数概率信息。
- choices.logprobs.**content **object[] / null
- message列表中每个 content 元素中的 token 对数概率信息。
- choices.logprobs.content.**token **string
- 当前 token。
- choices.logprobs.content.**bytes **integer[] / null
- 当前 token 的 UTF-8 值，格式为整数列表。当一个字符由多个 token 组成（表情符号或特殊字符等）时可以用于字符的编码和解码。如果 token 没有 UTF-8 值则为空。
- choices.logprobs.content.**logprob **float
- 当前 token 的对数概率。
- choices.logprobs.content.**top_logprobs **object[]
- 在当前 token 位置最有可能的标记及其对数概率的列表。在一些情况下，返回的数量可能比请求参数 top_logprobs 指定的数量要少。
- choices.logprobs.content.top_logprobs.**token **string
- 当前 token。
- choices.logprobs.content.top_logprobs.**bytes **integer[] / null
- 当前 token 的 UTF-8 值，格式为整数列表。当一个字符由多个 token 组成（表情符号或特殊字符等）时可以用于字符的编码和解码。如果 token 没有 UTF-8 值则为空。
- choices.logprobs.content.top_logprobs.**logprob **float
- 当前 token 的对数概率。
- choices.**moderation_hit_type **string``/ null
- 模型输出文字含有敏感信息时，会返回模型输出文字命中的风险分类标签。
- 返回值及含义：
- severe_violation：模型输出文字涉及严重违规。
- violence：模型输出文字涉及激进行为。
- 注意：当前只有视觉理解模型支持返回该字段，且只有在方舟控制台接入点配置页面或者 CreateEndpoint 接口中，将内容护栏方案（ModerationStrategy）设置为基础方案（Basic）时，才会返回风险分类标签。
- bot_usage object
- 本次请求的 token 用量。
- bot_usage.**model_usage **object[]
- 本次请求不同 endpoint 的 token 消耗。
- bot_usage.model_usage**.**name string
- 调用的模型 ID。
- bot_usage.model_usage**.**prompt_tokens integer
- 输入的 prompt token 数量，包含用户输入的提示词和调用插件返回的信息。
- bot_usage.model_usage**.**completion_tokens integer
- 模型生成的 token 数量。
- bot_usage.model_usage**.**total_tokens integer
- 本次请求消耗的总 token 数量（输入 + 输出）。
- action_usage object[]
- 本次请求插件用量信息。
- action_usage.action_name string
- 插件分类名称，如 content_plugin（内容插件）等。
- action_usage.count integer
- 本次请求某插件分类插件总调用次数。
- action_details object[]
- 本次请求插件调用详情。
- action_details.name string
- 插件分类名称，如 content_plugin（内容插件）等。
- action_details.count integer
- 本次请求某插件分类中插件调用次数。
- action_details.tool_details object[]
- 某插件分类中插件调用详细信息。
- action_details.tool_details.name string
- 具体调用的工具名称。
- action_details.tool_details.input object
- 插件输入参数，调用插件的数据结构。
- action_details.tool_details.output object
- 插件输出结果，调用插件返回的数据结构。
- action_details.tool_details.created_at integer
- 插件调用开始时间。
- action_details.tool_details.completed_at integer
- 插件调用结束时间。
- metadata object / null
- 额外参数。
- metadata**.**group_chat_config object 必选
- 运行时动态传入的角色配置。
- metadata**.**group_chat_config.characters object[] 必选
- 群聊角色列表。
- metadata**.**group_chat_config.characters.name string 必选
- 群聊角色名称。
- metadata**.**group_chat_config.characters.system_prompt string 必选
- 群聊角色设定，用于告知应用需要扮演的角色。
- metadata**.**group_chat_config.characters.model_desc object 必选
- 模型说明。
- metadata**.**group_chat_config.characters.model_desc.endpoint_id string 必选
- 您创建的推理接入点ID。
- metadata**.**group_chat_config.description string / null 默认值 null
- 群聊场景描述，可设定群聊的主题、时间地点、事件场景、用户扮演的角色等信息。
- metadata**.**group_chat_config.user_name string / null 默认值 用户
- 表示“我”所扮演的角色名称 ，默认值为“用户”。
- metadata**.**user_info string / null 默认值 null
- 可以被反序列化成 json 的字符串，需要包含 city 和 district 两个字段。
- metadata**.**emit_intention_signal_extra string / null 默认值 "false"
- 值是 "true" 时，会中途返回intention状态 "正在搜索"。
- metadata**.**target_character_name string / null 默认值 null
- 群聊Bot对话时填写，指定本次要发言的角色名，必须是存在于characters里的角色。
- references object[]
- 本次请求中应用调用了插件的信息。字段参考具体见各个插件的数据结构。
- 联网插件
联网应用
单轮对话
多轮对话
流式响应
群聊
视觉理解
Request
cURL
curl https://ark.cn-beijing.volces.com/api/v3/bots/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $ARK_API_KEY" \
-d $'{
"messages": [
{
"content": "杭州今天天气",
"role": "user"
}
],
"model": "bot-20250407225237-6xv7r"
}'Response
{
"id": "02174410213780126458cc51545801ff6ffb59c94a55dae86c43b",
"choices": [
{
"finish_reason": "stop",
"index": 0,
"message": {
"content": "以下是杭州今天（2025年4月8日）的天气情况：\n- **整体天气状况**：今天多云，偏南风3级。\n- **气温情况**：白天最高气温31度，平均相对湿度55%。\n- **空气质量**：杭州市区AQI为90 - 110，首要污染物是O₃，空气质量等级为良 - 轻度污染，易感人群需减少户外锻炼。 ",
"role": "assistant"
}
}
],
"created": 1744102143,
"model": "doubao-1-5-pro-32k-250115",
"object": "chat.completion",
"bot_usage": {
"model_usage": [
{
"name": "doubao-1-5-pro-32k-250115",
"prompt_tokens": 1960,
"completion_tokens": 99,
"total_tokens": 2059
}
],
"action_usage": [
{
"action_name": "content_plugin",
"count": 1
}
],
"action_details": [
{
"name": "content_plugin",
"count": 1,
"tool_details": [
{
"name": "search",
"input": {
"queries": [
"杭州今天天气"
],
"source_type": [
"search_engine"
],
"offset": 0,
"count": 5,
"account_id": 2100000825,
"video_token": ""
},
"output": {
"type": "tool",
"data": {
"status_code": 200,
"data": {
"has_more": true,
"results": [
{
"id": "3ba8807eabf8793d-65e575422f8ebfb2",
"source_type": "search_engine",
"site_name": "搜索引擎-中国天气",
"title": "【杭州天气预报15天_杭州天气预报15天查询】-中国天气网",
"summary": "20/8℃ 东北风<3级 北风<3级 19/7℃ 东风<3级 南风<3级 26/12℃ 东风<3级 西风<3级 20/8℃ 东北风<3级 北风<3级 19/7℃ 东风<3级 南风<3级 26/12℃ 东风<3级 西风<3级",
"publish_time": 0,
"url": "https://m.weather.com.cn/mweather15d/101210101.shtml#!/abighis",
"cover_image": null,
"search_plugin_data": {
"doc_id": "3ba8807eabf8793d-65e575422f8ebfb2",
"logo_url": "https://p3-search.byteimg.com/img/labis/dafd663cfa3b7fce9addcca7916010cb~noop.jpeg",
"auth_info": "非常权威",
"auth_score": 1,
"rel_info": "强相关",
"rel_score": 0.994623,
"freshness_info": "非常满足时效需求",
"freshness_score": 0.994948,
"final_ref": "",
"final_ref_len": 0,
"author_name": "",
"duration": 0
},
"smart_content_data": null,
"ruyi_data": null
},
...
{
"id": "d4d70607487f997f-b2adf6b6d837f126",
"source_type": "search_engine",
"site_name": "搜索引擎-www.hzqx.com",
"title": "杭州天气",
"summary": "杭州国家基准气候站发布 25.7℃ 较昨日同期 高2.8℃ 相对湿度：40 % 风力： 东南2级 气压： 1012.1 hPa 近1小时降水:0 mm 能见度：22652 m *实时数据、未经人工复核 杭州市气象台4月8日8时50分发布的市区天气预报：\n今天多云；明天多云转阴，傍晚到夜里局部有阵雨；后天阴转多云。今天偏南风3级。今天白天最高气温31度，明天白天最高气温32度，明天早晨最低气温21度，今天平均相对湿度55%。2025年04月08日 08时50分 过去24小时 主城区 未来7天天气客观预报（该预报数据为数值预报自动输出，未经人工订正，仅供参考） 白天 08时 | 20时 夜晚 昨天20时 | 当天08时 今天 明天 周四 周五 周六 周日 周一 04/08 04/09 04/10 04/11 04/12 04/13 04/14 多云 多云 晴 多云 多云 晴 晴 晴 多云 晴 大雨 晴 晴 东风 东南风 东北风 东风 北风 西南风 东北风 不超过3级 ≤3级 ≤3级 ≤3级 ≤3级 ≤3级 ≤3级 31.7℃ 32.2℃ 32.2℃ 31.2℃ 19.4℃ 25.2℃ 27.3℃ 17.6℃ 19.4℃ 21.5℃ 19.3℃ 17.7℃ 11.2℃ 14.7℃ * 白天为当天08时到20时，通常气温为最高温度； 夜晚为昨天20时到当天08时，通常气温为最低温度。杭州市当前气温2025-04-08 10:30 分布图 今日生活气象 空气质量预报 杭州市环境监测站和杭州市气象台 联合发布 4月8日杭州市区AQI:90-110，首要污染物:O3，空气质量等级:良-轻度污染。易感人群减少户外锻炼。4月9日杭州市区AQI:80-100，首要污染物:O3，空气质量等级:良。",
"publish_time": 1744079400,
"url": "https://www.hzqx.com/hztq/index.html",
"cover_image": null,
"search_plugin_data": {
"doc_id": "d4d70607487f997f-b2adf6b6d837f126",
"logo_url": "",
"auth_info": "非常权威",
"auth_score": 0.875495,
"rel_info": "强相关",
"rel_score": 0.834824,
"freshness_info": "非常满足时效需求",
"freshness_score": 0.994948,
"final_ref": "",
"final_ref_len": 0,
"author_name": "",
"duration": 0
},
"smart_content_data": null,
"ruyi_data": null
}
],
"debug_data": {
"extra": null
},
"log_id": "02174410213780126458cc51545801ff6ffb59c94a55dae86c43b",
"timing": {
"total": 1431
}
}
}
},
"created_at": 1744102137810,
"completed_at": 1744102139264
}
]
}
]
},
"metadata": {},
"references": [
{
"url": "https://m.weather.com.cn/mweather15d/101210101.shtml#!/abighis",
"logo_url": "https://p3-search.byteimg.com/img/labis/dafd663cfa3b7fce9addcca7916010cb~noop.jpeg",
"site_name": "搜索引擎-中国天气",
"title": "【杭州天气预报15天_杭州天气预报15天查询】-中国天气网",
"summary": "20/8℃ 东北风<3级 北风<3级 19/7℃ 东风<3级 南风<3级 26/12℃ 东风<3级 西风<3级 20/8℃ 东北风<3级 北风<3级 19/7℃ 东风<3级 南风<3级 26/12℃ 东风<3级 西风<3级",
"publish_time": "1970年01月01日 08:00:00(CST) 星期四",
"extra": {
"rel_info": "强相关",
"freshness_info": "非常满足时效需求",
"auth_info": "非常权威",
"final_ref": ""
}
},
...
{
"url": "https://www.hzqx.com/hztq/index.html",
"logo_url": "",
"site_name": "搜索引擎-www.hzqx.com",
"title": "杭州天气",
"summary": "杭州国家基准气候站发布 25.7℃ 较昨日同期 高2.8℃ 相对湿度：40 % 风力： 东南2级 气压： 1012.1 hPa 近1小时降水:0 mm 能见度：22652 m *实时数据、未经人工复核 杭州市气象台4月8日8时50分发布的市区天气预报：\n今天多云；明天多云转阴，傍晚到夜里局部有阵雨；后天阴转多云。今天偏南风3级。今天白天最高气温31度，明天白天最高气温32度，明天早晨最低气温21度，今天平均相对湿度55%。2025年04月08日 08时50分 过去24小时 主城区 未来7天天气客观预报（该预报数据为数值预报自动输出，未经人工订正，仅供参考） 白天 08时 | 20时 夜晚 昨天20时 | 当天08时 今天 明天 周四 周五 周六 周日 周一 04/08 04/09 04/10 04/11 04/12 04/13 04/14 多云 多云 晴 多云 多云 晴 晴 晴 多云 晴 大雨 晴 晴 东风 东南风 东北风 东风 北风 西南风 东北风 不超过3级 ≤3级 ≤3级 ≤3级 ≤3级 ≤3级 ≤3级 31.7℃ 32.2℃ 32.2℃ 31.2℃ 19.4℃ 25.2℃ 27.3℃ 17.6℃ 19.4℃ 21.5℃ 19.3℃ 17.7℃ 11.2℃ 14.7℃ * 白天为当天08时到20时，通常气温为最高温度； 夜晚为昨天20时到当天08时，通常气温为最低温度。杭州市当前气温2025-04-08 10:30 分布图 今日生活气象 空气质量预报 杭州市环境监测站和杭州市气象台 联合发布 4月8日杭州市区AQI:90-110，首要污染物:O3，空气质量等级:良-轻度污染。易感人群减少户外锻炼。4月9日杭州市区AQI:80-100，首要污染物:O3，空气质量等级:良。",
"publish_time": "2025年04月08日 10:30:00(CST) 星期二",
"extra": {
"rel_info": "强相关",
"freshness_info": "非常满足时效需求",
"auth_info": "非常权威",
"final_ref": ""
}
}
]
}最近更新时间：2026.09.14 14:17:40
这个页面对您有帮助吗？
有用
有用
无用
无用