全部产品
Search
文档中心

向量检索服务:删除Doc

更新时间:Apr 11, 2024

本文介绍如何通过HTTP API,根据id列表删除Collection中已存在的Doc。

说明

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

前提条件

Method与URL

DELETE https://{Endpoint}/v1/collections/{CollectionName}/docs

使用示例

说明
  1. 需要使用您的api-key替换示例中的YOUR_API_KEY、您的Cluster Endpoint替换示例中的YOUR_CLUSTER_ENDPOINT,代码才能正常运行。

  2. 本示例需要参考新建Collection-使用示例提前创建好名称为quickstart的Collection

curl -XDELETE \
  -H 'dashvector-auth-token: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"ids": ["1", "2"]}' https://YOUR_CLUSTER_ENDPOINT/v1/collections/quickstart/docs

# example output:
# {"request_id":"a0d1fa36-3d66-4f85-b8d6-40bc28cdc196","code":0,"message":"Success","output":[{"doc_op":"delete","id":"1","code":0,"message":""},{"doc_op":"delete","id":"2","code":0,"message":""}]}

入参描述

参数

Location

类型

必填

说明

{Endpoint}

path

str

Cluster的Endpoint,可在控制台Cluster详情中查看

{CollectionName}

path

str

Collection名称

dashvector-auth-token

header

str

api-key

ids

body

array

待删除的Doc id列表

partition

body

str

Partition名称

delete_all

body

bool

是否删除全部partition数据,注意为true时,ids参数须为空

出参描述

字段

类型

描述

示例

code

int

返回值,参考返回状态码说明

0

message

str

返回消息

success

request_id

str

请求唯一id

19215409-ea66-4db9-8764-26ce2eb5bb99

output

array

返回删除的结果,DocOpResult列表