Python SDK v2 を使用して ListVectors API を呼び出し、指定されたベクターインデックス内のすべてのベクターをリストアップします。ページングがサポートされており、大量のベクターデータを走査できます。
権限
デフォルトでは、Alibaba Cloud アカウントはすべての権限を持ちますが、関連する RAM ユーザーおよび RAM ロールには権限がありません。Alibaba Cloud アカウントまたは管理者は、RAM ポリシーまたはバケットポリシーを使用して権限を付与する必要があります。
|
API |
アクション |
説明 |
|
ListVectors |
|
ベクターデータを一覧表示します。 |
メソッドの定義
Python SDK v2 は、ベクターデータをリストアップするために、以下の 2 つのメソッドを提供します:
-
list_vectors():API を直接呼び出します。ページングは手動でハンドルする必要があります。 -
list_vectors_paginator():ページネーターを使用します。SDK がページングロジックを自動的に処理します。このメソッドの使用を推奨します。
list_vectors(request: ListVectorsRequest, **kwargs) → ListVectorsResult[source]
リクエストパラメーター
|
パラメーター |
タイプ |
説明 |
|
request |
ListVectorsRequest |
リクエストパラメーターを設定します。詳細については、「ListVectorsRequest」をご参照ください。 |
戻り値
|
タイプ |
説明 |
|
ListVectorsResult |
戻り値。詳細については、「ListVectorsResult」をご参照ください。 |
ベクターをリストアップするメソッドの完全な定義については、「list_vectors」をご参照ください。
# ページネーターの使用
list_vectors_paginator(**kwargs) → ListVectorsPaginator[source]
戻り値
|
タイプ |
説明 |
|
ListVectorsPaginator |
戻り値。詳細については、「ListVectorsPaginator」をご参照ください。 |
ページネーターを使用してベクターをリストアップするメソッドの完全な定義については、「list_vectors_paginator」をご参照ください。
サンプルコード
import argparse
import alibabacloud_oss_v2 as oss
import alibabacloud_oss_v2.vectors as oss_vectors
parser = argparse.ArgumentParser(description="list vectors sample")
parser.add_argument('--region', help='バケットが配置されているリージョン。', required=True)
parser.add_argument('--endpoint', help='他のサービスが OSS にアクセスするために使用できるドメイン名。')
parser.add_argument('--account_id', help='アカウント ID。', required=True)
parser.add_argument('--bucket', help='バケット名。', required=True)
parser.add_argument('--index_name', help='ベクターインデックス名。', 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
cfg.use_internal_endpoint = True # パブリックネットワーク経由でサービスにアクセスするには、これを False に設定するか、この行を削除します。
if args.endpoint is not None:
cfg.endpoint = args.endpoint
client = oss_vectors.Client(cfg)
# ListVectors API のページネーターを作成
paginator = client.list_vectors_paginator()
# バケット名とインデックス名でリクエストを作成
request = oss_vectors.models.ListVectorsRequest(
bucket=args.bucket,
index_name=args.index_name
)
# ベクターのページを反復処理
for page in paginator.iter_page(request):
for o in page.vectors:
print(f'Vector: {o}')
if __name__ == "__main__":
main()
参考資料
ベクターをリストアップする完全なサンプルコードについては、「list_vectors.py」をご参照ください。