model

String

是

-

您创建的推理接入点（Endpoint）ID。该推理接入点需部署了视觉理解的模型，如Doubao-vision-pro-32k模型。

如无推理接入点，请参考创建推理接入点（Endpoint）文档创建。

ep-202406040*****-*****

messages

Array of MessageParam

是

-

由目前为止的对话组成的消息列表，包含用户输入的最后一条消息。

-

stream

Boolean

否

false

响应内容是否流式返回

• false：模型生成完所有内容后一次性返回结果
• true：按 SSE 协议逐块返回模型生成内容，并以一条 data: [DONE] 消息结束

false

stream_options

Array ofStreamOptionsParam

否

-

流式响应的选项。仅当 stream: true 时可以设置 stream_options 参数。

-

max_tokens

Integer

否

4096

4096

stop

String or Array

否

-

模型遇到 stop 字段所指定的字符串时将停止继续生成，这个词语本身不会输出。最多支持 4 个字符串。

["你好", "天气"]

temperature

Float

否

1

采样温度。控制了生成文本时对每个候选词的概率分布进行平滑的程度。取值范围为 [0, 1]。
较高的值（如 0.8）会使输出更加随机，而较低的值（如 0.2）会使输出更加集中确定。
通常建议仅调整 temperature 或 top_p 其中之一，不建议两者都修改。

0.8

top_p

Float

否

0.7

核采样概率阈值。模型会考虑概率质量在 top_p 内的 token 结果。取值范围为 [0, 1]，取值越大生成的随机性越高，取值越低生成的确定性越高。
举例来说，当取值为 0.1 时，模型仅考虑按照概率大小排序前列（token按照概率由大到小排序，累加概率达到阈值10%，即top_p=0.1）的 token，随机取一个作为输出。
通常建议仅调整 temperature 或 top_p 其中之一，不建议两者都修改。

0.8

logprobs

Boolean

否

false

是否返回输出 token 的对数概率。

• false：不返回对数概率信息。
• true：返回消息内容中每个输出 token 的对数概率。

false

top_logprobs

Integer

否

0

指定每个输出 token 位置最有可能返回的 token 数量，每个 token 都有关联的对数概率。仅当 logprobs: true 时可以设置 top_logprobs 参数，取值范围为 [0, 20]。

2

logit_bias

Map<String, Integer>

否

-

调整指定 token 在模型输出内容中出现的概率，使模型生成的内容更加符合特定的偏好。logit_bias 字段接受一个 map 值，其中每个键为词表中的 token ID（使用 tokenization 接口获取），每个值为该 token 的偏差值，取值范围为 [-100, 100]。
-1 会减少选择的可能性，1 会增加选择的可能性；-100 会完全禁止选择该 token，100 会导致仅可选择该 token。该参数的实际效果可能因模型而异。

{
    "1234": -100
}

-

role

String

是

发出该消息的对话参与者的角色，此处应设置为 system。

content

String

否

系统消息
用于指定模型的角色或交代背景信息。如果设置系统消息，请放在messages列表的第一位。

[
  {
    "role": "system",
    "content": "You are a helpful assistant."
  },
]

role

String

是

发出该消息的对话参与者的角色，此处应设置为 user 。

content

-

Array

是

视觉理解模型请求的消息内容，消息发送角色为用户。

• 示例：多图像输入
• 示例： Base64 编码输入

type

String

是

• text 或 image_url，传入的信息类型。
  • 传入信息为文本信息设置为text。
  • 传入信息为图片信息设置为image_url。

text

String

条件必填

• 当tpye设置为text时，输入文本信息。

[
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "你叫什么",
        },
      ],
    }
  ]

image_url

Object

是

图片信息。

• url[String]：必选，支持传入图片链接或图片的Base64编码，不同模型支持图片大小略有不同，具体请参见使用说明。
  • 传入图片URL。
  • 传入Base64编码：请遵循格式data:image/<图片格式>;base64,<Base64编码>，完整示例请参见Base64编码输入。
    • <图片格式>：图片的格式
    • <Base64编码>：图片的Base64编码。
• detail[String]：可选，支持手动设置图片的质量，取值范围high、low、auto。
  • high：高细节模式，适用于需要理解图像细节信息的场景，如对图像的多个局部信息/特征提取、复杂/丰富细节的图像理解等场景，理解更全面。
  • low：低细节模式，适用于简单的图像分类/识别、整体内容理解/描述等场景，理解更快速。
  • auto：默认模式，不同模型选择的模式略有不同，具体请参见理解图像的深度控制。

更多配置建议，请参见使用说明。

role

String

是

发出该消息的对话参与者的角色，此处应设置为 assistant。

content

String

是

模型的消息回复。

[
  {
    "role": "assistant",
    "content": "Hello, can i help you with something?"
  },
]

include_usage

Boolean

否

false

是否包含本次请求的 token 用量统计信息

• false：不返回 token 用量信息
• true：在 data: [DONE] 消息之前返回一个额外的块，此块上的 usage 字段代表整个请求的 token 用量，choices 字段为空数组。所有其他块也将包含 usage 字段，但值为 null。

false

id

-

String

一次 chat completion 接口调用的唯一标识。

choices

-

Array

本次 chat 结果列表。长度固定为 1。

index

Integer

该元素在 choices 列表的索引。

message

Object

模型输出的消息内容。

finish_reason

String

模型生成结束原因：

• stop：正常生成结束。
• length 触发最大 token 数量而结束。
• content_filter ：模型输出被内容审核拦截。

logprobs

Object

