tencent cloud

APIs

文档APIsLLM Knowledge Engine Basic APIData Types

数据结构

下载
聚焦模式
字号
最后更新时间： 2026-06-04 20:17:37

ChatUsage

消耗量

被如下接口引用：ChatCompletions。

名称 类型 描述
PromptTokens Integer 输入token数
CompletionTokens Integer 输出token数
TotalTokens Integer 总token数

Choice

返回的回复, 支持多个

被如下接口引用：ChatCompletions。

名称 类型 描述
FinishReason String 结束标志位，可能为 stop、 content_filter。
stop 表示输出正常结束。
content_filter 只在开启流式输出审核时会出现，表示安全审核未通过。
Delta Delta 增量返回值，流式调用时使用该字段。
Message Message 返回值，非流式调用时使用该字段。
Index Integer 索引值，流式调用时使用该字段。

CreateReconstructDocumentFlowConfig

创建智能文档解析任务的配置信息

被如下接口引用：CreateReconstructDocumentFlow。

名称 类型 必选 描述
TableResultType String 否

Markdown文件中表格返回的形式
0，表格以MD形式返回
1，表格以HTML形式返回
默认为0
ResultType String 否

智能文档解析返回结果的格式
0：只返回全文MD；
1：只返回每一页的OCR原始Json；
2：只返回每一页的MD，
3：返回全文MD + 每一页的OCR原始Json；
4：返回全文MD + 每一页的MD
5: 返回全文md，每一页ocr原始json，每一页md
默认值为0
IgnoreFailedPage Boolean 否

是否忽略失败页，返回已成功的页数据。默认为true。
ReturnPageFormat Boolean 否

Markdown文件中是否包含页码信息
PageFormat String 否

自定义输出页码样式,{{p}}为页码占位符，开启ReturnPageFormat生效。未填默认样式:page {{p}}

CreateSplitDocumentFlowConfig

创建智能文档拆分任务的配置信息

被如下接口引用：CreateSplitDocumentFlow。

名称 类型 必选 描述
EnableMllm Boolean 否

是否开启mllm
MaxChunkSize Integer 否

最大分片长度
IgnoreFailedPage Boolean 否

是否忽略返回失败页码
SplitResultType String 否

智能文档解析返回结果的格式
0：只返回全文MD；
1：只返回每一页的OCR原始Json；
2：只返回每一页的MD；
3：返回全文MD + 每一页的OCR原始Json；
4：返回全文MD + 每一页的MD；
5：返回全文md，每一页ocr原始json，每一页md。
SplitTableResultType String 否

Markdown文件中表格返回的形式
0，表格以MD形式返回
1，表格以HTML形式返回
默认为
ReturnPageFormat Boolean 否

Markdown文件中是否包含页码信息
PageFormat String 否

自定义输出页码样式,{{p}}为页码占位符，开启ReturnPageFormat生效。未填默认样式:page {{p}}

Delta

返回的内容

被如下接口引用：ChatCompletions。

名称 类型 描述
Role String 角色名称。
Content String 内容详情。
ReasoningContent String 思维链内容。 ReasoningConent参数仅支持出参，且只有deepseek-r1模型会返回。

DocumentUsage

文档拆分任务的用量

被如下接口引用：GetReconstructDocumentResult, GetSplitDocumentResult。

名称 类型 描述
PageNumber Integer 文档拆分任务的页数
TotalTokens Integer 文档拆分任务消耗的总token数
SplitTokens Integer 拆分消耗的token数
MllmTokens Integer mllm消耗的token数
SuccessPageNum Integer 解析成功页数
FailPageNum Integer 解析失败页数
FileSize Integer 文件大小，单位：字节

EmbeddingObject

向量

被如下接口引用：GetEmbedding。

名称 类型 必选 描述
Embedding Array of Float 否 向量

ErrorInfo

错误信息

被如下接口引用：GetReconstructDocumentResult, GetSplitDocumentResult。

名称 类型 描述
Code String 错误码
Message String 错误信息

Message

会话内容

被如下接口引用：ChatCompletions, QueryRewrite。

名称 类型 必选 描述
Role String 否 角色
Content String 否 内容
ReasoningContent String 否 思维链内容。
ReasoningConent参数仅支持出参，且只有deepseek-r1模型会返回。
SearchResults Array of SearchResult 否 搜索结果

ReconstructDocumentFailedPage

文档解析失败记录

被如下接口引用：GetReconstructDocumentResult, ReconstructDocumentSSE。

名称 类型 描述
PageNumber Integer 失败页码
注意：此字段可能返回 null，表示取不到有效值。

ReconstructDocumentSSEConfig

ReconstructDocumentSSE 功能配置参数

被如下接口引用：ReconstructDocumentSSE。

名称 类型 必选 描述
TableResultType String 否 Markdown文件中表格返回的形式
0，表格以MD形式返回
1，表格以HTML形式返回
默认为0
MarkdownImageResponseType String 否 Markdown文件中图片返回的形式
0:markdown中图片以链接形式返回
1:markdown中图片只返回图片中提取的文本内容
默认是0
ReturnPageFormat Boolean 否 Markdown文件中是否包含页码信息
PageFormat String 否 自定义输出页码样式,{{p}}为页码占位符，开启ReturnPageFormat生效。未填默认样式:page {{p}}
IgnoreFailedPage Boolean 否 是否忽略失败页，返回已成功的页数据

SearchResult

搜索结果

被如下接口引用：ChatCompletions, QueryRewrite。

名称 类型 必选 描述
Index Integer 否 索引
Url String 否 链接地址
Name String 否 标题
Snippet String 否 摘要
Icon String 否 图标
Site String 否 站点
PublishedTime Integer 否 1740412800

Thinking

思维链开关类型

被如下接口引用：ChatCompletions。

名称 类型 必选 描述
Type String 否 控制开启思维链，默认disabled

enabled：开启思维链
disabled：关闭思维链

Usage

消耗量

被如下接口引用：GetEmbedding, QueryRewrite, RunRerank。

名称 类型 描述
TotalPages Integer 文档页数
InputTokens Integer 输入token数
OutputTokens Integer 输出token数
TotalTokens Integer 总token数
上一篇: GetSplitDocumentResult下一篇: Error Codes

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