通过HTTP API,根据id或id列表删除Collection中已存在的Doc_向量检索服务(VRS)-阿里云帮助中心

本文介绍如何通过Python SDK，根据ID或ID列表删除Collection中已存在的Doc。

说明

如果指定id不存在，则删除对应Doc的操作无效。

前提条件

已创建Cluster：创建Cluster。
已获得API-KEY：API-KEY管理。
已安装最新版SDK：安装DashVector SDK。

接口定义

Python

Collection.delete(
    ids: Union[str, List[str]],
    partition: Optional[str] = None,
    async_req: bool = False,
    delete_all: bool = False
) -> DashVectorResponse

使用示例

说明

需要使用您的api-key替换示例中的YOUR_API_KEY、您的Cluster Endpoint替换示例中的YOUR_CLUSTER_ENDPOINT，代码才能正常运行。
本示例需要参考新建Collection-使用示例提前创建好名称为quickstart的Collection，并参考插入Doc提前插入部分数据。

Python

import dashvector

client = dashvector.Client(
    api_key='YOUR_API_KEY',
    endpoint='YOUR_CLUSTER_ENDPOINT'
)
collection = client.get(name='quickstart')

ret = collection.delete('1')
# 判断delete接口是否成功
if ret:
    print('delete success')

# 批量delete
ret = collection.delete(['1','2'])

# 清理所有partition数据
ret = collection.delete(delete_all=True)

入参描述

参数	类型	默认值	说明
ids	str or List[str]	-	主键或主键list
partition（可选）	Optional[str]	None	Partition名称
async_req（可选）	bool	False	是否异步
delete_all（可选）	bool	False	是否删除全部partition数据，注意为True时，ids参数须为空

出参描述

说明

返回结果为DashVectorResponse对象，DashVectorResponse对象中可获取本次操作结果信息，如下表所示。

字段	类型	描述	示例
code	int	返回值，参考返回状态码说明	0
message	str	返回消息	success
request_id	str	请求唯一id	19215409-ea66-4db9-8764-26ce2eb5bb99
output	List[DocOpResult]	返回删除Doc的结果
usage	RequestUsage	对Serverless实例（按量付费）集合的Doc删除请求，成功后返回实际消耗的写请求单元数