update--火山方舟大模型服务平台-火山引擎

文档中心

立即注册

导航

update

最近更新时间：2024.12.16 16:46:18首次发布时间：2024.12.16 16:46:18

本节将说明如何更新一个已创建的知识库信息。

说明

当前仅支持更新知识库的 description、cpu_quota 和 fields（标签）。
当前通过 collection/update 接口成功更新 fields（标签）字段后，前端会自动同步并覆盖为更新后的内容。

概述

/api/knowledge/collection/update 接口用于更新知识库信息。

前提条件

完成“对接指南“页面的注册账号、实名认证、AK/SK 密钥获取和签名获取后，可调用 API 接口实现知识库信息更新的功能。

请求接口

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

请求参数

参数	类型	是否必选	默认值	参数说明
name	string	否	--	知识库的名字只能使用英文字母、数字、下划线_，并以英文字母开头，不能为空长度要求：[1-64]
project	string	否	default	知识库所属项目即在【访问控制】-【资源管理】-【项目】中创建的项目。
resource_id	string	否	--	知识库的唯一 id 可选择直接传 resource_id ，或同时传 name 和 project 作为知识库的唯一标识。
description	string	否	--	知识库描述信息长度要求：[1, 65535]
cpu_quota	int	否	--	cpu 配额
fields	list		--	标签标签修改逻辑为覆盖，且目前仅支持新增/删除，暂不支持更新标签类别或标签值 `[ { "field_name": "xxx" // 标签名称 "field_type": "xxx" //标签类型 "default_val": xxxx // 标签值 }, ]`

响应消息

参数	参数说明
code	状态码
message	返回信息
request_id	标识每个请求的唯一标识符

状态码说明

状态码	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: HMAC-SHA256 ***' \
  https://api-knowledgebase.mlp.cn-beijing.volces.com/api/knowledge/collection/update \
  -d '{
    "name": "test_collection_name",
    "project": "",
    "description": "这是一个测试知识库",
    "cpu_quota": 1
}'

响应消息

执行成功返回：

HTTP/1.1 200 OK
Content-Length: 43
Content-Type: application/json
 
{"code":0,"message":"success","request_id":"021695029537650fd001de666660000000000000000000230da93"}

执行失败返回：

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