update--向量数据库VikingDB-火山引擎

文档中心

立即注册

导航

update

最近更新时间：2025.07.10 22:22:11首次发布时间：2025.07.10 22:22:11

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

前提条件

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

请求接口

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

请求参数

参数	类型	必选	默认值	备注
collection_name	string	否		知识库名称
project	string	否	default	项目名
resource_id	string	否		知识库唯一 id 可选择直接传 resource_id ，或同时传 name 和 project 作为知识库的唯一标识
name	string	是		实验版本名称不能使用已有系统的默认值 “ default ” 实验版本由字母，数字，下划线组成，并只能以字母开头长度不超过 32 个字符
cpu_quota	int	否		cpu 配额
auto_sync_doc	bool	否		是否自动同步新增文档打开后调用 add_doc 接口向知识库上传文档时，自动同步到当前实验版本

响应消息

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

状态码说明

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

完整示例

请求消息

curl -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: token=****' \
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 delete default pipeline",
"request_id": "021695029757920fd001de6666600000000000000000002569b8f"
}