このトピックでは、HTTP API を使用して、ドキュメント ID リストに基づいてコレクションからドキュメントを削除する方法について説明します。
更新対象のドキュメントの ID が存在しない場合、そのドキュメントに対する削除操作は無効になります。
前提条件
クラスターが作成されていること。詳細については、「クラスターの作成」をご参照ください。
API キーを取得していること。詳細については、「API キーの管理」をご参照ください。
最新バージョンの SDK がインストールされていること。詳細については、「DashVector SDK のインストール」をご参照ください。
メソッドと URL
DELETE https://{Endpoint}/v1/collections/{CollectionName}/docs例
サンプルコードを正しく実行するには、YOUR_API_KEY を実際の API キーに、YOUR_CLUSTER_ENDPOINT をクラスターのエンドポイントに置き換える必要があります。
quickstartという名前のコレクションを事前に作成する必要があります。詳細については、「コレクションの作成」トピックの「例」セクションをご参照ください。
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":"19215409-ea66-4db9-8764-26ce2eb5bb99","code":0,"message":""}リクエストパラメーター
パラメーター | 場所 | タイプ | 必須 | 説明 |
{Endpoint} | パス | str | はい | クラスターのエンドポイント。エンドポイントは、コンソールの クラスターの詳細 ページで確認できます。 |
{CollectionName} | パス | str | はい | コレクションの名前。 |
dashvector-auth-token | ヘッダー | str | はい | API キー。 |
ids | 本文 | 配列 | はい | 削除する ドキュメント の ID リスト。 |
partition | 本文 | str | いいえ | パーティションの名前。 |
delete_all | 本文 | bool | いいえ | パーティションからすべてのデータを削除するかどうかを指定します。値が true の場合、ids パラメーターは空にする必要があります。 |
レスポンスパラメーター
パラメーター | タイプ | 説明 | 例 |
code | int | 返されたステータスコード。詳細については、「ステータスコード」をご参照ください。 | 0 |
message | str | 返されたメッセージ。 | success |
request_id | str | リクエストの一意の ID。 | 19215409-ea66-4db9-8764-26ce2eb5bb99 |