VoiceAgentRealtimeClientConnectOptions interface

Paquete:

@azure/ai-projects

Opciones para conectar el cliente en tiempo real a un agente de voz.

Extends

OperationOptions

Propiedades

abortSignal	Cancela el intento de conexión.
agentSessionId	Identificador usado para correlacionar la sesión de voz.
agentVersionOverride	Selecciona una versión de agente inmutable específica.
connectionTimeoutInMs	Anula el tiempo de espera de la conexión del cliente en milisegundos.
onConnectionStateChange	Recibe transiciones de estado de conexión.
store	Anula si la conversación generada por esta sesión se mantiene en marcha.
structuredInputs	Valores usados para renderizar las entradas estructuradas de prompt del agente.

Propiedades heredadas

onResponse	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.
requestOptions	Opciones que se usan al crear y enviar solicitudes HTTP para esta operación.
tracingOptions	Opciones que se usan al habilitar el seguimiento.

Detalles de las propiedades

abortSignal

Cancela el intento de conexión.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

agentSessionId

Identificador usado para correlacionar la sesión de voz.

agentSessionId?: string

Valor de propiedad

string

agentVersionOverride

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

agentVersionOverride?: string

Valor de propiedad

string

connectionTimeoutInMs

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

connectionTimeoutInMs?: number

Valor de propiedad

number

onConnectionStateChange

Recibe transiciones de estado de conexión.

onConnectionStateChange?: VoiceAgentConnectionStateChangedHandler

Valor de propiedad

VoiceAgentConnectionStateChangedHandler

store

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

store?: boolean

Valor de propiedad

boolean

structuredInputs

Valores usados para renderizar las entradas estructuradas de prompt del agente.

structuredInputs?: Record<string, unknown>

Valor de propiedad

Record<string, unknown>

Detalles de las propiedades heredadas

onResponse

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

RawResponseCallback

Heredado de OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Valor de propiedad

OperationRequestOptions

Heredado de OperationOptions.requestOptions

tracingOptions

Opciones que se usan al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

Heredado de OperationOptions.tracingOptions