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

Object Storage Service:ベクターのリスト (Python SDK V2)

最終更新日:Nov 09, 2025

Python SDK V2 を使用して ListVectors 操作を呼び出し、指定されたベクターインデックス内のすべてのベクターをリストします。ページングは、大量のベクトルデータを走査するためにサポートされています。

権限

Alibaba Cloud アカウントは、デフォルトですべての権限を持っています。Alibaba Cloud アカウント下の Resource Access Management (RAM) ユーザーまたは RAM ロールは、デフォルトでは権限がありません。Alibaba Cloud アカウントまたは管理者は、RAM ポリシーまたはバケットポリシーを介して操作権限を付与する必要があります。

API

アクション

説明

ListVectors

oss:ListVectors

ベクトルデータをリストします。

メソッド定義

Python SDK V2 は、ベクトルデータをリストするために 2 つのメソッドを提供します:

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

  • 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='The region in which the bucket is located.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--account_id', help='The account id.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--index_name', help='The name of the vector index.', 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
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    client = oss_vectors.Client(cfg)

    # ListVectors 操作の Paginator を作成します
    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」をご参照ください。