Gerenciar agentes implantados

Esta página descreve como gerenciar agentes implantados no ambiente de execução gerenciado do Agente Engine. Os agentes implantados são recursos do tipo reasoningEngine na Vertex AI.

Listar agentes implantados

Liste todos os agentes implantados para um determinado projeto e local:

SDK da Vertex AI para Python

from vertexai import agent_engines

agent_engines.list()

Para filtrar a lista por display_name:

from vertexai import agent_engines

agent_engines.list(filter='display_name="Demo Langchain Agent"')

REST

Chame o método reasoningEngines.list.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

• PROJECT_ID: ID do projeto do GCP
• LOCATION: uma região com suporte

Método HTTP e URL:

GET https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . É possível verificar a conta ativa atual executando gcloud auth list.

execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines"

PowerShell (Windows)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . É possível verificar a conta ativa atual executando gcloud auth list.

execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines" | Select-Object -Expand Content

Você receberá um código de status bem-sucedido (2xx) e uma resposta vazia.

Acessar um agente implantado

Cada agente implantado tem um identificador RESOURCE_ID exclusivo. Para saber mais, consulte Implantar um agente.

SDK da Vertex AI para Python

O código a seguir permite receber um agente implantado específico:

from vertexai import agent_engines

remote_agent = agent_engines.get("RESOURCE_ID")

Como alternativa, forneça o nome do recurso totalmente qualificado:

from vertexai import agent_engines

remote_agent = agent_engines.get(
"projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID"
)

REST

Chame o método reasoningEngines.get.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

• PROJECT_ID: ID do projeto do GCP
• LOCATION: uma região com suporte
• RESOURCE_ID: o ID do recurso do agente implantado

Método HTTP e URL:

GET https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . É possível verificar a conta ativa atual executando gcloud auth list.

execute o seguinte comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID"

PowerShell (Windows)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . É possível verificar a conta ativa atual executando gcloud auth list.

execute o seguinte comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID" | Select-Object -Expand Content

Você receberá um código de status bem-sucedido (2xx) e uma resposta vazia.

Atualizar um agente implantado

É possível atualizar um ou mais campos do agente implantado ao mesmo tempo, mas é necessário especificar pelo menos um dos campos a serem atualizados. O tempo necessário para atualizar o agente implantado depende da atualização que está sendo realizada, mas geralmente leva de alguns segundos a alguns minutos.

SDK da Vertex AI para Python

Para atualizar um agente implantado (correspondente a RESOURCE_NAME) para um agente atualizado (correspondente a UPDATED_AGENT):

from vertexai import agent_engines

agent_engines.update(
    resource_name=RESOURCE_NAME,    # Required.
    agent_engine=UPDATED_AGENT,     # Optional.
    requirements=REQUIREMENTS,      # Optional.
    display_name="DISPLAY_NAME",    # Optional.
    description="DESCRIPTION",      # Optional.
    extra_packages=EXTRA_PACKAGES,  # Optional.
)

Os argumentos são os mesmos de quando você implanta um agente. Confira os detalhes na referência da API.

REST

Chame o método reasoningEngines.patch e forneça um update_mask para especificar quais campos serão atualizados.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

• PROJECT_ID: ID do projeto do GCP
• LOCATION: uma região com suporte
• RESOURCE_ID: o ID do recurso do agente implantado
• update_mask: uma lista de campos separados por vírgulas a serem atualizados

Método HTTP e URL:

PATCH https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID?update_mask="display_name,description"

Corpo JSON da solicitação:

{
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION" 
}

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID?update_mask="display_name,description""

PowerShell (Windows)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID?update_mask="display_name,description"" | Select-Object -Expand Content

Você receberá um código de status bem-sucedido (2xx) e uma resposta vazia.

Excluir um agente implantado

SDK da Vertex AI para Python

Se você já tiver uma instância do agente implantado (como remote_agent), execute o seguinte comando:

remote_agent.delete()

Como alternativa, chame agent_engines.delete() para excluir o agente implantado correspondente a RESOURCE_NAME desta forma:

from vertexai import agent_engines

agent_engines.delete(RESOURCE_NAME)

REST

Chame o método reasoningEngines.delete.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

• PROJECT_ID: ID do projeto do GCP
• LOCATION: uma região com suporte
• RESOURCE_ID: o ID do recurso do agente implantado

Método HTTP e URL:

DELETE https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID

Corpo JSON da solicitação:

{
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION" 
}

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID"

PowerShell (Windows)

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID" | Select-Object -Expand Content

Você receberá um código de status bem-sucedido (2xx) e uma resposta vazia.