数据结构

AttributeItem

属性信息

被如下接口引用：ListAttributeLabels。

名称	类型	必选	描述
AttributeId	String	否	属性id 注意：此字段可能返回 null，表示取不到有效值。
AttributeKey	String	否	属性标识 注意：此字段可能返回 null，表示取不到有效值。
AttributeName	String	否	属性名称 注意：此字段可能返回 null，表示取不到有效值。
Labels	Array of AttributeLabelItem	否	标签名称 注意：此字段可能返回 null，表示取不到有效值。

AttributeLabelItem

属性标签信息

被如下接口引用：CreateAttributeLabel, ListAttributeLabels, ModifyAttributeLabel。

名称	类型	必选	描述
LabelId	String	否	标签id 注意：此字段可能返回 null，表示取不到有效值。
LabelName	String	否	标签名称，最大80个英文字符 注意：此字段可能返回 null，表示取不到有效值。

AttributeLabelReferItem

属性标签引用

被如下接口引用：CreateQA, DescribeDoc, ListDocs, ListQAs, ModifyQA, UploadDoc。

名称	类型	必选	描述
AttributeId	String	否	属性id 注意：此字段可能返回 null，表示取不到有效值。
LabelIds	Array of String	否	标签id 注意：此字段可能返回 null，表示取不到有效值。

ChatUsage

消耗量

被如下接口引用：ChatCompletions。

名称	类型	描述
PromptTokens	Integer	输入token数 示例值：10
CompletionTokens	Integer	输出token数 示例值：10
TotalTokens	Integer	总token数 示例值：10

Choice

返回的回复, 支持多个

被如下接口引用：ChatCompletions。

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

CreateReconstructDocumentFlowConfig

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

被如下接口引用：CreateReconstructDocumentFlow。

名称	类型	必选	描述
TableResultType	String	否	Markdown文件中表格返回的形式 0，表格以MD形式返回 1，表格以HTML形式返回 默认为0 示例值：1
ResultType	String	否	智能文档解析返回结果的格式 0：只返回全文MD； 1：只返回每一页的OCR原始Json； 2：只返回每一页的MD， 3：返回全文MD + 每一页的OCR原始Json； 4：返回全文MD + 每一页的MD， 默认值为0 示例值：3

CreateSplitDocumentFlowConfig

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

被如下接口引用：CreateSplitDocumentFlow。

名称	类型	必选	描述
EnableMllm	Boolean	否	是否开启mllm 示例值：true
MaxChunkSize	Integer	否	最大分片长度 示例值：4800

Delta

返回的内容

被如下接口引用：ChatCompletions。

名称	类型	描述
Role	String	角色名称。 示例值：assistant
Content	String	内容详情。 示例值：你好！请问有什么我可以帮助你的吗？
ReasoningContent	String	思维链内容。 ReasoningConent参数仅支持出参，且只有deepseek-r1模型会返回。

DocItem

离线文档列表回包

被如下接口引用：ListDocs。

名称	类型	必选	描述
DocId	String	否	文档id 注意：此字段可能返回 null，表示取不到有效值。
Status	String	否	状态， - Uploading 上传中 - Auditing 审核中 - Parsing 解析中 - ParseFailed 解析失败 - Indexing 创建索引中 - IndexFailed 创建索引失败 - Success 发布成功 - Failed 失败 注意：此字段可能返回 null，表示取不到有效值。
FileName	String	否	文件名 注意：此字段可能返回 null，表示取不到有效值。
UpdateTime	String	否	更新时间 注意：此字段可能返回 null，表示取不到有效值。
AttributeLabels	Array of AttributeLabelReferItem	否	属性标签 注意：此字段可能返回 null，表示取不到有效值。

DocumentUsage

文档拆分任务的用量

被如下接口引用：GetSplitDocumentResult。

