本文介紹如何通過Python SDK，根據ID或ID列表刪除Collection中已存在的Doc。
說明
如果指定id不存在，則刪除對應Doc的操作無效。
前提條件
已建立Cluster：建立Cluster。
已獲得API-KEY：API-KEY管理。
已安裝最新版SDK：安裝DashVector SDK。
介面定義
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提前插入部分資料。
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的結果 |