Python SDK を使用してドキュメントをアップサート - DashVector

upsert 操作は、ID が存在しない場合に新しいドキュメントをコレクションに挿入します。ID がすでに存在する場合は、代わりに更新が実行されます。

Doc ID が指定されていない場合、DashVector は自動的に ID を生成し、応答で返します。

前提条件

作業を開始する前に、以下の項目を準備してください。

クラスター
API キー
最新バージョンの DashVector SDK

API 定義

Collection.upsert(
    docs: Union[Doc, List[Doc], Tuple, List[Tuple]],
    partition: Optional[str] = None,
    async_req: False
) -> DashVectorResponse

使用例

すべての使用例で、以下のクライアントおよびコレクションの設定を使用します。

import dashvector
from dashvector import Doc
import numpy as np

# 実際の認証情報に置き換えてください
client = dashvector.Client(
    api_key='YOUR_API_KEY',
    endpoint='YOUR_CLUSTER_ENDPOINT'
)

# 'quickstart' という名前の既存のコレクションを使用します。
# コレクションの作成方法については、「https://www.alibabacloud.com/help/vrs/latest/new-collection#hivl6」をご参照ください。
collection = client.get(name='quickstart')

以下のプレースホルダーを実際の値に置き換えてください。

プレースホルダー	説明
`YOUR_API_KEY`	認証用の API キー
`YOUR_CLUSTER_ENDPOINT`	クラスターのエンドポイント URL

単一ドキュメントのアップサート

# Doc オブジェクトを使用したアップサート
ret = collection.upsert(
    Doc(
        id='1',
        vector=[0.1, 0.2, 0.3, 0.4]
    )
)
assert ret

# タプルを使用したアップサート（省略記法）
ret = collection.upsert(
    ('2', [0.1, 0.1, 0.1, 0.1])               # (id, vector)
)

フィールド付きドキュメントのアップサート

# 事前定義済みフィールドおよびスキーマフリーなフィールドを含むアップサート
ret = collection.upsert(
    Doc(
        id='3',
        vector=np.random.rand(4),
        fields={
            # 事前定義されたフィールド（型はコレクションのスキーマと一致させる必要があります）
            'name': 'zhangsan', 'weight': 70.0, 'age': 30,
            # スキーマフリーなフィールド（str、int、bool、float のいずれか）
            'anykey1': 'str-value', 'anykey2': 1,
            'anykey3': True, 'anykey4': 3.1415926
        }
    )
)

# タプルを使用してフィールド付きでアップサート
ret = collection.upsert(
    ('4', np.random.rand(4), {'foo': 'bar'})  # (id, vector, fields)
)

複数ドキュメントのアップサート

# Doc オブジェクトを使用して 10 件のドキュメントを一括アップサート
ret = collection.upsert(
    [
        Doc(id=str(i+5), vector=np.random.rand(4)) for i in range(10)
    ]
)

# タプルを使用して 3 件のドキュメントを一括アップサート
ret = collection.upsert(
    [
        ('15', [0.2, 0.7, 0.8, 1.3], {'age': 20}),
        ('16', [0.3, 0.6, 0.9, 1.2], {'age': 30}),
        ('17', [0.4, 0.5, 1.0, 1.1], {'age': 40})
    ]                                         # List[(id, vector, fields)]
)

assert ret

非同期でのドキュメントアップサート

async_req=True を設定すると、アップサート操作がノンブロッキング呼び出しとして実行されます。結果を取得するには、返された future オブジェクトに対して .get() を呼び出します。

# 10 件のドキュメントを非同期でアップサート
ret_funture = collection.upsert(
    [
        Doc(id=str(i+18), vector=np.random.rand(4), fields={'name': 'foo' + str(i)}) for i in range(10)
    ],
    async_req=True
)

# 操作が完了するまでブロック
ret = ret_funture.get()

疎ベクトル付きドキュメントのアップサート

インデックスと値をマップする sparse_vector 辞書を渡します。

ret = collection.upsert(
    Doc(
        id='28',
        vector=[0.1, 0.2, 0.3, 0.4],
        sparse_vector={1: 0.4, 10000: 0.6, 222222: 0.8}
    )
)

リクエストパラメーター

パラメーター	型	デフォルト	説明
`docs`	`Union[Doc, List[Doc], Tuple, List[Tuple]]`	-	アップサートする 1 つ以上のドキュメント。必須です。
`partition`	`Optional[str]`	`None`	対象のパーティション名。
`async_req`	`bool`	`False`	非同期モードを有効化します。

タプルのフォーマット：

Doc オブジェクトの代わりにタプルを渡す場合、要素は次の順序に従う必要があります：(id, vector) または (id, vector, fields)。

フィールドの制約：

「Doc」オブジェクトの各フィールドは、以下の条件を満たすキーと値のペアです。

キーは str 型である必要があります。
値は str、int、bool、または float 型である必要があります。
コレクション作成時にキーが事前定義されている場合、値の型は事前定義された型と一致する必要があります。
事前定義されていないキーはスキーマフリーであり、サポートされている任意の値型を受け入れます。

応答パラメーター

このメソッドは DashVectorResponse オブジェクトを返します。

パラメーター	型	説明	例
`code`	`int`	ステータスコード。`0` は成功を示します。詳細については、「ステータスコード」をご参照ください。	`0`
`message`	`str`	結果メッセージ。	`success`
`request_id`	`str`	一意のリクエスト識別子。	`19215409-ea66-4db9-8764-26ce2eb5bb99`