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文件中表格返回的形式 示例值:1 |
| ResultType | String | 否 | 智能文档解析返回结果的格式 示例值:3 |
| IgnoreFailedPage | Boolean | 否 | 是否忽略失败页,返回已成功的页数据。默认为true。 示例值:true |
| ReturnPageFormat | Boolean | 否 | Markdown文件中是否包含页码信息 示例值:true |
| PageFormat | String | 否 | 自定义输出页码样式,{{p}}为页码占位符,开启ReturnPageFormat生效。未填默认样式: 示例值: |
CreateSplitDocumentFlowConfig
创建智能文档拆分任务的配置信息
被如下接口引用:CreateSplitDocumentFlow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| EnableMllm | Boolean | 否 | 是否开启mllm 示例值:true |
| MaxChunkSize | Integer | 否 | 最大分片长度 示例值:4800 |
| IgnoreFailedPage | Boolean | 否 | 是否忽略返回失败页码 示例值:true |
| SplitResultType | String | 否 | 智能文档解析返回结果的格式 示例值:0 |
| SplitTableResultType | String | 否 | Markdown文件中表格返回的形式 示例值:0 |
| ReturnPageFormat | Boolean | 否 | Markdown文件中是否包含页码信息 示例值:true |
| PageFormat | String | 否 | 自定义输出页码样式,{{p}}为页码占位符,开启ReturnPageFormat生效。未填默认样式: 示例值: |
Delta
返回的内容
被如下接口引用:ChatCompletions。
| 名称 | 类型 | 描述 |
|---|---|---|
| Role | String | 角色名称。 示例值:assistant |
| Content | String | 内容详情。 示例值:你好!请问有什么我可以帮助你的吗? |
| ReasoningContent | String | 思维链内容。 ReasoningConent参数仅支持出参,且只有deepseek-r1模型会返回。 |
DocumentUsage
文档拆分任务的用量
被如下接口引用:GetReconstructDocumentResult, GetSplitDocumentResult。
| 名称 | 类型 | 描述 |
|---|---|---|
| PageNumber | Integer | 文档拆分任务的页数 示例值:10 |
| TotalTokens | Integer | 文档拆分任务消耗的总token数 示例值:2048 |
| SplitTokens | Integer | 拆分消耗的token数 示例值:1024 |
| MllmTokens | Integer | mllm消耗的token数 示例值:1024 |
| SuccessPageNum | Integer | 解析成功页数 示例值:10 |
| FailPageNum | Integer | 解析失败页数 示例值:1 |
| FileSize | Integer | 文件大小,单位:字节 示例值:100 |
EmbeddingObject
向量
被如下接口引用:GetEmbedding。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Embedding | Array of Float | 否 | 向量 |
ErrorInfo
错误信息
被如下接口引用:GetReconstructDocumentResult, GetSplitDocumentResult。
| 名称 | 类型 | 描述 |
|---|---|---|
| Code | String | 错误码 示例值:FailedOperation.FileParseError |
| Message | String | 错误信息 示例值:file parse timeout |
Message
会话内容
被如下接口引用:ChatCompletions, QueryRewrite。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Role | String | 否 | 角色 示例值:user |
| Content | String | 否 | 内容 示例值:content |
| 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 示例值:0 |
| MarkdownImageResponseType | String | 否 | Markdown文件中图片返回的形式 0:markdown中图片以链接形式返回 1:markdown中图片只返回图片中提取的文本内容 默认是0 示例值:0 |
| ReturnPageFormat | Boolean | 否 | Markdown文件中是否包含页码信息 示例值:true |
| PageFormat | String | 否 | 自定义输出页码样式,{{p}}为页码占位符,开启ReturnPageFormat生效。未填默认样式: 示例值: |
| IgnoreFailedPage | Boolean | 否 | 是否忽略失败页,返回已成功的页数据 示例值:true |
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 示例值:发布时间 |
Thinking
思维链开关类型
被如下接口引用:ChatCompletions。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 否 | 控制开启思维链,默认disabled enabled:开启思维链 disabled:关闭思维链 示例值:disabled |
Usage
消耗量
被如下接口引用:GetEmbedding, QueryRewrite, RunRerank。
| 名称 | 类型 | 描述 |
|---|---|---|
| TotalPages | Integer | 文档页数 示例值:10 |
| InputTokens | Integer | 输入token数 示例值:10 |
| OutputTokens | Integer | 输出token数 示例值:10 |
| TotalTokens | Integer | 总token数 示例值:10 |