接口定义
update() 接口用于对通过主键（Document ID）与 Filter 表达式过滤检索 Document ，对 Document 的部分字段进行更新，同时支持新增字段。
public AffectRes update(String database, String collection, UpdateParam param, Document document)
使用示例
集合未配置 Embedding 参数，则直接更新向量数据。如下示例，在集合 book-vector 中，基于 upsert() 插入的向量数据，通过 documentIds 与 filter 表达式，过滤出需更新的 Document，更新其 vectors 字段的向量数据，并更新 page 字段值为30，新增字段 test_new_field。
实例在创建 Collection 时，已配置 Embedding 模型，通过 upsert() 写入原始文本，则可输入文本信息，通过 Embedding 将数据向量化更新向量数据。如下示例，基于 upsert() 插入的原始文本，使用 update 接口，通过 documentIds 与 filter 表达式过滤数据，更新其 text 字段的文本信息，更新 page 字段值为100，并新增字段 test_new_field。
//设置 更新字段Document updateDoc = Document.newBuilder().addDocField(new DocField("page", 100)).addDocField(new DocField("text", "天下大势，分久必合")).addDocField(new DocField("test-new-field", 50)).build();// 过滤更新的文档UpdateParam updateParam = UpdateParam.newBuilder().addAllDocumentId(Arrays.asList("0001", "0003")).withFilter(new Filter("bookName=\\"三国演义\\"").build();// updateAffectRes affectRes = client.update("db-test", "book-emb", updateParam, updateDoc);System.out.println("\\tres: " + affectRes);
集合未配置 Embedding 参数，则直接更新向量数据。如下示例，在集合 book-vector 中，基于 upsert() 插入的向量数据，通过 documentIds 与 filter 表达式，过滤出需更新的 Document，更新其 vectors 字段的向量数据，并更新 page 字段值为100，新增字段 test_new_field。
//设置更新字段Document updateDoc = Document.newBuilder().addDocField(new DocField("page", 100)).withVector(Arrays.asList(0.2123, 0.29, 0.213)).addDocField(new DocField("test-new-field", 50)).build();// 过滤更新的文档UpdateParam updateParam = UpdateParam.newBuilder().addAllDocumentId(Arrays.asList("0001", "0003")).withFilter(new Filter("bookName=\\"三国演义\\"")).build();// updateprivate static final String DBNAME = "db-test";private static final String COLL_NAME = "book-vector";List<Document> qdos = client.update(DBNAME, COLL_NAME, updateParam, updateDoc);for (Document doc : qdos) {System.out.println(doc.toString());}
入参描述
参数 | 参数含义 | 子参数 | 是否必选 | 子参数含义 |
database | 指定删除数据的数据库名。 | - | 是 | Database 命名要求如下： 只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。 长度要求：[1,128]。 |
collection | 指定删除数据的集合名。 | - | 是 | Collection 命名要求如下： 只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。 长度要求：[1,128]。 |
updateParam | 过滤需更新的文档 | DocumentIds | 是 | 设置需更新的文档 ID。每个 ID 长度限制为[1,128]。支持批量查询，数组元素范围[1,20]。 |
| | Filter | 否 | 使用创建 Collection 指定的 Filter 索引的字段设置查询过滤表达式。Filter 表达式格式为 <field_name><operator><value>，多个表达式之间支持 and（与）、or（或）、not（非）关系。具体信息，请参见 Filter 条件表达式。其中： <field_name>：表示要过滤的字段名。 <operator>：表示要使用的运算符。 string ：匹配单个字符串值（=）、排除单个字符串值（!=）、匹配任意一个字符串值（in）、排除所有字符串值（not in）。其对应的 Value 必须使用英文双引号括起来。 uint64：大于（>）、大于等于（>=）、等于（=）、小于（<）、小于等于（<=）。例如：expired_time > 1623388524。 array：数组类型，包含数组元素之一（include）、排除数组元素之一（exclude）、全包含数组元素（include all）。例如，name include (\\"Bob\\", \\"Jack\\")。 json：json 类型的 Filter 表达式语法和 json 字段的键值类型保持一致。若访问 Json 对象中的键，使用点（.）符号连接。例如：Json 类型的字段 bookInfo ，其键 bookName 的 Filter 表达式如下所示。更多信息，请参见 Json 类型表达式。
<value>：表示要匹配的值。 示例： new Filter("author=\\"jerry\\"").and("page>20") |
updateDoc | 设置需更新的字段 | vector | 否 | 更新 vector 字段的向量数据。 说明： 如果 Collection 在创建时，未配置 Embedding 参数，或者该实例并未开通 Embedding 功能，则只能配置该参数，输入向量数据，更新数据。 |
| | text | 否 | Embedding 模型输入文本的字段名。该字段在创建 Collection 时定义。本示例为 text 。 string：字符型。 float：浮点型数据。 说明： 如果 Collection 在创建时，已配置 Embedding 参数，则只能配置该参数，依据输入的文本信息更新向量数据，并将文本字段与向量数据更新存于数据库。 |
| | old_field | 否 | 当前已存在的字段，更新字段对应的数据。 类型：string 字符长度要求：[1,256]。 |
| | new_field | 否 | 新增字段，并给新字段赋值。 类型：string。 字符长度要求：[1,256]。 |
出参描述
res: AffectRes{affectedCount=1, code=0, msg='operation success'}
参数名 | 参数含义 |
affectedCount | 更新的文档数量。如果该参数返回的值为0，说明更新无效。 |