名称	类型	描述
PageNumber	Integer	文档拆分任务的页数 示例值：10
TotalTokens	Integer	文档拆分任务消耗的总token数 示例值：2048
SplitTokens	Integer	拆分消耗的token数 示例值：1024
MllmTokens	Integer	mllm消耗的token数 示例值：1024

EmbeddingObject

向量

被如下接口引用：GetEmbedding。

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

LabelItem

属性标签

被如下接口引用：RetrieveKnowledge。

名称	类型	必选	描述
Name	String	否	属性key 示例值：key1
Values	Array of String	否	标签值 示例值：["v1","v2"]

Message

会话内容

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

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

QaItem

问答对信息

被如下接口引用：ListQAs。

名称	类型	必选	描述
QaId	String	否	问答id 注意：此字段可能返回 null，表示取不到有效值。
Question	String	否	问题 注意：此字段可能返回 null，表示取不到有效值。
Answer	String	否	答案 注意：此字段可能返回 null，表示取不到有效值。
AttributeLabels	Array of AttributeLabelReferItem	否	属性标签 注意：此字段可能返回 null，表示取不到有效值。
CreateTime	String	否	创建时间 注意：此字段可能返回 null，表示取不到有效值。
UpdateTime	String	否	更新时间 注意：此字段可能返回 null，表示取不到有效值。

ReconstructDocumentFailedPage

文档解析失败记录

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

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

ReconstructDocumentSSEConfig

ReconstructDocumentSSE 功能配置参数

被如下接口引用：ReconstructDocumentSSE。

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

RetrievalRecord

检索的结果

被如下接口引用：RetrieveKnowledge。

名称	类型	描述
Metadata	RetrievalRecordMetadata	检索结果的元数据 示例值：{"Type":"DOC","ResultSource":"SEMANTIC","ChunkPageNumbers":[1,2]}
Title	String	检索到的标题 示例值：example.pdf
Content	String	检索到的内容 示例值：国庆放7天假

RetrievalRecordMetadata

检索结果的元数据

被如下接口引用：RetrieveKnowledge。

名称	类型	描述
Type	String	结果的类型。 - DOC：文档 - QA：问答对 示例值：DOC
ResultSource	String	检索结果的来源。 - SEMANTIC：从语义检索中得到的结果 - FULL_TEXT：从全文检索中得到的结果 示例值：SEMANTIC
ChunkPageNumbers	Array of Integer	切片在文档中的页码，仅部分文档支持 示例值：[1,2]

RetrievalSetting

检索参数设置

被如下接口引用：RetrieveKnowledge。

名称	类型	必选	描述
Type	String	否	检索的类型，不填该参数则检索全部。 - DOC：文档 - QA：QA 仅RetrieveKnowledge接口支持该参数 示例值：DOC
TopK	Integer	否	返回个数 示例值：5
ScoreThreshold	Float	否	分数过滤 示例值：0.7

SearchResult

搜索结果

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

名称	类型	必选	描述
Index	Integer	否	索引 示例值：1
Url	String	否	链接地址 示例值：https://www.qq.com/
Name	String	否	标题 示例值：筑牢压舱石、澎湃新动能 一季度经济大省稳增长再提速_腾讯新闻
Snippet	String	否	摘要 示例值：经济大省是国家经济发展的顶梁柱。
Icon	String	否	图标 示例值：https://mat1.gtimg.com/qqcdn/qqindex2021/favicon.ico
Site	String	否	站点 示例值：腾讯网
PublishedTime	Integer	否	1740412800 示例值：发布时间

SegmentationConfig

分段配置

被如下接口引用：UploadDoc。

名称	类型	必选	描述
MaxChunkSize	Integer	否	最大分片长度 示例值：4800

Usage

消耗量

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

名称	类型	描述
TotalPages	Integer	文档页数 示例值：10
InputTokens	Integer	输入token数 示例值：10
OutputTokens	Integer	输出token数 示例值：10
TotalTokens	Integer	总token数 示例值：10