Python SDK V2 を使用して GetVectorIndex API を呼び出し、指定したベクターインデックスの情報を取得します。
権限
デフォルトでは、Alibaba Cloud アカウントはすべての権限を持っています。 ただし、Resource Access Management (RAM) ユーザーまたは RAM ロールはデフォルトでは権限を持っていません。 RAM ユーザーまたは RAM ロールに権限を付与するには、RAM ポリシーの概要またはバケットポリシーを使用する必要があります。
|
API |
Action |
説明 |
|
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="vector get vector index sample")
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
cfg.use_internal_endpoint = True # パブリックネットワーク経由で OSS にアクセスする場合は、これを False に設定するか、この行を削除します。
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: {result.index}')
if __name__ == "__main__":
main()
関連ドキュメント
完全なサンプルコードについては、「get_vector_index.py」をご参照ください。