Method: projects.locations.apps.sessions.runSession

Inicia una interacción de un solo turno con el agente de CES dentro de una sesión.

Solicitud HTTP

POST https://ces.googleapis.com/v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:runSession

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
config.session

string

Obligatorio. Es el identificador único de la sesión. Formato: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "config": {
    "session": string,
    "inputAudioConfig": {
      "audioEncoding": enum (AudioEncoding),
      "sampleRateHertz": integer,
      "noiseSuppressionLevel": string
    },
    "outputAudioConfig": {
      "audioEncoding": enum (AudioEncoding),
      "sampleRateHertz": integer
    },
    "historicalContexts": [
      {
        "role": string,
        "chunks": [
          {
            object (Chunk)
          }
        ],
        "eventTime": string
      }
    ],
    "entryAgent": string,
    "deployment": string,
    "timeZone": string,
    "useToolFakes": boolean,
    "remoteDialogflowQueryParameters": {
      "webhookHeaders": {
        string: string,
        ...
      },
      "payload": {
        object
      },
      "endUserMetadata": {
        object
      }
    },
    "enableTextStreaming": boolean,
    "includeLlmThoughtSummary": boolean,
    "excludeDiagnosticInfo": boolean,
    "includeProgressUpdate": boolean
  },
  "inputs": [
    {
      object (SessionInput)
    }
  ]
}
Campos
config.inputAudioConfig

object (InputAudioConfig)

Es opcional. Es la configuración para procesar el audio de entrada.

config.outputAudioConfig

object (OutputAudioConfig)

Es opcional. Es la configuración para generar el audio de salida.

config.historicalContexts[]

object (Message)

Es opcional. Es el contexto histórico de la sesión, incluidas las entradas del usuario, las respuestas del agente y otros mensajes. Por lo general, el agente de CES administra la sesión automáticamente, por lo que el cliente no necesita propagar este campo de forma explícita. Sin embargo, el cliente puede anular de forma opcional los contextos históricos para forzar el inicio de la sesión desde un estado determinado.

config.entryAgent

string

Es opcional. Es el agente de entrada que controlará la sesión. Si no se especifica, la sesión se controlará con el root agent de la app. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

config.deployment

string

Es opcional. Es la implementación de la app que se usará para la sesión. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

config.timeZone

string

Es opcional. Es la zona horaria del usuario. Si se proporciona, el agente usará la zona horaria para las variables relacionadas con la fecha y la hora. De lo contrario, el agente usará la zona horaria especificada en App.time_zone_settings.

El formato es la zona horaria de la base de datos de zonas horarias de IANA, p.ej., "America/Los_Angeles".

config.useToolFakes

boolean

Es opcional. Indica si se deben usar simulaciones de herramientas para la sesión. Si se establece este campo, el agente intentará usar simulaciones de herramientas en lugar de llamar a las herramientas reales.

config.remoteDialogflowQueryParameters

object (SessionConfig.RemoteDialogflowQueryParameters)

Es opcional. QueryParameters que se enviarán al agente remoto de Dialogflow cuando se transfiera el control de la sesión al agente remoto.

config.enableTextStreaming

boolean

Es opcional. Indica si se debe transmitir la salida de texto del modelo al cliente de forma incremental a medida que se genera. La configuración predeterminada es false.

  • Cuando se inhabilita, el resultado de texto del modelo se almacena en búfer y cada resultado de texto que se envía al cliente es una oración completa. Los clientes pueden renderizar cada resultado de texto en una línea nueva.
  • Cuando está habilitado, cada salida de texto puede contener solo una parte de una oración. Los clientes deben concatenar los resultados de texto consecutivos para renderizar la respuesta completa.

NOTA: Esto solo se admite para sesiones de texto (sin voz) con sessions.streamRunSession o BidiRunSession.

config.includeLlmThoughtSummary

boolean

Es opcional. Indica si se deben incluir resúmenes de pensamientos del LLM en los resultados de la sesión.

config.excludeDiagnosticInfo

boolean

Es opcional. Indica si se debe excluir la información de diagnóstico del resultado de la sesión.

config.includeProgressUpdate

boolean

Es opcional. Indica si se debe incluir la actualización de procesamiento intermedio para el cliente. Si está habilitada, la actualización se enviará de vuelta en SessionOutput.progress.

inputs[]

object (SessionInput)

Obligatorio. Son las entradas de la sesión.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de RunSessionResponse.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso session:

  • ces.sessions.runSession

Para obtener más información, consulta la documentación de IAM.