Administra los agentes implementados

En esta página, se describe cómo administrar los agentes que se implementaron en el entorno de ejecución administrado de Agent Engine. Los agentes implementados son recursos de tipo reasoningEngine en Vertex AI.

Enumera los agentes implementados

Muestra una lista de todos los agentes implementados para un proyecto y una ubicación determinados:

SDK de Vertex AI para Python

from vertexai import agent_engines

agent_engines.list()

Para filtrar la lista por display_name, haz lo siguiente:

from vertexai import agent_engines

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

REST

Llama al método reasoningEngines.list.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

• PROJECT_ID: Es el ID del proyecto de GCP.
• LOCATION: Es una región compatible.

Método HTTP y URL:

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

Para enviar tu solicitud, expande una de estas opciones:

curl (Linux, macOS o Cloud Shell)

Nota: Con el siguiente comando, se supone que accediste a la CLI de gcloud con tu cuenta de usuario a través de la ejecución de gcloud init o gcloud auth login, o a través del uso de Cloud Shell, que accede de forma automática a la CLI de gcloud. Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Ejecuta el siguiente 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)

Nota: El siguiente comando supone que accediste a la CLI de gcloud con tu cuenta de usuario mediante la ejecución de gcloud init o gcloud auth login. Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Ejecuta el siguiente 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

Deberías recibir un código de estado exitoso (2xx) y una respuesta vacía.

Cómo obtener un agente implementado

Cada agente implementado tiene un identificador RESOURCE_ID único. Para obtener más información, consulta Cómo implementar un agente.

SDK de Vertex AI para Python

El siguiente código te permite obtener un agente implementado específico:

from vertexai import agent_engines

remote_agent = agent_engines.get("RESOURCE_ID")

Como alternativa, puedes proporcionar el nombre de recurso completamente calificado:

from vertexai import agent_engines

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

REST

Llama al método reasoningEngines.get.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

• PROJECT_ID: Es el ID del proyecto de GCP.
• LOCATION: Es una región compatible.
• RESOURCE_ID: El ID del recurso del agente implementado

Método HTTP y URL:

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

Para enviar tu solicitud, expande una de estas opciones:

curl (Linux, macOS o Cloud Shell)

Nota: Con el siguiente comando, se supone que accediste a la CLI de gcloud con tu cuenta de usuario a través de la ejecución de gcloud init o gcloud auth login, o a través del uso de Cloud Shell, que accede de forma automática a la CLI de gcloud. Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Ejecuta el siguiente 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)

Nota: El siguiente comando supone que accediste a la CLI de gcloud con tu cuenta de usuario mediante la ejecución de gcloud init o gcloud auth login. Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Ejecuta el siguiente 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

Deberías recibir un código de estado exitoso (2xx) y una respuesta vacía.

Actualiza un agente implementado

Puedes actualizar uno o más campos del agente implementado al mismo tiempo, pero debes especificar al menos uno de los campos que se actualizarán. El tiempo que tarda en actualizarse el agente implementado depende de la actualización que se realice, pero, por lo general, tarda entre unos segundos y unos minutos.

SDK de Vertex AI para Python

Para actualizar un agente implementado (que corresponde a RESOURCE_NAME) a un agente actualizado (que corresponde a UPDATED_AGENT), haz lo siguiente:

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

Los argumentos son los mismos que cuando implementas un agente. Puedes encontrar detalles en la referencia de la API.

REST

Llama al método reasoningEngines.patch y proporciona un update_mask para especificar qué campos se deben actualizar.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

• PROJECT_ID: Es el ID del proyecto de GCP.
• LOCATION: Es una región compatible.
• RESOURCE_ID: Es el ID del recurso del agente implementado.
• update_mask: Es una lista de campos separados por comas que se actualizarán.

Método HTTP y URL:

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

Cuerpo JSON de la solicitud:

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

Para enviar tu solicitud, expande una de estas opciones:

curl (Linux, macOS o Cloud Shell)

Nota: Con el siguiente comando, se supone que accediste a la CLI de gcloud con tu cuenta de usuario a través de la ejecución de gcloud init o gcloud auth login, o a través del uso de Cloud Shell, que accede de forma automática a la CLI de gcloud. Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

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)

Nota: El siguiente comando supone que accediste a la CLI de gcloud con tu cuenta de usuario mediante la ejecución de gcloud init o gcloud auth login. Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

$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

Deberías recibir un código de estado exitoso (2xx) y una respuesta vacía.

Cómo borrar un agente implementado

SDK de Vertex AI para Python

Si ya tienes una instancia existente del agente implementado (como remote_agent), puedes ejecutar el siguiente comando:

remote_agent.delete()

Como alternativa, puedes llamar a agent_engines.delete() para borrar el agente implementado que corresponde a RESOURCE_NAME de la siguiente manera:

from vertexai import agent_engines

agent_engines.delete(RESOURCE_NAME)

REST

Llama al método reasoningEngines.delete.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

• PROJECT_ID: Es el ID del proyecto de GCP.
• LOCATION: Es una región compatible.
• RESOURCE_ID: El ID del recurso del agente implementado

Método HTTP y URL:

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

Cuerpo JSON de la solicitud:

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

Para enviar tu solicitud, expande una de estas opciones:

curl (Linux, macOS o Cloud Shell)

Nota: Con el siguiente comando, se supone que accediste a la CLI de gcloud con tu cuenta de usuario a través de la ejecución de gcloud init o gcloud auth login, o a través del uso de Cloud Shell, que accede de forma automática a la CLI de gcloud. Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

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)

Nota: El siguiente comando supone que accediste a la CLI de gcloud con tu cuenta de usuario mediante la ejecución de gcloud init o gcloud auth login. Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

$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

Deberías recibir un código de estado exitoso (2xx) y una respuesta vacía.