VoiceAgentRealtimeClientConnectOptions interface

Cancela el intento de conexión.

abortSignal?: AbortSignalLike

Valor de propiedad

Identificador usado para correlacionar la sesión de voz.

agentSessionId?: string

Valor de propiedad

Selecciona una versión de agente inmutable específica.

agentVersionOverride?: string

Valor de propiedad

Anula el tiempo de espera de la conexión del cliente en milisegundos.

connectionTimeoutInMs?: number

Valor de propiedad

Recibe transiciones de estado de conexión.

onConnectionStateChange?: VoiceAgentConnectionStateChangedHandler

Valor de propiedad

Parámetros adicionales de consulta para la URL de actualización WebSocket de esta conexión. Proporciona un objeto simple, incluyendo un objeto prototipo nulo. Los valores sobrescriben los parámetros undefined de consulta de endpoint; elimina un parámetro. Los valores se codifican automáticamente por URL. Los números deben ser finitos. Los parámetros gestionados por SDK, parámetros de autenticación y nombres que comienzan con h- se reservan (insensibles a mayúsculas y minúsculas) y causan un TypeError. Utiliza las opciones correspondientes para sesión, versión, almacenamiento, transporte y entradas estructuradas de prompts. Ambos structured_input y structured_inputs son reservados. No incluyas secretos: los parámetros de consulta pueden aparecer en registros de servidores o proxy.

query?: Readonly<Record<string, string | number | boolean | undefined>>

Valor de propiedad

Anula si la conversación generada por esta sesión se mantiene en marcha.

store?: boolean

Valor de propiedad

Valores usados para renderizar las entradas estructuradas de prompt del agente. Se serializa cuando connect() se llama, antes de la autenticación.

structuredInputs?: Record<string, unknown>

Valor de propiedad

Selecciona el transporte utilizado para la conexión en tiempo real. Tiene como valor predeterminado "websocket". Configurado para "webrtc" negociar una conexión entre pares WebRTC en su lugar; el llamante es responsable de completar el intercambio de oferta/respuesta SDP usando los rtc.call.sdp.create eventos y rtc.call.sdp.created (véase VoiceAgentRealtimeEvent).

transport?: VoiceAgentTransport

Valor de propiedad

Función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.

onResponse?: RawResponseCallback

Valor de propiedad

Heredado de OperationOptions.onResponse

Opciones que se usan al crear y enviar solicitudes HTTP para esta operación.

requestOptions?: OperationRequestOptions

Valor de propiedad

Heredado de OperationOptions.requestOptions

Opciones que se usan al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

Heredado de OperationOptions.tracingOptions