获取知识文档列表

获取 Bot 内的知识库的知识文档的列表。

请求方式

GET

调用地址

https://api.gptbots.ai/v1/bot/doc/query/page

调用验证

详情参见【API 概述】内的鉴权方式说明。

请求

请求示例

curl --location 'https://api.gptbots.ai/v1/bot/doc/query/page?page=1&page_size=10&knowledge_base_id=67457fea6f658672d6482542' \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'Content-Type: application/json'

          curl --location 'https://api.gptbots.ai/v1/bot/doc/query/page?page=1&page_size=10&knowledge_base_id=67457fea6f658672d6482542' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json'

此代码块在浮窗中显示

请求头

字段	类型	描述
Authorization	Bearer ${token}	使用 `Authorization: Bearer ${token}` 进行调用验证，请在 API 密钥页面获取密钥作为 token。
Content-Type	application/json	数据类型，取值为 `application/json` 。

请求体

字段	类型	必填	说明
knowledge_base_id	String	是	知识库的 ID。
page	Integer	是	页码，从 1 开始。
page_size	Integer	是	每页的文档数。填写范围 10-100。

响应

响应示例

{ "list": [ { "id": "xxxxxx", "name": "My Doc", "format": "pdf", "source_url": "https://gptbots.ai/article_1.pdf", "status": "ACTIVE", "chunk": 100, "token": 1000000, "char_count": 10000000, "create_time": 1699843200, "update_time": 1699843200, "creator_id": "xxxxxx", "creator_email": "johnlee@gptbots.ai" }, { "id": "xxxxxx", "name": "My Doc 2", "format": "txt", "source_url": "https://gptbots.ai/article_2.html", "status": "ACTIVE", "chunk": 100, "token": 1000000, "char_count": 10000000, "create_time": 1699843200, "update_time": 1699843200, "creator_id": "xxxxxx", "creator_email": "johnlee@gptbots.ai" } ], "total": 100 }

          {
    "list": [
        {
            "id": "xxxxxx",
            "name": "My Doc",
            "format": "pdf",
            "source_url": "https://gptbots.ai/article_1.pdf",
            "status": "ACTIVE",
            "chunk": 100,
            "token": 1000000,
            "char_count": 10000000,
            "create_time": 1699843200,
            "update_time": 1699843200,
            "creator_id": "xxxxxx",
            "creator_email": "johnlee@gptbots.ai"
        },
        {
            "id": "xxxxxx",
            "name": "My Doc 2",
            "format": "txt",
            "source_url": "https://gptbots.ai/article_2.html",
            "status": "ACTIVE",
            "chunk": 100,
            "token": 1000000,
            "char_count": 10000000,
            "create_time": 1699843200,
            "update_time": 1699843200,
            "creator_id": "xxxxxx",
            "creator_email": "johnlee@gptbots.ai"
        }
    ],
    "total": 100
}

此代码块在浮窗中显示

成功响应

字段	类型	说明
list	Array	文档列表。
id	String	文档的 ID。
name	String	文档的名称。
format	String	文档的格式。
source_url	String	文档的来源地址。
status	String	文档的状态。 - ACTIVE：成功 - FAIL：失败
chunk	Integer	文档的知识块数。
token	Integer	文档的 Token 数。
char_count	Integer	文档的字符数。
create_time	Long	文档的创建时间，时间戳。
update_time	Long	文档的更新时间，时间戳。
creator_id	String	文档创建人的 ID。
creator_email	String	文档创建人的邮箱。
total	Integer	查询到的文档总数。

失败响应

字段	类型	描述
code	Integer	错误码。
message	String	错误详情。