功能介绍
delete() 接口用于删除指定 id(Document ID)的文档。
接口约束
索引类型为 FLAT,不支持删除。
请求示例
如下示例已经通过 create_database() 创建数据库 db_test,已通过 create_collection() 创建集合为 book-vector,已使用 upsert() 插入数据,通过 delete() 删除指定的 Document。
import tcvectordbfrom tcvectordb.model.document import Document, Filter, SearchParamsfrom tcvectordb.model.enum import FieldType, IndexType, MetricType, ReadConsistency#create a database client objectclient = tcvectordb.VectorDBClient(url='http://10.0.X.X', username='root', key='eC4bLRy2va******************************
', read_consistency=ReadConsistency.EVENTUAL_CONSISTENCY, timeout=30)db = client.database('db-test')coll = db.collection('book-vector')# delete# 删除指定 id(Document ID),并满足 Filter 表达式的文档。coll.delete(document_ids=['0001', '0002', '0003'], filter=Filter(Filter.In("bookName",["三国演义", "西游记"])))# 删除之后,确认book-vector 的文档doc_list = coll.query(document_ids=['0001','0002', '0003'], retrieve_vector=True, limit=3)# 输出确认结果,仅输出 0003 的数据。for doc in doc_list:print(doc)
仅输出 id 为 0003 的数据,如下所示。
{'id': '0003', 'vector': [0.21230000257492065, 0.20999999344348907, 0.21299999952316284], 'bookName': '红楼梦', 'page': 23, 'author': '曹雪芹'}
请求参数
参数名 | 是否必选 | 参数含义 | 配置方法 |
document_ids | 否 | 表示要删除的 Document 的 ID。 | ID 长度限制为[1,128]。 批量删除,数据元素最大值为20。 |
filter | 否 | 使用创建 Collection 指定的 Filter 索引的字段设置查询过滤表达式 | Filter 的表达式格式为 '<field_name><operator><value>',多个表达式之间支持 and(与)、or(或)、not(非)关系。具体信息,请参见 Filter 条件表达式。其中 <field_name>:表示要过滤的字段名。 <operator>:表示要使用的运算符。 string :匹配单个字符串值(=)、排除单个字符串值(!=)、匹配任意一个字符串值(in)、排除所有字符串值(not in)。其对应的 Value 必须使用英文双引号括起来。 unit64:大于(>)、大于等于(>=)、等于(==)、小于(<)、小于等于(<=)。例如:expired_time > 1623388524。 array:数组类型,包含数组元素之一(include)、排除数组元素之一(exclude)、全包含数组元素(include all)。例如,name include (\\"Bob\\", \\"Jack\\")。 <value>:表示要匹配的值。 示例: Filter('author="jerry"').And('page>20')。 |
timeout | 否 | 请求超时时间。 | 单位:秒。 默认值:VectorDBClient()接口配置的 timeout 时长。 取值范围:大于等于0。 |