Listar índices vectoriales (Python SDK V2) - Object Storage Service

Puede usar Python SDK V2 para llamar a la operación ListVectorIndexes y obtener una lista de todos los índices vectoriales en un bucket específico.

Permisos

Una cuenta de Alibaba Cloud tiene permisos completos para acceder a todas las operaciones de la API. De forma predeterminada, los usuarios de RAM y los roles de RAM no pueden llamar a esta operación. Debe crear y adjuntar una RAM policy o un bucket policy para otorgar los permisos obligatorios.

API	Acción	Descripción
ListVectorIndexes	`oss:ListVectorIndexes`	Lista los índices vectoriales.

Definición del método

Python SDK V2 ofrece dos métodos para listar índices vectoriales:

list_vector_indexes(): Llama a la operación directamente. Debe gestionar la paginación manualmente.
list_vector_indexes_paginator(): Usa un paginador. El kit de desarrollo de software (SDK) gestiona automáticamente la lógica de paginación. Se recomienda este método.

# Call directly
list_vector_indexes(request: ListVectorIndexesRequest, **kwargs) → ListVectorIndexesResult

Parámetros de solicitud

Parámetro	Tipo	Descripción
request	ListVectorIndexesRequest	Los parámetros de la solicitud. Para más información, consulte ListVectorIndexesRequest

Valores de retorno

Tipo	Descripción
ListVectorIndexesResult	El valor de retorno. Para más información, consulte ListVectorIndexesResult

Para consultar la definición completa del método list_vector_indexes, consulte list_vector_indexes.

# Use a paginator
list_vector_indexes_paginator(**kwargs) → ListVectorIndexesPaginator[source]

Valores de retorno

Tipo	Descripción
ListVectorIndexesPaginator	El valor de retorno. Para más información, consulte ListVectorIndexesPaginator

Para consultar la definición completa del método list_vector_indexes_paginator, consulte list_vector_indexes_paginator.

Código de ejemplo

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()

Referencias

Para consultar el código de ejemplo completo sobre cómo listar índices vectoriales, consulte list_vector_indexes.py.