Python SDK V2 を使用して GetVectorIndex 操作を呼び出し、指定されたベクターインデックスに関する情報を取得します。
権限
Alibaba Cloud アカウントは、デフォルトですべての権限を持っています。対照的に、Resource Access Management (RAM) ユーザーと RAM ロールは、デフォルトでは何の権限も持っていません。Alibaba Cloud アカウントのオーナーまたは管理者は、RAM ポリシーまたはバケットポリシーを使用して権限を付与する必要があります。
API | アクション | 説明 |
GetVectorIndex |
| ベクターインデックスに関する情報を取得します。 |
メソッド定義
get_vector_index(request: GetVectorIndexRequest, **kwargs) → GetVectorIndexResultリクエストパラメーター
パラメーター | タイプ | 説明 |
request | GetVectorIndexRequest | クエリ対象のバケット名やインデックス名などのリクエストパラメーター。詳細については、「GetVectorIndexRequest」をご参照ください。 |
戻り値
タイプ | 説明 |
GetVectorIndexResult | ベクターインデックスの詳細情報を含む戻り値。詳細については、「GetVectorIndexResult」をご参照ください。 |
get_vector_index メソッドの完全な定義については、「get_vector_index」をご参照ください。
サンプルコード
import argparse
import alibabacloud_oss_v2 as oss
import alibabacloud_oss_v2.vectors as oss_vectors
parser = argparse.ArgumentParser(description="ベクターインデックス取得のサンプル")
parser.add_argument('--region', help='バケットが配置されているリージョン。', required=True)
parser.add_argument('--bucket', help='バケットの名前。', required=True)
parser.add_argument('--endpoint', help='他のサービスが OSS にアクセスするために使用できるドメイン名')
parser.add_argument('--index_name', help='ベクターインデックスの名前。', required=True)
parser.add_argument('--account_id', help='アカウント ID。', 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
vector_client = oss_vectors.Client(cfg)
result = vector_client.get_vector_index(oss_vectors.models.GetVectorIndexRequest(
bucket=args.bucket,
index_name=args.index_name,
))
print(f'status code: {result.status_code},'
f' request id: {result.request_id},'
)
if result.index:
print(f'index name: {result.index}')
if __name__ == "__main__":
main()リファレンス
完全なサンプルコードについては、「get_vector_index.py」をご参照ください。