数据结构

Choice

返回的回复, 支持多个

被如下接口引用：ChatCompletions。

名称	类型	描述
FinishReason	String	结束标志位，可能为 stop 或 sensitive。 stop 表示输出正常结束，sensitive 只在开启流式输出审核时会出现，表示安全审核未通过。 示例值：stop
Delta	Delta	增量返回值，流式调用时使用该字段。 注意：此字段可能返回 null，表示取不到有效值。
Message	Message	返回值，非流式调用时使用该字段。 注意：此字段可能返回 null，表示取不到有效值。

Content

可以传入多种类型的内容，如图片或文本。当前只支持传入单张图片，传入多张图片时，以第一个图片为准。

被如下接口引用：ChatCompletions。

名称	类型	必选	描述
Type	String	是	内容类型 注意： 当前只支持传入单张图片，传入多张图片时，以第一个图片为准。 注意：此字段可能返回 null，表示取不到有效值。 示例值：["text", "image_url"]
Text	String	否	当 Type 为 text 时使用，表示具体的文本内容 注意：此字段可能返回 null，表示取不到有效值。 示例值：下面图片中是哪个公司的 Logo？
ImageUrl	ImageUrl	否	当 Type 为 image_url 时使用，表示具体的图片内容 注意：此字段可能返回 null，表示取不到有效值。

Delta

返回的内容（流式返回）

被如下接口引用：ChatCompletions。

名称	类型	描述
Role	String	角色名称。 示例值：assistant
Content	String	内容详情。 示例值：你好！请问有什么我可以帮助你的吗？
ToolCalls	Array of ToolCall	模型生成的工具调用，仅 hunyuan-functioncall 模型支持 说明： 对于每一次的输出值应该以Id为标识对Type、Name、Arguments字段进行合并。 注意：此字段可能返回 null，表示取不到有效值。

EmbeddingData

Embedding 信息。

被如下接口引用：GetEmbedding。

名称	类型	描述
Embedding	Array of Float	Embedding 信息，目前为 1024 维浮点数。 注意：此字段可能返回 null，表示取不到有效值。
Index	Integer	下标，目前不支持批量，因此固定为 0。 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
Object	String	目前固定为 "embedding"。 注意：此字段可能返回 null，表示取不到有效值。 示例值：embedding

EmbeddingUsage

Token 使用计数。

被如下接口引用：GetEmbedding。

名称	类型	描述
PromptTokens	Integer	输入 Token 数。 示例值：8
TotalTokens	Integer	总 Token 数。 示例值：8

ErrorMsg

运行时异常信息。

被如下接口引用：ChatCompletions。

名称	类型	描述
Msg	String	错误提示信息。
Code	Integer	错误码。 4000 服务内部异常。 4001 请求模型超时。

ImageUrl

具体的图片内容

被如下接口引用：ChatCompletions。

名称	类型	必选	描述
Url	String	是	图片的 Url（以 http:// 或 https:// 开头） 注意：此字段可能返回 null，表示取不到有效值。 示例值：https://cloudcache.tencent-cloud.com/qcloud/ui/portal-set/build/About/images/bg-product-series_87d.png

Message

会话内容

被如下接口引用：ChatCompletions。

名称	类型	必选	描述
Role	String	是	角色，可选值包括 system、user、assistant、 tool。 示例值：user
Content	String	否	文本内容 示例值：你好！
Contents	Array of Content	否	多种类型内容（目前支持图片和文本），仅 hunyuan-vision 模型支持 注意：此字段可能返回 null，表示取不到有效值。
ToolCallId	String	否	当role为tool时传入，标识具体的函数调用 注意：此字段可能返回 null，表示取不到有效值。 示例值：call_cpv320k2c3m8fgcs8ja0
ToolCalls	Array of ToolCall	否	模型生成的工具调用，仅 hunyuan-functioncall 模型支持 注意：此字段可能返回 null，表示取不到有效值。

SearchInfo

搜索结果信息

被如下接口引用：ChatCompletions。

名称	类型	必选	描述
SearchResults	Array of SearchResult	否	搜索引文信息 注意：此字段可能返回 null，表示取不到有效值。

SearchResult

搜索引文信息

被如下接口引用：ChatCompletions。

名称	类型	必选	描述
Index	String	否	搜索引文序号 注意：此字段可能返回 null，表示取不到有效值。
Title	String	否	搜索引文标题 注意：此字段可能返回 null，表示取不到有效值。
Url	String	否	搜索引文链接 注意：此字段可能返回 null，表示取不到有效值。

Tool

用户指定模型使用的工具

被如下接口引用：ChatCompletions。

名称	类型	必选	描述
Type	String	是	工具类型，当前只支持function 示例值：function
Function	ToolFunction	是	具体要调用的function

ToolCall

模型生成的工具调用

被如下接口引用：ChatCompletions。

名称	类型	必选	描述
Id	String	是	工具调用id 示例值：call_cpv320k2c3m8fgcs8ja0
Type	String	是	工具调用类型，当前只支持function 示例值：function
Function	ToolCallFunction	是	具体的function调用

ToolCallFunction

具体的function调用

被如下接口引用：ChatCompletions。

名称	类型	必选	描述
Name	String	是	function名称 示例值：get_current_weather
Arguments	String	是	function参数，一般为json字符串 示例值：{"location":["北京","深圳"],"unit":"celsius"}

ToolFunction

function定义

被如下接口引用：ChatCompletions。

名称	类型	必选	描述
Name	String	是	function名称，只能包含a-z，A-Z，0-9，_或- 示例值：get_current_weather
Parameters	String	是	function参数，一般为json字符串
Description	String	否	function的简单描述 示例值：获取当前地点的天气

Usage

Token 数量

被如下接口引用：ChatCompletions。

名称	类型	描述
PromptTokens	Integer	输入 Token 数量。 示例值：8
CompletionTokens	Integer	输出 Token 数量。 示例值：20
TotalTokens	Integer	总 Token 数量。 示例值：28