本文介紹如何通過HTTP API,根據id列表刪除Collection中已存在的Doc。
說明
如果指定id不存在,則刪除對應Doc的操作無效。
前提條件
Method與URL
DELETE https://{Endpoint}/v1/collections/{CollectionName}/docs
使用示例
說明
需要使用您的api-key替換示例中的YOUR_API_KEY、您的Cluster Endpoint替換示例中的YOUR_CLUSTER_ENDPOINT,代碼才能正常運行。
本示例需要參考新建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列表 | |
usage | map | 對Serverless實例(按量付費)集合的Doc刪除請求,成功后返回實際消耗的寫請求單元數 |
|
文檔內容是否對您有幫助?