文档中心

向量数据库VikingDB

请输入

实验版本（新）

update

api/knowledge/pipeline/update 修改实验版本配置

前提条件

完成“签名鉴权方式”页面的注册账号、实名认证、AK/SK 密钥获取和签名获取后，可调用 API 接口实现更新实验版本信息的功能。

请求接口

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

请求参数

参数	类型	必选	默认值	备注
collection_name	string	否	--	知识库名称
project	string	否	default	知识库所属的已有项目名；值不能为空，且必须是当前账号下已存在并可访问的项目。不传时使用 default；接口层未额外限制字符集或长度。
resource_id	string	二选一	--	知识库唯一 ID；与 `collection_name` 至少传一个，都不传返回参数错误，同时传入时优先使用 `resource_id`。
name	string	是	--	实验版本名称。必须以英文字母开头，仅支持英文字母、数字和下划线，长度 `[1,128]`，且不能使用系统保留名称。
cpu_quota	int	否	保持原值	CPU 配额，单位为核，取值范围 `[1,100]`；不传时不更新。
auto_sync_doc	bool	否	保持原值	是否自动同步新增文档。true 表示后续新文档自动同步；false 表示不自动同步；不传时保持现有设置。
pipeline_strategy_sync_type	string	否	--	同步策略选择枚举值： sync：与正式版本一致 default：默认策略
vlm_prompt	string	否	--	视频切片规则，字数不超过 5000，且必须包含 start_time、end_time 及格式说明，否则会造成视频分段失败。要求输出 JSON 数组，每个元素代表一个切片，包含以下字段： start_time：切片开始时间 end_time：切片结束时间 content_summary：切片内容摘要

响应消息

参数	参数说明
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: HMAC-SHA256 ***' \
https://api-knowledgebase.mlp.cn-beijing.volces.com/api/knowledge/pipeline/update \
-d '{
  "collection_name": "test_collection_name",
  "project": "default",
  "name": "custom_pipeline_01",
  "cpu_quota": 2,
  "auto_sync_doc": true
}'

响应消息

执行成功返回：

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: 120
Content-Type: application/json

{
"code": 1000003,
"message": "invalid request: cannot update default pipeline",
"request_id": "021695029757920fd001de6666600000000000000000002569b8f"
}

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

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

状态码说明 #

请求消息 #

响应消息 #

状态码说明

请求消息

响应消息