该输出结果的概率信息，其只有一个 content 字段，类型为 Array，表示 message 列表中每个元素 content token 的概率信息。
content 元素子字段说明如下：

• token [String]: 对应 token。
• logprob [Number]：token 的概率。
• bytes [Array]：表示 token 的 UTF-8 字节表示的整数列表。在字符由多个 token 表示，并且它们的字节表示必须组合以生成正确的文本表示的情况下（表情符号或特殊字符）非常有用。如果 token 没有 byte 表示，则可以为空。
• top_logprobs [Array]：最可能的 token 列表及其在此 token 位置的对数概率：
  • token [String]: 对应 token；
  • logprob [Number]：token 的概率；
  • bytes [Array]：表示 token 的 UTF-8 字节表示的整数列表。在字符由多个 token 表示，并且它们的字节表示必须组合以生成正确的文本表示的情况下（表情符号或特殊字符）非常有用。如果 token 没有 byte 表示，则可以为空。

moderation_hit_type

String

模型输出文字含有敏感信息时，会返回该字段，表示模型输出文字命中的风险分类标签。
当前返回值的取值范围：

• severe_violation：模型输出文字涉及严重违规
• violence：模型输出文字涉及激进行为

注意：只有在方舟控制台接入点配置页面或者 CreateEndpoint 接口中，将内容护栏方案（ModerationStrategy）设置为基础方案（Basic）时，才会返回风险分类标签。

created

-

Integer

本次对话生成的时间戳（秒）。

model

-

String

实际使用的模型名称和版本。

object

-

String

固定为 chat.completion。

usage

-

Object

本次请求的 token 用量。

prompt_tokens

Integer

本次请求中输入的 token 数量。

completion_tokens

Integer

模型生成的 token 数量。

total_tokens

Integer

总的 token 数量。

prompt_tokens_details

Object

本接口暂不支持上下文缓存，此时返回应为"cached_tokens": 0。

prompt_tokens中命中上下文缓存的tokens数。需要模型支持，且开通上下文缓存功能，并创建缓存才会启用，详细见上下文缓存（Context API）概述。

"prompt_tokens_details": {
    "cached_tokens": 0
    }

id

-

String

一次 chat completion 接口调用的唯一标识，一次流式调用所有的 chunk 有相同的 id。

choices

-

Array

结果列表。长度固定为 1。如果设置了stream_options: {"include_usage": true}，则最后一个 chunk 的 choices 也为空列表。

index

Integer

该元素在 choices 列表的索引。

delta

Object

由流式模型响应的模型输出增量，示例如下。

{
  "role": "assistant",
  "content": " there",
}

finish_reason

String

模型生成结束原因，stop表示正常生成结束，length 表示已经到了生成的最大 token 数量，content_filter 表示模型输出命中审核提前终止。

logprobs

Object

该输出结果的概率信息，其只有一个 content 字段，类型为 array，表示 message 列表中每个元素 content token 的概率信息，content 元素子字段说明如下：

• token [String]: 对应 token；
• logprob [Number]：token 的概率；
• bytes [Array]：表示 token 的 UTF-8 字节表示的整数列表。在字符由多个 token 表示，并且它们的字节表示必须组合以生成正确的文本表示的情况下（表情符号或特殊字符）非常有用。如果 token 没有 byte 表示，则可以为空。
• top_logprobs [Array]：最可能的 token 列表及其在此 token 位置的对数概率：
  • token [String]: 对应 token；
  • logprob [Number]：token 的概率；
  • bytes [Array]：表示 token 的 UTF-8 字节表示的整数列表。在字符由多个 token 表示，并且它们的字节表示必须组合以生成正确的文本表示的情况下（表情符号或特殊字符）非常有用。如果 token 没有 byte 表示，则可以为空。

moderation_hit_type

String

模型输出文字含有敏感信息时，会返回该字段，表示模型输出文字命中的风险分类标签。
当前返回值的取值范围：

• severe_violation：模型输出文字涉及严重违规
• violence：模型输出文字涉及激进行为

注意：只有在方舟控制台接入点配置页面或者 CreateEndpoint 接口中，将内容护栏方案（ModerationStrategy）设置为基础方案（Basic）时，才会返回风险分类标签。

created

-

Integer

本次对话生成时间戳（秒）。

model

-

String

实际使用的模型名称和版本。

object

-

String

固定为 chat.completion.chunk。

usage

-

Object

本次请求的 token 用量。
一个可选字段，仅当在请求中设置stream_options: {"include_usage": true}时才会出现。如果设置了它，除了最后一个 chunk 包含整个请求的 token 使用量外，其它 chunk 的 usage 都是 null。

prompt_tokens

Integer

本次请求中输入的 token 数量。

completion_tokens

Integer

模型生成的 token 数量。

total_tokens

Integer

总的 token 数量。

prompt_tokens_details

Object

本接口暂不支持上下文缓存，此时返回应为"cached_tokens": 0。

prompt_tokens中命中上下文缓存的tokens数。需要模型支持，且开通上下文缓存功能，并创建缓存才会启用，详细见上下文缓存（Context API）概述。

"prompt_tokens_details": {
    "cached_tokens": 0
}

400

BadRequest

SensitiveContentDetected

The request failed because the input text may contain sensitive information.

输入文本可能包含敏感信息，请您使用其他 prompt

400

BadRequest

SensitiveContentDetected.SevereViolation

The request failed because the input text may contain severe violation information.

输入文本可能包含严重违规相关信息，请您使用其他 prompt

400

BadRequest

SensitiveContentDetected.Violence

The request failed because the input text may contain violence information.

输入文本可能包含激进行为相关信息，请您使用其他 prompt