文档中心

向量数据库VikingDB

文档

list（新）

概述

/api/knowledge/doc/v2/list 接口用于查询知识库或某个实验版本上文档的列表。新接口抛弃 offset 逻辑，仅支持纯游标（Cursor）翻页，从而提供极致的查询性能和一致的分页体验。

支持通过指定 pipeline_name 参数，来实现查询某个实验版本下的文档列表

前提条件

完成 API Key 鉴权（在控制台获取 VIKING_API_KEY）后，可调用 API 接口实现查询某个知识库下的所有文档信息的功能。

请求接口

URI	/api/knowledge/doc/v2/list	统一资源标识符
请求方法	POST	客户端对向量数据库服务器请求的操作类型
请求头	Content-Type: application/json	请求消息类型
	Authorization: Bearer {VIKING_API_KEY}	鉴权

请求参数

参数	子参数	类型	是否必选	默认值	参数说明
collection_name	--	string	否	--	知识库名称
project	--	string	否	default	知识库所属项目，获取方式参见文档 API 接入与技术支持若不指定该字段，则在 default 项目下查询。若需要操作指定项目下的知识库，需正确配置该字段。
resource_id	--	string	二选一	--	知识库唯一 ID；与 `collection_name` 至少传一个，都不传返回参数错误，同时传入时优先使用 `resource_id`。
pipeline_name	--	string	否	--	实验版本名称不指定时，默认查询知识库主版本下的文档列表指定时，查询特定实验版本内的文档列表
limit	--	int	否	100	每次返回切片数量取值范围 [1, 100]，即单次请求最多返回 100 条文档数据。
next_token	String	否		--	翻页游标当数据总量较大时，接口不会一次性返回所有数据，而是将数据拆分为若干批次，每次请求只返回其中一批。这种方式通常称为"分页"，每一批数据即为"一页" next_token 是游标，用于标记当前的读取位置。每次请求返回的 next_token 指向下一批数据的起始位置，传入后即可获取接下来的数据，以此实现连续翻页首次请求：不传 next_token，从第一条数据开始返回获取后续数据： next_token 由接口自动生成，无需解析或构造，直接将返回值传入下次请求即可，接口将从上次结束处继续返回数据读取完毕：当响应中 next_token 为空时，表示所有数据已返回完毕

响应消息

参数	参数说明
code	状态码
message	返回信息
request_id	标识每个请求的唯一标识符
data	collection_name：知识库的名字 total_num：符合条件的文档总数 count：本次查询返回的文档数量 doc_list：查询的文档信息列表，里面每一个元素代表一篇文档的信息，单篇文档信息格式参考响应消息 has_more：是否还有下一页数据 next_token：下一页的翻页游标；为空时表示数据已全部返回

状态码说明

状态码	http状态码	返回信息	状态码说明
0	200	success	成功
1000001	401	unauthorized	鉴权失败
1000002	403	no permission	权限不足
1000003	400	invalid request：%s	非法参数
1000005	400	collection not exist	collection不存在

完整示例

请求消息

curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {VIKING_API_KEY}' \
  https://api-knowledgebase.mlp.cn-beijing.volces.com/api/knowledge/doc/v2/list \
  -d '{
    "collection_name": "test_collection_name",
    "limit": 2,
    "next_token": "eyJjcmVhdGVkX2F0IjoxNzc2MzM4NDEzNzQ1LCJkb2NfaWQiOiJiZW5jaF9kb2NfMDQxNl85OTlfMTU2OTg1MDAwMDBhZmVfMTQ1NTQ1MTkifQ"
}'

响应消息

执行成功返回：

{
    "code": 0,
    "data": {
        "collection_name": "test_collection_name",
        "total_num": 2,
        "count": 2,
        "doc_list":[
            {
                "collection_name": "test_collection_name",
                "doc_name" :"张某某盗窃案",
                "doc_id": "test0123",
                "add_type": "url",
                "doc_type": "pdf",
                "doc_summary": "这篇论文提出了基于注意力机制的 Transformer 模型,...",
                "brief_summary": "这篇论文提出了基于注意力机制的 Transformer 模型,...",
                "create_time": 1711367027,
                "added_by": "username",
                "update_time": 1711367030,
                "url": "https://example.com/path/to/document?X-Tos-Credential=REDACTED&X-Tos-Security-Token=REDACTED&X-Tos-Signature=REDACTED",
                "point_num": 53,
                "status":{
                    "process_status":0
                },
                "total_tokens":345390,
                "doc_summary_tokens": 120742,
                "doc_premium_status": {
                    "doc_summary_status_code": 0
                }
            },
            {
                "collection_name": "test_collection_name",
                "doc_name" :"测试文档",
                "doc_id": "test1111",
                "add_type": "url",
                "doc_type": "doc",
                "create_time": 1711367010,
                "added_by": "username",
                "update_time": 1711367010,
                "url": "https://example.com/path/to/document?X-Tos-Credential=REDACTED&X-Tos-Security-Token=REDACTED&X-Tos-Signature=REDACTED",
                "point_num": 100,
                "status":{
                    "process_status":0
                },
                "total_tokens":345390
            }
        ],
        "has_more": true,
        "next_token": "eyJjcmVhdGVkX2F0IjoxNzcwMjg1MjY5OTkxLCJkb2NfaWQiOiJfc3lzX2F1dG9fZ2VuX2xhcmtfZG9jX2lkLTEwMjI4NTQ0OTQ4NDg1NTAyOTIifQ"
    },
    "message": "success",
    "request_id": "02171136497331800000000000000000000ffff0a00601688694f"
}

执行失败返回：

HTTP/1.1 400 Bad Request
Content-Length: 43
Content-Type: application/json

{"code": 1000003, "message": "One or more parameters specified in the request are not valid. req parse to json failed","request_id": "021695029757920fd001de6666600000000000000000002569b8f"}

最近更新时间：2026.09.08 20:33:21

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

状态码说明 #

请求消息 #

响应消息 #

状态码说明

请求消息

响应消息