Nesta página, descrevemos como gerenciar o ciclo de vida de uma operação de longa duração (LRO, na sigla em inglês) na Vertex AI Agent Builder.
Um objeto de operação de longa duração é retornado quando uma chamada
de um método pode levar muito tempo para ser concluído. Por exemplo, a API Vertex AI Agent Builder cria uma operação de longa duração quando você chama
documents.import
por meio da API ou das bibliotecas de cliente. A operação rastreia o status
processamento.
É possível usar os métodos de operações de longa duração fornecidos pela API Agent Builder da Vertex AI para Verifique o status das operações. Também é possível listar ou consultar operações.
O registro de uma operação é mantido por aproximadamente 30 dias após a conclusão da operação. Isso significa que não é possível visualizar ou listar uma operação após esse período.
Receber detalhes sobre uma operação de longa duração
Veja a seguir como conseguir detalhes sobre uma operação.
REST
Para receber o status e visualizar os detalhes de uma operação de longa duração, siga estas etapas:
Encontre o nome da operação de uma das duas maneiras:
Depois de fazer uma chamada para um método que retorna uma operação de longa duração, analise a resposta.
Por exemplo, se você chamar
documents.import
, o início da resposta será parecido com este:{ "name": "projects/12345/locations/global/collections/default_collection/dataStores/my-datastore_4321/branches/0/operations/import-documents-56789", "metadata": { "@type": "type.googleapis.com/google.cloud.discoveryengine.v1beta.ImportDocumentsMetadata" } }
O valor
name
na resposta fornece o nome da operação, que pode ser usada para consultar o status da operação. Não inclua aspas ao copiar o nome da operação.Confira o nome da operação listando operações de longa duração.
Chame o método
operations.get
no recurso que criou a operação:curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://discoveryengine.googleapis.com/v1beta/OPERATION_NAME"
OPERATION_NAME: o nome da operação da etapa anterior.
As primeiras linhas da resposta do comando
GET
são parecidas com estas:{ "operations": [ { "name": "projects/12345/locations/global/collections/default_collection/dataStores/my-datastore_4321/branches/0/operations/import-documents-56789", "metadata": { "@type": "type.googleapis.com/google.cloud.discoveryengine.v1alpha.ImportDocumentsMetadata", } } ] }
Python
Para mais informações, consulte a API Vertex AI Agent Builder Python documentação de referência.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Listar operações de longa duração
Confira a seguir como listar as operações de um recurso do Google Cloud.
REST
Para listar as operações de longa duração para um recurso do Google Cloud, siga esta etapa:
Chame o método
operations.list
:curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/operations"
DATA_STORE_ID: o ID do repositório de dados do Vertex AI Agent Builder que foi criado com seu mecanismo. No URL do console do Google Cloud, o ID do repositório de dados aparece depois de
engines/
e antes de/data
.
Python
Para mais informações, consulte a API Vertex AI Agent Builder Python documentação de referência.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Pesquisar uma operação de longa duração
Confira a seguir como consultar o status de uma operação.
REST
Para consultar a operação de longa duração até que ela seja concluída, siga estas etapas:
Execute este comando, que chama a função
operations.get
repetidamente, usando uma espera de 10 segundos entre cada solicitação:while true; \ do curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://discoveryengine.googleapis.com/v1beta/OPERATION_NAME"; \ sleep 10; \ done
OPERATION_NAME: o nome da operação, encontrado em Conferir detalhes sobre uma operação de longa duração. Por exemplo:
projects/12345/locations/global/collections/default_collection/dataStores/my-datastore_4321/branches/0/operations/import-documents-56789
Pare o job de pesquisa (
Control+Z
) depois que o status mostrar"done": true
.
Python
Para mais informações, consulte a API Vertex AI Agent Builder Python documentação de referência.
Para autenticar no Vertex AI Agent Builder, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.