Object Storage Service:ベクトルインデックスの一覧表示 (Python SDK V2)

権限

Alibaba Cloud アカウントには、すべての API にアクセスするための完全な権限があります。デフォルトでは、RAM ユーザーおよび RAM ロールはこの操作を呼び出せません。必要な権限を付与するには、RAM ポリシーまたはバケットポリシーを作成してアタッチする必要があります。

メソッド定義

Python SDK V2 は、ベクトルインデックスを一覧表示するために、2 つのメソッドを提供しています：

• list_vector_indexes()：API を直接呼び出します。 ページングは手動で処理する必要があります。

• list_vector_indexes_paginator()：ページネーターを使用します。 ソフトウェア開発キット (SDK) が自動的にページングロジックを処理します。 このメソッドの使用を推奨します。

# 直接呼び出す
list_vector_indexes(request: ListVectorIndexesRequest, **kwargs) → ListVectorIndexesResult

list_vector_indexes メソッドの完全な定義については、list_vector_indexes をご参照ください。

# ページネーターを使用する
list_vector_indexes_paginator(**kwargs) → ListVectorIndexesPaginator[source]

list_vector_indexes_paginator メソッドの完全な定義については、list_vector_indexes_paginator をご参照ください。

サンプルコード

import argparse
import alibabacloud_oss_v2 as oss
import alibabacloud_oss_v2.vectors as oss_vectors

# ベクトルインデックス一覧表示のサンプル
parser = argparse.ArgumentParser(description="list vector indexes sample")

# バケットが配置されているリージョン。
parser.add_argument('--region', help='The region where the bucket is located.', required=True)
# OSS のアクセスエンドポイント。
parser.add_argument('--endpoint', help='The OSS access endpoint.')
# アカウント ID。
parser.add_argument('--account_id', help='The account ID.', required=True)
# バケットの名前。
parser.add_argument('--bucket', help='The name of the bucket.', required=True)

def main():

    args = parser.parse_args()

    # 環境変数から認証情報の値を読み込みます。
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # SDK のデフォルト設定を使用します。
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region
    cfg.account_id = args.account_id
    # パブリックネットワーク経由で接続するには、これを False に設定するか、この行を削除します。
    cfg.use_internal_endpoint = True
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    client = oss_vectors.Client(cfg)

    # ListVectorIndexes API のページネーターを作成します。
    paginator = client.list_vector_indexes_paginator()

    # ベクトルインデックスのページを反復処理します。
    for page in paginator.iter_page(oss_vectors.models.ListVectorIndexesRequest(
        bucket=args.bucket
        )
    ):
        for o in page.indexes:
            print(f'Index: {o.get("indexName")}, {o.get("dataType")}, {o.get("dimension")}, {o.get("status")}')

if __name__ == "__main__":
    main()

参考資料

ベクトルインデックスを一覧表示するための完全なサンプルコードについては、「list_vector_indexes.py」をご参照ください。