帮你快速理解、总结文档立即下载
文档中心>腾讯云智能体开发平台>API 文档>知识库相关接口>查询文档摘要列表

查询文档摘要列表

最近更新时间：2026-09-14 20:50:16
我的收藏

本页目录：

1. 接口描述

接口请求域名： adp.tencentcloudapi.com 。

查询文档摘要列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeDocSummaryList。
Version 是 String 公共参数，本接口取值：2026-05-20。
Region 是 String 公共参数，详见产品支持的 地域列表。
KbId 是 String

所属知识库 ID


示例值：2063937671963228544
FilterList.N 否 Array of Filter

过滤条件（多个 Filter 之间为 AND 关系，同一 Filter 的多个 Values 为 OR 关系）：Status-文档状态,枚举值,精确匹配; CategoryId-分类ID,精确匹配; SourceType-文档来源类型,枚举值,精确匹配; EffectiveDomain-生效作用域,精确匹配; CreateTime-创建时间,Unix秒,BETWEEN 传 [起始秒,结束秒]; UpdateTime-更新时间,Unix秒,BETWEEN 传 [起始秒,结束秒]
PageNumber 否 Integer

分页页码，从 0 开始


示例值：1
PageSize 否 Integer

每页数量，默认 10，最大 100


示例值：100
Query 否 DocQuery

查询条件（关键词 + 查询范围）
SummaryListSwitch 否 SummaryListSwitch

开关配置

3. 输出参数

参数名称 类型 描述
DocList Array of DocSummary

文档列表
TotalCount Integer

总数


示例值：22
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询文档摘要列表

查询文档摘要列表

输入示例

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

{
    "KbId": "2063937671963228544",
    "SummaryListSwitch": {
        "ShowMetadataEnabled": true
    }
}

输出示例

{
    "Response": {
        "DocList": [
            {
                "CategoryPath": {
                    "CategoryId": "2063937672853638592",
                    "CategoryIdPath": [],
                    "CategoryNamePath": []
                },
                "DocId": "2095797834220731520",
                "KnowledgeScope": {
                    "EffectiveDomain": 4,
                    "LabelRefList": []
                },
                "Lifecycle": {
                    "CreateTime": "1788512116",
                    "ExpirationPolicy": null,
                    "Status": 8,
                    "StatusDesc": "导入完成",
                    "StatusMessage": "",
                    "UpdateTime": "1788935064"
                },
                "Metadata": {
                    "DocCharCount": "45120",
                    "FileName": "《人保健康玺悦君心互联网重大疾病保险（2022版）》_1721880984_1_副本.doc",
                    "FileSize": "435953",
                    "FileType": "doc",
                    "RefFieldNameList": [],
                    "SourceDesc": "本地文档",
                    "SourceType": 0
                },
                "OperatorInfo": {
                    "Modifier": {
                        "UserId": "1747547736783716352",
                        "UserName": "coco测试11"
                    },
                    "Permission": {
                        "CanDelete": true,
                        "CanEdit": true,
                        "CanRestart": true,
                        "CanRetry": false
                    }
                },
                "TaskStatus": null
            }
        ],
        "TotalCount": 22,
        "RequestId": "66c89981-2fd7-4eab-a598-4610960b9662"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

中国站