update_meta--向量数据库VikingDB-火山引擎

文档中心

立即注册

导航

update_meta

最近更新时间：2024.09.06 18:27:19首次发布时间：2024.04.17 14:21:10

概述

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

前提条件

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

请求接口

URI	/api/knowledge/doc/update_meta	统一资源标识符
请求方法	POST	客户端对向量数据库服务器请求的操作类型
请求头	Content-Type: application/json	请求消息类型
请求头	Authorization: HMAC-SHA256 ***	鉴权

请求参数

参数	子参数	类型	是否必选	默认值	参数说明
collection_name	--	string	否	--	知识库名称只能使用英文字母、数字、下划线_，并以英文字母开头，不能为空长度要求：[1, 64]
project	--	string	否	default	知识库所属项目即在【访问控制】-【资源管理】-【项目】中创建的项目
resource_id	--	string	否	--	知识库唯一 id 可选择直接传 resource_id，或同时传 name 和 project 作为知识库的唯一标识
doc_id	--	string	是	--	知识库下待更新文档的 id
meta		array 或 array 对应的json 字符串	否	--	meta 信息 "add_type" == "url" 时，该字段有效 add_type 为其他值时，该字段无效
	field_name	string	否	--	字段名不能为 “doc_id” 使用英文字母，数字，下划线，并以英文字母开头，长度不得超过 128 存在于 collection 的 fields 中的 field_name 可以用于在检索时的字段筛选，不存在的只能用于信息展示(注意类型需要保持一致）
	field_type	string	否	--	字段类型支持 "int64"，"float32"，"string"，"bool"，"list<string>" 类型，限制参考VikingDB的field_type规则和说明
	field_value	与 field_type指定类型一致	否	--	字段值

响应消息

参数	参数说明
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 ***' \
  https://api-knowledgebase.mlp.cn-beijing.volces.com/api/knowledge/doc/update_meta \
  -d '{
    "collection_name": "test_collection_name"，
    "project": "",
    "doc_id": "test123",
    "meta":[
    {"field_name":"行业","field_type":"string", "field_value":"企业服务"},
    {"field_name":"是否公开","field_type":"bool", "field_value":True},
    ]
}'

响应消息

执行成功返回：

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