文档中心

向量数据库VikingDB

文档

list

概述

/api/knowledge/doc/list 接口用于查询知识库或某个实验版本上文档的列表，默认按照文档上传时间倒序排列。

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

前提条件

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

请求接口

URI	/api/knowledge/doc/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`。
filter		json	否	--	过滤条件用于对返回结果进行过滤，支持使用 doc_id 过滤
	doc_id_list	list	否	--	指定文档 ID 过滤条件文档 ID 可通过文档上传结果或文档列表接口获取只返回列表中指定的文档信息
offset	--	int	否	0	查询起始位置，取值必须大于等于 0；limit 不传时使用默认值 100。
limit	--	int	否	100	查询文档数。`-1` 会被转换为默认值 100，并非获取全部；其他有效值范围为 `[1, 1000]`。
doc_type	--	list<string>	否	--	文档类型筛选。支持 `txt`、`doc`、`docx`、`pdf`、`ppt`、`pptx`、`html`、`markdown`、`epub`、`faq.xlsx`、`xlsx`、`csv`、`jsonl`、`parquet` 及支持的图片、音频、视频类型。
return_token_usage	--	bool	否	false	是否返回文档向量化和文档摘要生成所消耗的 tokens true：返回 token 用量信息；false：不返回 token 用量信息
pipeline_name	--	string	否	--	实验版本名称不指定时，默认查询知识库主版本下的文档列表指定时，查询特定实验版本内的文档列表
detailed	--	bool	否	false	是否展示文档详细信息 true：返回文档摘要等详细信息；false：不返回详细信息详细信息：文档摘要注：摘要相关字段返回内容较多，可能导致请求耗时较长，建议仅在需要时单独调用 doc/info 接口获取

响应消息

参数	参数说明
code	状态码
message	返回信息
request_id	标识每个请求的唯一标识符
data	collection_name：知识库的名字 total_num：该知识库下的文档总数 count：本次查询返回的文档总数 doc_list：查询的文档信息列表，里面每一个元素代表一篇文档的信息，单篇文档信息格式参考响应消息

状态码说明

状态码	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/list \
  -d '{
    "collection_name": "test_collection_name",
    "project": "",
    "filter": {
            "doc_id_list": ["test0123", "test1111"]
        },
    "return_token_usage": true
}'

响应消息

执行成功返回：

HTTP/1.1 200 OK
Content-Length: 43
Content-Type: application/json
 
{
    "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
            }
        ]
    },
    "message": "success",
    "request_id": "02171136497331800000000000000000000ffff0a00601688694f"
}

执行失败返回：

HTTP/1.1 400 Bad Request
Content-Length: 43
Content-Type: application/json
 
{"code":1000003, "message":"invalid request：%s", "request_id": "021695029757920fd001de6666600000000000000000002569b8f"}

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

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

状态码说明 #

请求消息 #

响应消息 #

状态码说明

请求消息

响应消息