文档列表

最近更新时间:2026-04-28 01:41:34

我的收藏

1. 接口描述

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

文档列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ListDoc。
Version String 公共参数,本接口取值:2023-11-30。
Region String 公共参数,详见产品支持的 地域列表
BotBizId String

应用ID, 获取方式参看 BotBizId
查询知识库下文档时,该参数填入知识库ID。


示例值:1727231073371148288
PageNumber Integer

页码(必须大于0)


示例值:1
PageSize Integer

每页数量(取值范围1-200)


示例值:15
Query String

查询内容

输入特定标识 lke:system:untagged 将查询所有未关联标签的文档


示例值:"我的文档"
Status.N Array of Integer

文档状态: 1-未生成 2-生成中 3-生成成功 4-生成失败 5-删除中 6-删除成功 7-审核中 8-审核失败 9-审核成功 10,12-导入成功 13-学习中 14-学习失败 15-更新中 16-更新失败 17-解析中 18-解析失败 19-导入失败 20-已过期 21-超量失效 22-超量失效恢复


示例值:[1]
QueryType String

查询类型 filename 文档、 attribute 标签


示例值:filename
CateBizId String

分类ID, 可以通过调用ListDocCate接口,查看其返回结果获取


示例值:0
FileTypes.N Array of String

文件类型分类筛选


示例值:["txt","jpg"]
FilterFlag.N Array of DocFilterFlag

文档列表筛选标识位

ShowCurrCate Integer

是否只展示当前分类的数据 0不是,1是


示例值:0
EnableScope Integer

文档生效域;不检索默认为0。检索枚举值如下:
1-不生效;2-仅开发域生效;3-仅发布域生效;4-开发域和发布域均生效


示例值:1
UpdateTime TimeRange

文档更新时间范围

3. 输出参数

参数名称 类型 描述
Total String

文档数量


示例值:15
List Array of ListDocItem

文档列表

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

4. 示例

示例1 文档列表

输入示例

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

{
    "BotBizId": "1727231073371148288",
    "PageNumber": 1,
    "PageSize": 10
}

输出示例

{
    "Response": {
        "List": [
            {
                "AttrLabels": [],
                "AttrRange": 1,
                "CosUrl": "/corp/137/doc/jkadslfjalkdfjaklsdfla.docx",
                "DocBizId": "1729099536210460672",
                "DocCharSize": "5",
                "FileName": "jkadslfjalkdfjaklsdfla.docx",
                "NewName": "",
                "FileType": "docx",
                "IsAllowDelete": true,
                "IsAllowEdit": true,
                "IsAllowRefer": true,
                "IsAllowRestart": true,
                "IsCreatedQa": true,
                "IsCreatingQa": false,
                "IsDeleted": false,
                "IsDeletedQa": false,
                "IsRefer": false,
                "QaNum": 2,
                "Reason": "生成问答成功",
                "Source": 1,
                "SourceDesc": "网页导入",
                "Status": 12,
                "StatusDesc": "导入成功",
                "WebUrl": "",
                "ReferUrlType": 0,
                "UpdateTime": "1701425246"
            }
        ],
        "RequestId": "5526c65b-308d-4e84-b6b3-6b21d5c106b2",
        "Total": "1"
    }
}

示例2 更新时间

更新时间

输入示例

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

{
    "BotBizId": "2046432781641786304",
    "PageNumber": 1,
    "PageSize": 15,
    "Query": "t",
    "Status": [
        10
    ],
    "QueryType": "filename",
    "CateBizId": "0",
    "UpdateTime": {
        "Start": "2026-04-15 00:00:00",
        "End": "2026-04-29 23:59:59"
    }
}

输出示例

{
    "Response": {
        "List": [
            {
                "AttrLabels": [
                    {
                        "AttrBizId": "2047229851896103040",
                        "AttrKey": "lsOOuJiJ",
                        "AttrName": "朝代",
                        "Labels": [
                            {
                                "LabelBizId": "2047229851900297344",
                                "LabelName": "21世纪"
                            }
                        ],
                        "Source": 1
                    }
                ],
                "AttrRange": 2,
                "AttributeFlags": [],
                "CateBizId": "2047572762068238464",
                "CosUrl": "/corp/1747547736762744832/2046432781641786304/doc/GcpdluVjCRFkyiCkoKEX-2046433768792204096.txt",
                "CreateTime": "1776742812",
                "CustomerKnowledgeId": "",
                "DocBizId": "2046433795425184512",
                "DocCharSize": "5281062",
                "DocSize": "11027751",
                "EnableScope": 4,
                "ExpireEnd": "0",
                "ExpireStart": "1776742811",
                "FileName": "绝世唐门.txt",
                "FileType": "txt",
                "IsAllowDelete": true,
                "IsAllowEdit": true,
                "IsAllowRefer": true,
                "IsAllowRestart": true,
                "IsAllowRetry": false,
                "IsCreatedQa": false,
                "IsCreatingQa": false,
                "IsDeleted": false,
                "IsDeletedQa": false,
                "IsDisabled": false,
                "IsRefer": false,
                "NewName": "",
                "Processing": [],
                "QaNum": 0,
                "Reason": "",
                "ReferUrlType": 0,
                "Source": 0,
                "SourceDesc": "KeySourceFileImport",
                "StaffName": "coco测试11",
                "Status": 10,
                "StatusDesc": "导入完成",
                "UpdateTime": "1777260664",
                "WebUrl": ""
            }
        ],
        "Total": "2",
        "RequestId": "64291550-b4c9-46d8-bd8d-56cb52ce1421"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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