Listar índices vetoriais (Python SDK V2) - Object Storage Service: Central de Documentação do Alibaba Cloud

Permissões

A conta Alibaba Cloud tem permissões completas para acessar todas as operações de API. Por padrão, usuários RAM e funções RAM não podem chamar esta operação. Crie e anexe uma política do RAM ou uma política de bucket para conceder as permissões necessárias.

API	Action	Descrição
ListVectorIndexes	`oss:ListVectorIndexes`	Lista índices vetoriais.

Definição do método

O Python SDK V2 oferece dois métodos para listar índices vetoriais:

list_vector_indexes(): Chama a operação diretamente. Gerencie a paginação manualmente.
list_vector_indexes_paginator(): Usa um paginador. O SDK gerencia automaticamente a lógica de paginação. Este é o método recomendado.

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

Parâmetros da solicitação

Parâmetro	Tipo	Descrição
request	ListVectorIndexesRequest	Parâmetros da solicitação. Para mais informações, consulte ListVectorIndexesRequest

Valores de retorno

Tipo	Descrição
ListVectorIndexesResult	Valor de retorno. Para mais informações, consulte ListVectorIndexesResult

Para obter a definição completa do método list_vector_indexes, consulte list_vector_indexes.

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

Valores de retorno

Tipo	Descrição
ListVectorIndexesPaginator	Valor de retorno. Para mais informações, consulte ListVectorIndexesPaginator

Para obter a definição completa do método list_vector_indexes_paginator, consulte list_vector_indexes_paginator.

Código de exemplo

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

Referências

Para ver o código de exemplo completo de listagem de índices vetoriais, consulte list_vector_indexes.py.