update_meta--火山方舟大模型服务平台-火山引擎

文档中心

导航

update_meta

最近更新时间：2024.09.06 18:29:50首次发布时间：2024.05.31 15:29:46

概述

update_meta用于更新文档信息，文档meta信息更新会自动触发索引中的数据更新。

请求参数

参数	子参数	类型	是否必选	默认值	参数说明
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 指定类型一致	否	--	字段值

示例

请求参数

请先完成SDK初始化，再运行代码，详见初始化SDK

my_collection = viking_knowledgebase_service.get_collection("example")
doc_id = "doc001"
meta = [
    {"field_name":"行业","field_type":"string", "field_value":"企业服务"},
    {"field_name":"是否公开","field_type":"bool", "field_value":True},
    ]
my_collection.update_meta(doc_id, meta)

返回值

Python 调用执行上面的任务，执行成功无返回信息。