You need to enable JavaScript to run this app.
导航
向量数据库
  • 文档首页
    • /
  • 向量数据库

update_meta

最近更新时间：2024.04.17 14:21:10

首次发布时间：2024.04.17 14:21:10

我的收藏

概述

/api/knowledge/doc/update_meta 接口用于更新文档信息，文档meta信息更新会自动触发索引中的数据更新。

前提条件

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

请求接口

URI

http://api-knowledgebase.ml_platform.cn-beijing.volces.com/api/knowledge/doc/update_meta

统一资源标识符

请求方法

POST

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

请求头

Content-Type: application/json

请求消息类型

Authorization: HMAC-SHA256 ***

鉴权

请求参数

参数

类型

是否必选

默认值

参数说明

collection_name

string

是

知识库的名字。

doc_id

string

是

文档的id。

meta

json

是

文档的meta信息更新，会替换已有的meta。
{
key1: val1,
key2: val2
}
其他限制参考add接口的限制。

响应消息

参数

参数说明

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不存在

1001001

400

doc not exist

doc不存在

完整示例

请求消息

curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: HMAC-SHA256 ***' \
  http://api-knowledgebase.ml_platform.cn-beijing.volces.com/api/knowledge/collection/update \
  -d '{
    "collection_name": "test_collection_name"，
    "doc_id": "test123",
    "meta": {
        "key1": "val1", 
        "key2": "val2"
    }
}'

响应消息

执行成功返回：

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