Utilisez le SDK Python V2 pour appeler l'opération ListVectorIndexes et répertorier tous les index vectoriels d'un bucket vectoriel spécifié.
Autorisations
Un compte Alibaba Cloud dispose de toutes les autorisations nécessaires pour accéder à toutes les opérations API. Par défaut, les utilisateurs RAM et les rôles RAM ne peuvent pas appeler cette opération. Vous devez créer et associer une politique RAM ou une politique de bucket pour accorder les autorisations requises.
|
API |
Action |
Description |
|
ListVectorIndexes |
|
Répertorie les index vectoriels. |
Définition de la méthode
Le SDK Python V2 propose deux méthodes pour lister les index vectoriels :
list_vector_indexes(): Appelle l'opération directement. Vous devez gérer manuellement la pagination.list_vector_indexes_paginator(): Utilise un paginateur. Le kit de développement logiciel (SDK) gère automatiquement la logique de pagination. Cette méthode est recommandée.
# Call directly
list_vector_indexes(request: ListVectorIndexesRequest, **kwargs) → ListVectorIndexesResult
Paramètres de requête
|
Paramètre |
Type |
Description |
|
request |
ListVectorIndexesRequest |
Les paramètres de la requête. Pour plus d'informations, consultez ListVectorIndexesRequest |
Valeurs de retour
|
Type |
Description |
|
ListVectorIndexesResult |
La valeur de retour. Pour plus d'informations, consultez ListVectorIndexesResult |
Pour la définition complète de la méthode list_vector_indexes, consultez list_vector_indexes.
# Use a paginator
list_vector_indexes_paginator(**kwargs) → ListVectorIndexesPaginator[source]
Valeurs de retour
|
Type |
Description |
|
ListVectorIndexesPaginator |
La valeur de retour. Pour plus d'informations, consultez ListVectorIndexesPaginator |
Pour la définition complète de la méthode list_vector_indexes_paginator, consultez list_vector_indexes_paginator.
Exemple de code
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)
parser.add_argument('--endpoint', help='The OSS access endpoint.')
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()
# Load credential values from environment variables.
credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()
# Use the SDK's default configuration.
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 # To connect over the public network, set this to False or remove this line.
if args.endpoint is not None:
cfg.endpoint = args.endpoint
client = oss_vectors.Client(cfg)
# Create the paginator for the ListVectorIndexes operation.
paginator = client.list_vector_indexes_paginator()
# Iterate through the pages of vector indexes.
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()
Références
Pour l'exemple de code complet permettant de lister les index vectoriels, consultez list_vector_indexes.py.