- Solicitud HTTP
- Parámetros de ruta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Permisos de IAM
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 |
Obligatorio. Es el identificador único de la sesión. Formato: |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
| Representación JSON |
|---|
{ "config": { "session": string, "inputAudioConfig": { "audioEncoding": enum ( |
| Campos | |
|---|---|
config.inputAudioConfig |
Es opcional. Es la configuración para procesar el audio de entrada. |
config.outputAudioConfig |
Es opcional. Es la configuración para generar el audio de salida. |
config.historicalContexts[] |
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 |
Es opcional. Es el agente de entrada que controlará la sesión. Si no se especifica, la sesión se controlará con el |
config.deployment |
Es opcional. Es la implementación de la app que se usará para la sesión. Formato: |
config.timeZone |
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 |
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 |
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 |
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
NOTA: Esto solo se admite para sesiones de texto (sin voz) con |
config.includeLlmThoughtSummary |
Es opcional. Indica si se deben incluir resúmenes de pensamientos del LLM en los resultados de la sesión. |
config.excludeDiagnosticInfo |
Es opcional. Indica si se debe excluir la información de diagnóstico del resultado de la sesión. |
config.includeProgressUpdate |
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 |
inputs[] |
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-platformhttps://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.