メインコンテンツまでスキップ

MilvusClient

MilvusClient インスタンスは、特定の Zilliz Cloud クラスターに接続する Python クライアントを表します。

python
pymilvus.MilvusClient

Constructor

一般的なユースケース向けのクライアントを構築します。

Notes

このクライアントは、Zilliz Cloud 上の Create、Read、Update、Delete(CRUD)操作を処理する現在の API セットに対する、使いやすい代替手段として機能します。

python
MilvusClient(
uri: str,
user: str,
password: str,
db_name: str,
token: str,
timeout=None,
**kwargs
)

PARAMETERS:

  • uri (string) -

    Zilliz Cloud クラスターの URI。例:

    • クラスターエンドポイント

      • Free & Serverless

        https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com

      • Dedicated

        https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

    • プロジェクトエンドポイント(On-demand)

      https://{project-id}.{region}.api.zillizcloud.com

  • user (string) -

    指定された Zilliz Cloud クラスターへの接続に使用する有効なユーザー名。

    これは password と併せて使用する必要があります。

  • password (string) -

    指定された Zilliz Cloud クラスターへの接続に使用する有効なパスワード。

    これは user と併せて使用する必要があります。

  • db_name (string) -

    対象の Milvus インスタンスが属するデータベースの名前。

  • token (string) -

    指定された Zilliz Cloud クラスターにアクセスするための有効なアクセストークン。

    これは、userpassword を個別に設定する代わりに推奨される方法として使用できます。

    このフィールドを設定する際は、次の点に注意してください。

    有効なトークンは、次のいずれかである必要があります。

    • 十分な権限を持つ API キー、または

    • 対象のクラスターにアクセスするために使用する ユーザー名とパスワード をコロン(:)で連結したもの。たとえば、これを username:p@ssw0rd に設定できます。これはクラスターエンドポイントを使用する場合にのみ適用されます。

  • timeout (float | None)

    この操作のタイムアウト時間。

    これを None に設定すると、何らかのレスポンスが到着するか、何らかのエラーが発生した時点で、この操作はタイムアウトします。

Examples

python
from pymilvus import MilvusClient

# Authentication enabled with a cluster user
client = MilvusClient(
uri="https://inxx-xxxxxxxxxxxx.api.gcp-us-west1.zillizcloud.com:19530",
token="user:password", # replace this with your token,
db_name="default"
)
Notes

uri をクラスターエンドポイントに設定してください。token パラメーターには、十分な権限を持つ Zilliz Cloud API キー、または username:p@ssw0rd 形式のクラスターユーザーの認証情報を指定できます。