You need to enable JavaScript to run this app.
导航
update
最近更新时间:2024.12.11 22:16:15首次发布时间:2024.11.08 14:04:09

概述

/api/knowledge/point/update 接口用于更新知识库下的切片内容,目前可以更新非结构化切片的content字段和结构化切片的fields字段。

前置条件

完成“签名鉴权方式“页面的注册账号、实名认证、AK/SK 密钥获取和签名获取后,可调用 API 接口实现更新知识库下的切片内容的功能。

请求接口

URI

/api/knowledge/point/updata

统一资源标识符

请求方法

POST

客户端对向量数据库服务器请求的操作类型

请求头

Content-Type: application/json

请求消息类型

Authorization: HMAC-SHA256 ***

鉴权

请求参数

参数

类型

必选

默认值

备注

collection_name

string

--

知识库名称

  • 只能使用英文字母、数字、下划线_,并以英文字母开头,不能为空
  • 长度要求:[1, 64]

project

string

default

知识库所属项目
即在【访问控制】-【资源管理】-【项目】中创建的项目

resource_id

string

--

知识库唯一 id
可选择直接传 resource_id,或同时传 name 和 project 作为知识库的唯一标识

point_id

string

--

要更新的切片 id

content

string

二者只传一个

--

要更新的非结构化文档的切片内容。

fields

list

--

要更新的结构化文档的切片内容,一行数据全量更新。
[
{ "field_name": "xxx" // 字段名称
"field_value": xxxx // 字段值
},
]
字段名称必须已在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

完整示例

请求消息

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", 
    "content": "test content" 
}'

响应消息

执行成功返回:

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"}