文档中心

向量数据库VikingDB

请输入

实验版本（新）

batch-to-pipeline

概述

接口 /api/knowledge/doc/batch-to-pipeline 用于向一个实验版本中同步知识库内已有的全部文档。

前提条件

完成 API Key 鉴权（在控制台获取 VIKING_API_KEY）后，可调用 API 接口实现将知识库中文档同步到实验版本的功能。

请求接口

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

请求参数

参数	类型	必选	默认值	备注
collection_name	string	否	--	知识库名称 `resource_id` 和 `collection_name` 至少传入一个；若同时传入，优先使用 `resource_id` 定位知识库
project	string	否	default	知识库所属项目，获取方式参见文档 API 接入与技术支持若不指定该字段，则默认使用 default 项目。若需要操作指定项目下的知识库，需正确配置该字段。
resource_id	string	否	--	知识库唯一 ID 可通过创建知识库接口的返回值或知识库列表接口获取 `resource_id` 和 `collection_name` 至少传入一个；若同时传入，优先使用 `resource_id` 定位知识库
pipeline_name	string	是	--	实验版本名称
timestamp	int	否	当前时间	秒级时间戳指定导入该时间点之前创建的全部文档不传时使用接口接收请求时的当前秒级时间戳，即同步截至请求时已创建的文档
strategy_resource_id	string	否	--	指定处理策略 ID 可通过处理策略的创建或查询结果获取若未指定则使用默认策略

响应消息

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

状态码说明

状态码	http状态码	返回信息	状态码说明
0	200	success	成功
1000001	403	unauthorized	鉴权失败
1000002	403	no permission	权限不足
1000003	400	invalid request：%s	非法参数缺失必选参数 collection_name 命名不符合规范字段类型与相关字段属性不满足约束条件
1709905	400	A parameter specified in the request is not valid: %s	请求参数异常
1709900	500	Service has some internal Error. Pls Contact With Admin. %s	内部异常

完整示例

请求消息

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/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"
}

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

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

状态码说明 #

请求消息 #

响应消息 #

状态码说明

请求消息

响应消息