1. 接口描述
接口请求域名： lke.tencentcloudapi.com 。
文档详情
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDoc。 |
| Version | 是 | String | 公共参数，本接口取值：2023-11-30。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| BotBizId | 是 | String | 应用ID 示例值：195117326502409112 |
| DocBizId | 是 | String | 文档ID 示例值：19517346915356272 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DocBizId | String | 文档ID 示例值：19517346915356272 |
| FileName | String | 文件名称 示例值：腾讯云智能体开发平台功能清单.png |
| FileType | String | 文件类型 示例值：png |
| CosUrl | String | cos路径 示例值：/corp/1781137320016347136/19511732650240902/doc/XegQmZzPwQwpkvVTlSsF-1951173448143208448.png |
| UpdateTime | String | 更新时间 示例值：1754031032 |
| Status | Integer | 文档状态： 1-未生成 2-生成中 3-生成成功 4-生成失败 5-删除中 6-删除成功 7-审核中 8-审核失败 9-审核成功 10-待发布 11-发布中 12-已发布 13-学习中 14-学习失败 15-更新中 16-更新失败 17-解析中 18-解析失败 19-导入失败 20-已过期 21-超量失效 22-超量失效恢复 示例值：10 |
| StatusDesc | String | 文档状态描述 示例值：待发布 |
| Reason | String | 生成失败原因 示例值：入库失败 |
| IsRefer | Boolean | 答案中是否引用 示例值：false |
| QaNum | Integer | 问答对数量 示例值：0 |
| IsDeleted | Boolean | 是否删除 示例值：false |
| Source | Integer | 文档来源 示例值：0 |
| SourceDesc | String | 文档来源描述 示例值：源文件导入 |
| IsAllowRestart | Boolean | 是否允许重新生成 示例值：true |
| IsDeletedQa | Boolean | qa是否已删除 示例值：false |
| IsCreatingQa | Boolean | 问答是否生成中 示例值：false |
| IsAllowDelete | Boolean | 是否允许删除 示例值：true |
| IsAllowRefer | Boolean | 是否允许操作引用开关 示例值：false |
| IsCreatedQa | Boolean | 是否生成过问答 示例值：false |
| DocCharSize | String | 文档字符量 示例值：1803 |
| IsAllowEdit | Boolean | 是否允许编辑 示例值：true |
| AttrRange | Integer | 标签适用范围 1：全部，2：按条件范围 示例值：1 |
| AttrLabels | Array of AttrLabel | 标签 |
| CateBizId | String | 分类ID 示例值：1951173265057644545 |
| IsDisabled | Boolean | 文档是否停用，false:未停用，true:已停用 示例值：false |
| IsDownload | Boolean | 是否支持下载 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| SplitRule | String | 自定义切分规则 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"common_splitter":{}} |
| UpdatePeriodInfo | UpdatePeriodInfo | 文档更新频率 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 文档详情
输入示例
POST / HTTP/1.1
Host: lke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDoc
<公共请求参数>
{
"BotBizId": "1727231073371148288",
"DocBizId": "1729099536210460672"
}输出示例
{
"Response": {
"RequestId": "17467eb0-3f01-4bc8-af86-3f3b6b01a40c",
"IsAllowDelete": true,
"IsCreatedQa": false,
"IsDeleted": false,
"SourceDesc": "网页导入",
"UpdateTime": "1701427403",
"DocBizId": "1729099536210460672",
"DocCharSize": "5",
"FileName": "jkadslfjalkdfjaklsdfla.docx",
"IsAllowEdit": false,
"IsDeletedQa": false,
"AttrLabels": [],
"AttrRange": 1,
"CosUrl": "/corp/137/doc/jkadslfjalkdfjaklsdfla.docx",
"IsAllowRefer": false,
"IsCreatingQa": false,
"Source": 1,
"QaNum": 0,
"Reason": "",
"Status": 14,
"StatusDesc": "学习失败",
"FileType": "docx",
"IsAllowRestart": true,
"IsRefer": false,
"IsDownload": false
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
