@re-ai/volc-knowledge/docs/参考文档/切片/update.md

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

# 更新知识库切片内容接口文档
## 一、接口概述
`/api/knowledge/point/update`接口用于更新知识库下的切片内容，支持更新非结构化切片的`content`字段以及结构化切片的`fields`字段。

## 二、前置条件
完成“签名鉴权方式”页面的注册账号、实名认证、AK/SK密钥获取和签名获取后，方可调用此API接口更新知识库下的切片内容。

## 三、请求接口
|参数|详情|描述|
|---|---|---|
|URI|`/api/knowledge/point/update`|统一资源标识符（原网页中“/api/knowledge/point/updata”疑似拼写错误，应为“update”）|
|请求方法|POST|客户端对向量数据库服务器请求的操作类型|
|请求头|`Content-Type: application/json`<br>`Authorization: HMAC-SHA256 ***`|请求消息类型<br>鉴权|

## 四、请求参数
|参数|类型|是否必选|默认值|备注|
|---|---|---|---|---|
|collection_name|string|否|--|知识库名称，由英文字母、数字、下划线组成，以英文字母开头，不能为空，长度在1 - 64之间|
|project|string|否|default|知识库所属项目，在【访问控制】-【资源管理】-【项目】中创建|
|resource_id|string|否|--|知识库唯一id，可直接传该参数，或同时传`name`和`project`作为知识库的唯一标识|
|point_id|string|是|--|要更新的切片id|
|content|string|与`fields`二者只传一个|--|要更新的非结构化文档的切片内容|
|fields|list|与`content`二者只传一个|--|要更新的结构化文档的切片内容，需一行数据全量更新，字段名称必须已在`collection`里配置，否则报错|
|question|string|否|--|要更新的非结构化faq文档切片的问题字段|

## 五、响应消息
|字段|备注|
|---|---|
|code|状态码|
|message|返回信息|
|request_id|标识每个请求的唯一标识符|
|data|和其他接口保持一致，只返回调用是否成功|

## 六、状态码说明
|code|message|备注|http status_code|
|---|---|---|---|
|0|success|成功|200|
|1000001|unauthorized|缺乏鉴权信息|401|
|1000002|no permission|权限不足|403|
|1000003|invalid request：%s|非法参数|400|
|1000005|collection not exist|collection不存在|400|

## 七、完整示例
### （一）请求消息
```bash
curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: HMAC-SHA256 ***' \
  https://api-knowledgebase.mlp.cn-beijing.volces.com/api/knowledge/point/update \
  -d '{
    "collection_name": "test_collection_name",
    "point_id": "your_point_id",
    "content": "test content"
}'
```

### （二）响应消息
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"}
```