Interacciones con la API

Para cada turno de la conversación, se produce una interacción. Durante una interacción, un usuario final envía una entrada a la app del agente y esta envía una respuesta. Puedes usar la API de Vertex AI Conversation para interactuar con la app del agente en el entorno de ejecución.

Nota: En los próximos cambios, Vertex AI Conversation tendrá su propia API.

Antes de comenzar

Debes hacer lo siguiente antes de leer esta guía:

1. Crea una app de agente nueva o continúa usando la app de agente que creaste en Crea una app de agente.

Recopila ID

Los siguientes ejemplos requieren varios IDs como entrada. Para encontrar el ID del proyecto, el ID de la región y el ID de la app, haz lo siguiente:

1. Ve a la consola de Vertex AI Conversation:

   Consola de Vertex AI Conversation

2. El ID del proyecto se muestra en la parte superior de la consola.

3. En la columna Ubicación, se muestran los IDs de las regiones.

4. Selecciona una app.

5. El segmento de ruta de URL del navegador después de agents/ contiene el ID de app del agente.

También necesitas un ID de sesión. Una sesión representa una conversación entre una app de agente y un usuario final. Se crea un ID de sesión único al comienzo de una conversación y se usa en cada turno de la conversación. Con el fin de probar la API, puedes usar cualquier ID de string de 36 bytes como máximo, como test-session-123.

Llama al intent de detección

En las siguientes muestras, se llama al método Sessions.detectIntent. Ir a la referencia de la API de Session

Selecciona un protocolo y una versión para la referencia de sesión:

Protocolo	V3	V3beta1
REST	Recurso de la sesión	Recurso de la sesión
RPC	Interfaz de la sesión	Interfaz de la sesión
C++	SessionsClient	No disponible
C#	SessionsClient	No disponible
Go	SessionsClient	No disponible
Java	SessionsClient	SessionsClient
Node.js	SessionsClient	SessionsClient
PHP	No disponible	No disponible
Python	SessionsClient	SessionsClient
Rita	No disponible	No disponible

Cerrar

REST

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

• PROJECT_ID: El ID del proyecto de Google Cloud.
• AGENT_ID: Es el ID del agente de la guía, que corresponde al ID del agente de Dialogflow.
• REGION_ID: Es el ID de región
• SUBDOMAIN_REGION: Si el ID de la región es us, la región del subdominio es usa; de lo contrario, la región del subdominio es la misma que el ID de la región
• SESSION_ID: Es el ID de sesión.
• END_USER_INPUT: Es la entrada del usuario final (por ejemplo, quiero comprar una camisa).

Método HTTP y URL:

POST https://SUBDOMAIN_REGION-dialogflow.googleapis.com/v3/projects/PROJECT_ID/locations/REGION_ID/agents/AGENT_ID/sessions/SESSION_ID:detectIntent

Cuerpo JSON de la solicitud:

{
  "queryInput": {
    "text": {
      "text": "END_USER_INPUT"
    },
    "languageCode": "en"
  },
  "queryParams": {
    "timeZone": "America/Los_Angeles"
  }
}

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 POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "x-goog-user-project: PROJECT_ID" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://SUBDOMAIN_REGION-dialogflow.googleapis.com/v3/projects/PROJECT_ID/locations/REGION_ID/agents/AGENT_ID/sessions/SESSION_ID:detectIntent"

PowerShell (Windows)

Nota: En el siguiente comando, se supone que accediste a la CLI de gcloud con tu cuenta de usuario ejecutando 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"; "x-goog-user-project" = "PROJECT_ID" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://SUBDOMAIN_REGION-dialogflow.googleapis.com/v3/projects/PROJECT_ID/locations/REGION_ID/agents/AGENT_ID/sessions/SESSION_ID:detectIntent" | Select-Object -Expand Content

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{
  "responseId": "a6cd27b0-5eaa-4f93-aa6e-11faf97dbb63",
  "queryResult": {
    "text": "I want to buy a shirt",
    "languageCode": "en",
    "responseMessages": [
      {
        "text": {
          "text": [
            "Great! I can help you with that. We have a wide variety of shirts to choose from. What size and color would you like?"
          ]
        }
      }
    ],
    "intentDetectionConfidence": 1,
    "diagnosticInfo": {
      "Session Id": "123",
      "Response Id": "a6cd27b0-5eaa-4f93-aa6e-11faf97dbb63"
    },
    "match": {
      "confidence": 1
    },
    "advancedSettings": {
      "loggingSettings": {}
    }
  },
  "responseType": "FINAL"
}