batch-to-pipeline--向量数据库VikingDB-火山引擎

文档中心

导航

向量数据库VikingDB

batch-to-pipeline

最近更新时间：2025.07.02 11:42:34首次发布时间：2025.06.26 19:50:25

概述

api/knowledge/doc/batch-to-pipeline 向一个实验版本中同步知识库内存在的全部文档。
以接口收到请求时的时间戳为准，导入该时间戳之前的全部历史文档。若希望后续新增文档自动同步到当前实验版本，可以开启 /api/knowledge/pipeline/update/auto_sync_doc 接口

前提条件

完成“签名鉴权方式“页面的注册账号、实名认证、AK/SK 密钥获取和签名获取后，可调用 API 接口实现从知识库删除文档的功能。

请求接口

URI	/api/knowledge/doc/batch-to-pipeline	统一资源标识符
请求方法	POST	客户端对向量数据库服务器请求的操作类型
请求头	Content-Type: application/json	请求消息类型
请求头	Authorization: token=**********	鉴权

请求参数

参数	类型	必选	默认值	备注
collection_name	string	否	--	知识库名称
project	string	否	default	知识库所属项目即在【访问控制】-【资源管理】-【项目】中创建的项目
resource_id	string	否	--	知识库唯一 id 可选择直接传 resource_id，或同时传 collection_name 和 project 作为知识库的唯一标识
pipeline_name	string	是	--	实验版本名称
timestamp	int	否	--	秒级时间戳指定导入某个时间点之前创建的全部文档

响应消息

参数	参数说明
code	状态码
message	返回信息

状态码说明

状态码	http状态码	返回信息	状态码说明
0	200	success	成功
1000001	403	unauthorized	鉴权失败
1000002	403	no permission	权限不足
1000003	400	invalid request：%s	非法参数缺失必选参数 collection 命名不符合规范字段类型与相关字段属性不满足约束条件

完整示例

请求消息

curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: token=****' \
  https://api-knowledgebase.mlp.cn-beijing.volces.com/api/knowledge/doc/batch-to-pipeline \
  -d '{
    "collection_name": "test_collection_name",
    "project": "default",
    "pipeline_name": "custom_pipeline",
    "timestamp": 1703923200
}'

响应消息

执行成功返回：

HTTP/1.1 200 OK
Content-Length: 78
Content-Type: application/json

{"code":0,"message":"success","request_id":"021695029537650fd001de666660000000000000000000230da93"}

执行失败返回：

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

{
  "code": 1000003,
  "message": "invalid request: missing required parameter pipeline_name",
  "request_id": "021695029757920fd001de6666600000000000000000002569b8f"
}