すべてのプロダクト
Search
ドキュメントセンター

DashVector:コレクションの作成

最終更新日:Jan 08, 2025

このトピックでは、SDK for Python を使用してコレクションを作成する方法について説明します。

前提条件

  • クラスターが作成されていること。詳細については、「クラスターの作成」をご参照ください。

  • APIキーが取得されていること。詳細については、「APIキーの管理」をご参照ください。

  • 最新バージョンの SDK がインストールされていること。詳細については、「DashVector SDK のインストール」をご参照ください。

API 定義

Client.create(
    name: str,
    dimension: int,
    dtype: Union[Type[int], Type[float]] = float,
    fields_schema: Optional[Dict[str, Union[Type[str], Type[int], Type[float], Type[bool]]]] = None,
    metric: str = 'cosine',
    timeout: Optional[int] = None
) -> DashVectorResponse

説明

コードを正しく実行するには、サンプルコード内の YOUR_API_KEY を実際の API キーに、YOUR_CLUSTER_ENDPOINT をクラスターのエンドポイントに置き換える必要があります。

import dashvector

client = dashvector.Client(
    api_key='YOUR_API_KEY',
    endpoint='YOUR_CLUSTER_ENDPOINT'
)

# コレクションを作成し、名前を quickstart、ベクトル次元数を 4、
# ベクトルのデータ型をデフォルト値の float、
# 距離メトリックを dotproduct に設定します。
# name、weight、および age フィールドを事前に定義し、それぞれのデータ型を str、float、および int に設定します。
# タイムアウトを -1 に設定して、create メソッドの非同期モードを有効にします。
ret = client.create(
    name='quickstart', 
    dimension=4, 
    metric='dotproduct', 
    dtype=float,
    fields_schema={'name': str, 'weight': float, 'age': int},
    timeout=-1
)


# コレクションが正常に作成されたかどうかを確認します。
if ret:
    print('create collection success!')
# 次のコードを使用して、コレクションが正常に作成されたかどうかを確認することもできます。
# from dashvector import DashVectorCode
# if ret.code == DashVectorCode.Success:
#     print('create collection success!')

リクエストパラメーター

パラメーター

タイプ

デフォルト値

説明

name

str

-

作成するコレクションの名前。

dimension

int

-

ベクトル次元数。

dtype

Union[Type[int], Type[float]]

float

オプション。ベクトルのデータ型。

fields_schema

Optional[Dict[str,Union[Type[str],

Type[int], Type[float],

Type[bool]]]]

None

オプション。事前に定義されたフィールド。

metric

str

cosine

オプション。距離メトリック。有効な値:euclideandotproduct、および cosine

値が cosine の場合、dtypefloat に設定する必要があります。

timeout

Optional[int]

None

  • オプション。タイムアウト期間。timeout を None に設定すると、メソッドは同期モードで動作し、コレクションが正常に作成されたときにレスポンスを返します。

  • timeout を -1 に設定すると、メソッドは非同期モードで動作します。

  • timeout を 0 以上の値に設定すると、create は同期モードで動作し、指定されたタイムアウト期間内に操作結果を待機します。指定されたタイムアウト期間内にコレクションの作成に失敗した場合、メソッドはタイムアウトエラーを返します。

説明

コレクションの作成時にフィールドを事前に定義することの利点については、「スキーマフリー」をご参照ください。

レスポンスパラメーター

説明

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

パラメーター

タイプ

説明

code

int

返されたステータスコード。詳細については、「ステータスコード」をご参照ください。

0

message

str

返されたメッセージ。

success

request_id

str

リクエストの一意の ID。

19215409-ea66-4db9-8764-26ce2eb5bb99