查询文档详情

最近更新时间:2025-02-12 01:45:16

我的收藏

1. 接口描述

接口请求域名: lkeap.tencentcloudapi.com 。

用于查询特定文档的详细信息。 使用场景:当需要查看某个文档的具体内容和属性时使用。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDoc。
Version String 公共参数,本接口取值:2024-05-22。
Region String 公共参数,详见产品支持的 地域列表
KnowledgeBaseId String 知识库ID
示例值:4901991032
DocId String 文档ID
示例值:1830994598655366257

3. 输出参数

参数名称 类型 描述
DocId String 文档ID
Status String 状态,

- Uploading 上传中
- Auditing 审核中
- Parsing 解析中
- ParseFailed 解析失败
- Indexing 创建索引中
- IndexFailed 创建索引失败
- Success 发布成功
- Failed 失败
FileName String 文件名
UpdateTime String 更新时间
AttributeLabels Array of AttributeLabelReferItem 属性标签
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询文档详情

查询文档详情

输入示例

POST / HTTP/1.1
Host: lkeap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDoc
<公共请求参数>

{
    "KnowledgeBaseId": "4901991032",
    "DocId": "1830881178265519872"
}

输出示例

{
    "Response": {
        "DocId": "1830881178265519872",
        "FileName": "product_manuals.docx",
        "RequestId": "bf318516-67a7-41df-9460-e581b4ecedbd",
        "Status": "Parsing"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码