Python 用 SDK を使用して、ドキュメント ID または ID リストに基づいてコレクションから 1 つ以上のドキュメントを削除します。 - DashVector

このトピックでは、Python 用 SDK を使用して、ドキュメント ID または ID リストに基づいてコレクションから 1 つ以上のドキュメントを削除する方法について説明します。

説明

削除するドキュメントの ID が存在しない場合、そのドキュメントに対する削除操作は無効になります。

前提条件

クラスターが作成されていること。詳細については、クラスターの作成を参照してください。
API キーを取得していること。詳細については、API キーの管理を参照してください。
最新バージョンの SDK がインストールされていること。詳細については、DashVector SDK のインストールを参照してください。

API 定義

Python

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

例

説明

コードを正しく実行するには、サンプルコード内の YOUR_API_KEY を実際の API キーに、YOUR_CLUSTER_ENDPOINT をクラスターのエンドポイントに置き換える必要があります。
quickstart という名前のコレクションを事前に作成する必要があります。詳細については、コレクションの作成トピックの「例」セクションを参照してください。また、事前にいくつかのドキュメントを挿入する必要があります。詳細については、ドキュメントの挿入を参照してください。

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')

# 複数のドキュメントを一度に削除します。
ret = collection.delete(['1','2'])

# パーティションからすべてのデータを削除します。
ret = collection.delete(delete_all=True)

リクエストパラメーター

パラメーター	タイプ	デフォルト値	説明
ids	str または List[str]	-	主キーまたは主キーリスト。
partition	Optional[str]	None	オプション。パーティションの名前。
async_req	bool	False	オプション。非同期モードを有効にするかどうかを指定します。
delete_all	bool	False	オプション。パーティションからすべてのデータを削除するかどうかを指定します。値が True の場合、ids パラメーターは空のままにする必要があります。

レスポンスパラメーター

説明

DashVectorResponse オブジェクトが返されます。これには、次の表に示すように、操作結果が含まれています。

パラメーター	タイプ	説明	例
code	int	返されたステータスコード。詳細については、ステータスコードを参照してください。	0
message	str	返されたメッセージ。	success
request_id	str	リクエストの一意の ID。	19215409-ea66-4db9-8764-26ce2eb5bb99