Python 用 SDK を使用して DashVector クライアントを作成する - DashVector

このトピックでは、Python 用 SDK を使用して DashVector クライアントを作成する方法について説明します。

説明

DashVector クライアントを使用すると、DashVector サーバーに接続してコレクションに対する操作を実行できます。

前提条件

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

API 定義

Python

dashvector.Client(
    api_key: str,
    endpoint: str,
    protocol: dashvector.DashVectorProtocol = dashvector.DashVectorProtocol.GRPC,
    timeout: float = 10.0
) -> Client

例

説明

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

Python

import dashvector

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

# クライアントが正常に作成されたかどうかを確認します。
if client:
    print('create client success!')

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

リクエストパラメーター

パラメーター	タイプ	デフォルト値	説明
api_key	str	-	API キー。
endpoint	str	-	クラスターのエンドポイント。
protocol	DashVectorProtocol	DashVectorProtocol.GRPC	オプション。通信プロトコル。有効な値： DashVectorProtocol.GRPC および DashVectorProtocol.HTTP。
timeout	float	10.0	オプション。タイムアウト期間（秒）。値 -1 はタイムアウトなしを示します。

説明

クラスターのエンドポイントを表示するには、コンソールでクラスターの詳細ページに移動します。
パフォーマンス向上のために、protocol パラメーターのデフォルト値 DashVectorProtocol.GRPC を使用することをお勧めします。

レスポンスパラメーター

説明

次の表で説明するように、操作結果を含む Client オブジェクトが返されます。

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