@re-ai/volc-knowledge
Version:
火山引擎知识库接口接入SDK
69 lines (62 loc) • 2.81 kB
Markdown
原网页在接口路径上存在错误,请求URI应为`/api/knowledge/point/delete`,而不是`/api/knowledge/point/add`。下面是纠正错误后整理的接口文档:
# 删除知识库切片接口文档
## 一、接口概述
`/api/knowledge/point/delete`接口用于删除指定知识库下的特定切片。通过该接口,用户能够从知识库中移除不需要的切片数据。
## 二、前置条件
完成“签名鉴权方式”页面的注册账号、实名认证、AK/SK密钥获取和签名获取后,方可调用此API接口执行删除切片操作。
## 三、请求接口
|参数|详情|描述|
|---|---|---|
|URI|`/api/knowledge/point/delete`|统一资源标识符|
|请求方法|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,若切片id不存在会返回报错信息|
## 五、响应消息
|字段|备注|
|---|---|
|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不存在|
|1002001|400|point not exist|point_id不存在|
## 七、完整示例
### (一)请求消息
```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/delete \
-d '{
"collection_name": "test_collection_name",
"point_id": "your_point_id"
}'
```
### (二)响应消息
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"}
```