Choice
返回的回复, 支持多个。
被如下接口引用：ChatCompletions。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Message | OutputMessage | 否 | 返回的回复。 |
Chunk
切片对象信息
被如下接口引用：ChunkDocument。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Index | Integer | 否 | chunk索引。切片顺序 id。 示例值：0 |
| Content | String | 否 | chunk内容。 示例值：今天天气很好 |
ChunkConfig
文档分片配置
被如下接口引用：ChunkDocument。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MaxChunkSize | Integer | 否 | 最大分片长度 示例值：4800 |
| Delimiters | Array of String | 否 | 分隔符列表 示例值：["\n\n", "\n", "。", "！", "？", "，", ""] |
| ChunkOverlap | Integer | 否 | 相邻切片重合字符数，需要小于分片长度 示例值：4000 |
ChunkConfigAsync
文档切片异步任务
被如下接口引用：ChunkDocumentAsync。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MaxChunkSize | Integer | 否 | 最大分片长度 示例值：4800 |
ChunkDocument
切片文档信息
被如下接口引用：ChunkDocument。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FileType | String | 否 | 文件类型，支持 MD，TXT 格式。 示例值：TXT |
| FileContent | String | 否 | 文本原文，使用字符串格式输入。 示例值：hello,world |
Document
文档信息
被如下接口引用：ChunkDocumentAsync, ParseDocumentAsync。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FileType | String | 是 | 支持的文件类型：PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、 XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、 IM、PCX、PPM、TIFF、XBM、HEIF、JP2 文档解析支持的文件大小： -PDF、DOC、DOCX、PPT、PPTX支持100M -MD、TXT、XLS、XLSX、CSV支特10M -其他支持20M 文本切片支持的文件大小： -PDF最大300M -D0CX、D0C、PPT、PPTX最大200M -TXT、MD最大10M -其他最大20M 示例值：DOC |
| FileUrl | String | 否 | 文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，使用腾讯云COS 文件地址。 示例值：https://example.com/example.pdf |
| FileContent | String | 否 | 文件的 base64 值，携带 MineType前缀信息。编码后的后的文件不超过 10M。 支持的文件大小：所下载文件经Base64编码后不超过 8M。文件下载时间不超过3秒。 支持的图片像素：单边介于20-10000px之间。 示例值：data:text/plain;base64,SGVsbG8sIFdvcmxkIQ== |
| FileName | String | 否 | 文件名称，当使用 base64上传的时候使用。 示例值：example.txt |
| FileStartPageNumber | Integer | 否 | 文档的起始页码 示例值：1 |
| FileEndPageNumber | Integer | 否 | 文档的结束页码 示例值：1 |
DocumentChunkUsage
文档切片用量
被如下接口引用：GetDocumentChunkResult。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PageNumber | Integer | 否 | 解析页面数量 示例值：1 |
| TotalTokens | Integer | 否 | 消耗 token数量 示例值：1 |
DocumentParseConfig
文档解析配置
被如下接口引用：ParseDocument。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ImageResponseType | Integer | 否 | 0:图片以链接形式返回 1:返回图片中提取的文本内容 示例值：1 |
EmbeddingData
向量内容
被如下接口引用：GetMultiModalEmbedding, GetTextEmbedding。
| 名称 | 类型 | 描述 |
|---|---|---|
| Embedding | Array of Float | embedding 内容 注意：此字段可能返回 null，表示取不到有效值。 示例值：[3.234,13.4556] |
| Index | Integer | 索引序号 注意：此字段可能返回 null，表示取不到有效值。 示例值：3 |
Message
会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
被如下接口引用：ChatCompletions。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Role | String | 否 | 角色，可选值包括 system、user、assistant、 tool。 示例值：user |
| Content | String | 否 | 具体文本内容 示例值：请问如何访问腾讯云官网？ |
| ToolCallId | String | 否 | 当role为tool时传入，标识具体的函数调用 示例值：call_cq16e7k2c3m1v |
| ToolCalls | Array of ToolCall | 否 | 模型生成的工具调用 |
MultiModalEmbeddingData
多模态特征向量
被如下接口引用：GetMultiModalEmbedding。
| 名称 | 类型 | 描述 |
|---|---|---|
| TextEmbeddings | Array of EmbeddingData | 文本特征向量 注意：此字段可能返回 null，表示取不到有效值。 |
| ImageEmbeddings | Array of EmbeddingData | 图片特征向量 注意：此字段可能返回 null，表示取不到有效值。 |
MultiModalUsage
多模态向量化消耗tokens和images数量
被如下接口引用：GetMultiModalEmbedding。
| 名称 | 类型 | 描述 |
|---|---|---|
| TotalTokens | Integer | 消耗tokens 示例值：100 |
| TotalImages | Integer | 输入图片数量 示例值：2 |
OnlineSearchOptions
联网搜索选项。
被如下接口引用：ChatCompletions。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Engine | String | 否 | 搜索引擎。支持 bing 和 sogou。 示例值：bing |
OutputMessage
会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
被如下接口引用：ChatCompletions。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Role | String | 否 | 角色 示例值：user |
| Content | String | 否 | 文本内容 示例值：深圳今天的天气是晴转多云。 |
| ReasoningContent | String | 否 | 推理内容 示例值：用户询问天气，需要联网搜索结果。 |
| ToolCalls | Array of ToolCall | 否 | 模型生成的工具调用 |
PageUsage
消耗页数
被如下接口引用：GetDocumentParseResult, ParseDocument。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TotalPages | Integer | 否 | 消耗总页数 示例值：1 |
ParseDocument
文档信息
被如下接口引用：ParseDocument。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FileType | String | 是 | 支持的文件类型：PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、 XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、 IM、PCX、PPM、TIFF、XBM、HEIF、JP2 文档解析支持的文件大小： -PDF、DOC、DOCX、PPT、PPTX支持100M -MD、TXT、XLS、XLSX、CSV支特10M -其他支持20M 文本切片支持的文件大小： -PDF最大300M -D0CX、D0C、PPT、PPTX最大200M -TXT、MD最大10M -其他最大20M 示例值：PDF |
| FileUrl | String | 否 | 文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，使用腾讯云COS 文件地址。 示例值：https://example.com/example.pdf |
| FileContent | String | 否 | 文件的 base64 值，携带 MineType前缀信息。编码后的后的文件不超过 10M。 支持的文件大小：所下载文件经Base64编码后不超过 8M。文件下载时间不超过3秒。 支持的图片像素：单边介于20-10000px之间。 文件的 FileUrl、FileContent必须提供一个，如果都提供只使用 FileUrl。 示例值：data:text/plain;base64,SGVsbG8sIFdvcmxkIQ== |
| DocumentParseConfig | DocumentParseConfig | 否 | 文档解析配置 |
| FileStartPageNumber | Integer | 否 | 文档的起始页码 示例值：1 |
| FileEndPageNumber | Integer | 否 | 文档的结束页码 示例值：1 |
RerankResult
输出结果
被如下接口引用：RunRerank。
| 名称 | 类型 | 描述 |
|---|---|---|
| Index | Integer | 对应的doc在输入候选doc数组中的位置索引值 注意：此字段可能返回 null，表示取不到有效值。 示例值：4 |
| RelevanceScore | Float | 相似度分数 注意：此字段可能返回 null，表示取不到有效值。 示例值：43.2 |
| Document | String | doc原文内容 注意：此字段可能返回 null，表示取不到有效值。 示例值：今天天气怎样 |
TokenUsage
token使用量
被如下接口引用：ChatCompletions。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PromptTokens | Integer | 否 | 表示prompt的tokens数，多次返回中保持不变 示例值：324 |
| CompletionTokens | Integer | 否 | 回答的token总数，在流式返回中，表示到目前为止所有completion的tokens总数，多次返回中持续累加 示例值：309 |
| TotalTokens | Integer | 否 | 表示prompt_tokens和completion_tokens之和 示例值：633 |
Tool
用户指定模型使用的工具
被如下接口引用：ChatCompletions。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 工具类型，当前只支持function 示例值：function |
| Function | ToolFunction | 是 | 具体要调用的function |
ToolCall
模型生成的工具调用
被如下接口引用：ChatCompletions。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | String | 否 | 工具调用id 示例值：call_cpv320k2c3m8fgcs8ja0 |
| Type | String | 否 | 工具调用类型，当前只支持function 示例值：function |
| Function | ToolCallFunction | 否 | 具体的function调用 |
| Index | Integer | 否 | 索引值 示例值：0 |
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字符串 示例值：{"type":"object","properties":{"location":{"type":"string","description":"The city and state, e.g. San Francisco, CA"}},"required":["location","unit"]} |
| Description | String | 否 | function的简单描述 示例值：获取当前地点的天气 |
Usage
token消耗总数
被如下接口引用：ChunkDocument, GetTextEmbedding, RunRerank。
| 名称 | 类型 | 描述 |
|---|---|---|
| TotalTokens | Integer | tokens总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：32 |
WebContent
搜索结果网页信息。
被如下接口引用：ChatCompletions。
| 名称 | 类型 | 描述 |
|---|---|---|
| Query | String | 搜素问题 示例值：今天 深圳 天气 2025 |
| Title | String | 标题 示例值：标题 |
| Url | String | 链接 示例值：https://example.com |
| Time | String | 时间 示例值：16小时前 |
| Content | String | 网页内容 示例值：深圳龙岗，今日小雨。 |
| ChunkIndex | String | 切片索引 示例值：0 |
| Score | String | 分数 示例值：0 |
