@re-ai/volc-knowledge/docs/参考文档/知识库/update.md

火山引擎知识库接口接入SDK

# 更新知识库信息接口文档
## 一、接口概述
`/api/knowledge/collection/update`接口用于更新已创建的知识库信息，目前仅支持更新知识库的描述（description）、CPU配额（cpu_quota）和标签（fields）。更新标签后，前端会自动同步并覆盖为更新后的内容。

## 二、前提条件
完成“签名鉴权方式”页面的注册账号、实名认证、AK/SK密钥获取和签名获取后，才可以调用此API接口来实现知识库信息更新功能。

## 三、请求接口
|参数|详情|描述|
|---|---|---|
|URI|`/api/knowledge/collection/update`|统一资源标识符|
|请求方法|POST|客户端对向量数据库服务器请求的操作类型|
|请求头|`Content-Type: application/json`<br>`Authorization: HMAC-SHA256 ***`|请求消息类型<br>鉴权|

## 四、请求参数
|参数|类型|是否必选|默认值|参数说明|
|---|---|---|---|---|
|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": "xxx"}]`|

## 五、响应消息
|参数|参数说明|
|---|---|
|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不存在|

## 七、完整示例
### （一）请求消息
```bash
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
}'
```

### （二）响应消息
1. **执行成功返回**
```json
HTTP/1.1 200 OK
Content-Length: 43
Content-Type: application/json
{"code":0,"message":"success","request_id":"021695029537650fd001de666660000000000000000000230da93"}
```
2. **执行失败返回**
```json
HTTP/1.1 400 OK
Content-Length: 43
Content-Type: application/json
{"code":1000003, "message":"invalid request：%s", "request_id": "021695029757920fd001de6666600000000000000000002569b8f"}
```