Method 与 URL
更新或新增文件标量字段:
POST https://{实例访问 IP 地址}:{实例网络端口}/ai/documentSet/update
。说明:
支持通过主键(DocumentSet ID)或 文件名,搭配 Filter 表达式过滤需更新的文件。
支持新增字段,支持更改部分字段。新增字段,在创建 CollectionView 时没有为这些字段指定索引方式,那么新增这些字段时,系统不会自动为其创建索引。
注意:
不能变更系统分配的 DocumentSet ID 字段,不要求事务完整性。
不能变更已上传的文件内容。
使用示例
如下示例,修改指定文件名,且满足 Filter 表达式的文件的 meta 信息字段 author。
curl -i -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer account=root&api_key=A5VOgsMpGWJhUI0WmUbY********************' \\http://10.0.X.X:80/ai/documentSet/update \\-d '{"database": "db-test-ai","collectionView": "coll-ai-files","query":{"documentSetName": ["腾讯云向量数据库.pdf"],"filter": "author=\\"Tencent\\""},"update": {"author": "tencent"}}'
如下示例,修改指定文件 ID,且满足 Filter 表达式的文件的 meta 信息字段 author。
curl -i -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer account=root&api_key=A5VOgsMpGWJhUI0WmUbY********************' \\http://10.0.X.X:80/ai/documentSet/update \\-d '{"database": "db-test-ai","collectionView": "coll-ai-files","query":{"documentSetId": ["1179017994589437952"],"filter": "author=\\"Tencent\\""},"update": {"author": "tencent"}}'
请求参数
参数名称 | 参数含义 | 子参数 | 是否必选 | 配置方法及要求 |
database | 指定要更文档的 Database 名称。 | - | 是 | |
collectionView | 指定要更新文档的 Collection 名称。 | - | 是 | |
query | 设置查询条件检索需更新的文档 | documentSetName | 否 | 表示要更新的 DocumentSet 的文件名称,可以批量更新,数据元素最大值为20。 说明: 同时配置 documentSetName 与 filter 参数,更新数据将会取二者的并集。 |
| | documentSetId | 否 | 表示要更新的 DocumentSet 的 ID,可以批量更新,数据元素最大值为20。 说明: 同时配置 documentSetId 与 filter 参数,更新数据将会取二者的并集。 |
| | filter | 否 | 使用创建 CollectionView 指定的 Filter 索引的字段设置查询过滤表达式。 <field_name>:表示要过滤的字段名。 <operator>:表示要使用的运算符。 string :匹配单个字符串值(=)、排除单个字符串值(!=)、匹配任意一个字符串值(in)、排除所有字符串值(not in)。其对应的 Value 必须使用英文双引号括起来。 uint64:大于(>)、大于等于(>=)、等于(=)、小于(<)、小于等于(<=)。例如:expired_time > 1623388524。 array:数组类型,包含数组元素之一(include)、排除数组元素之一(exclude)、全包含数组元素(include all)。例如,name include (\\"Bob\\", \\"Jack\\")。 <value>:表示要匹配的值。 示例: Filter('author="jerry"').And('page>20') |
update | 设置需更新的字段 | old_field | 否 | 当前已存在的字段,更新字段对应的数据。 类型:string 字符长度要求:[1,256]。 |
| | new_field | 否 | 新增字段,并给新字段赋值。 类型:string。 字符长度要求:[1,256]。 |
响应消息
{"code":0,"msg":"Operation success, requestId: 0945972e7aca9b1784bbef57c8e7d867","affectedCount":0}
参数名 | 参数含义 |
affectedCount | 更新的文档数量。如果该参数返回的值为0,说明更新无效。 |