VoiceAgentConnection interface

Paquete:

@azure/ai-projects

Un flujo de voz bidireccional y conectado.

Soporta exactamente una for await iteración sobre eventos del servidor; un segundo intento lanza. Salir del bucle antes de tiempo (break, return, o un error no detectado en el cuerpo del bucle) cierra la conexión como efecto secundario. Los tipos de eventos de servidor no reconocidos se entregan como VoiceAgentUnknownEvent sin interrumpir la transmisión. Los eventos malformados siguen fallando la iteración con un error de protocolo.

Extends

AsyncIterable<VoiceAgentRealtimeEvent>

Propiedades

closed	Se resuelve una vez que la conexión está cerrada.
state	Estado actual de la conexión.

Métodos

cancelResponse(VoiceAgentCancelResponseOptions)	Cancela una respuesta en curso.
clearInputAudio(VoiceAgentEventOptions)	Borra el audio de entrada con búfer.
clearOutputAudio(VoiceAgentEventOptions)	Borra el audio de salida pendiente en el servicio.
close(number, string)	Cierra la conexión WebSocket con gracia.
commitAudio(VoiceAgentEventOptions)	Emite el audio de entrada con búfer y con commmits.
configureSession(VoiceAgentSessionUpdateConfig, VoiceAgentSessionUpdateOptions)	Actualizaciones soportadas para la configuración de sesiones en vivo.
dispose()	Libera la conexión. Equivalente a cerrar().
requestResponse(VoiceAgentResponseOptions)	Solicita una nueva respuesta.
sendAudio(ArrayBuffer | Uint8Array, VoiceAgentEventOptions)	Añade bytes de audio codificados en base 64 al búfer de entrada.
sendEvent(VoiceAgentClientEvent, VoiceAgentSendOptions)	Envía cualquier evento de protocolo cliente generado.
sendText(string, VoiceAgentSendTextOptions)	Añade un elemento de texto de usuario y, por defecto, solicita una respuesta.
sendToolOutput(string, string, VoiceAgentSendToolOutputOptions)	Devuelve un resultado de función ejecutado por el cliente al agente.

Métodos heredados

[asyncIterator]()

Detalles de las propiedades

closed

Se resuelve una vez que la conexión está cerrada.

closed: Promise<VoiceAgentCloseResult>

Valor de propiedad

Promise<VoiceAgentCloseResult>

state

Estado actual de la conexión.

state: VoiceAgentConnectionState

Valor de propiedad

VoiceAgentConnectionState

Detalles del método

cancelResponse(VoiceAgentCancelResponseOptions)

Cancela una respuesta en curso.

function cancelResponse(options?: VoiceAgentCancelResponseOptions): Promise<void>

Parámetros

options

VoiceAgentCancelResponseOptions

Devoluciones

Promise<void>

clearInputAudio(VoiceAgentEventOptions)

Borra el audio de entrada con búfer.

function clearInputAudio(options?: VoiceAgentEventOptions): Promise<void>

Parámetros

options

VoiceAgentEventOptions

Devoluciones

Promise<void>

clearOutputAudio(VoiceAgentEventOptions)

Borra el audio de salida pendiente en el servicio.

function clearOutputAudio(options?: VoiceAgentEventOptions): Promise<void>

Parámetros

options

VoiceAgentEventOptions

Devoluciones

Promise<void>

close(number, string)

Cierra la conexión WebSocket con gracia.

function close(code?: number, reason?: string): Promise<void>

Parámetros

code

number

reason

string

Devoluciones

Promise<void>

commitAudio(VoiceAgentEventOptions)

Emite el audio de entrada con búfer y con commmits.

function commitAudio(options?: VoiceAgentEventOptions): Promise<void>

Parámetros

options

VoiceAgentEventOptions

Devoluciones

Promise<void>

configureSession(VoiceAgentSessionUpdateConfig, VoiceAgentSessionUpdateOptions)

Actualizaciones soportadas para la configuración de sesiones en vivo.

function configureSession(session: VoiceAgentSessionUpdateConfig, options?: VoiceAgentSessionUpdateOptions): Promise<void>

Parámetros

session

VoiceAgentSessionUpdateConfig

options

VoiceAgentSessionUpdateOptions

Devoluciones

Promise<void>

dispose()

Libera la conexión. Equivalente a cerrar().

function dispose(): Promise<void>

Devoluciones

Promise<void>

requestResponse(VoiceAgentResponseOptions)

Solicita una nueva respuesta.

function requestResponse(options?: VoiceAgentResponseOptions): Promise<void>

Parámetros

options

VoiceAgentResponseOptions

Devoluciones

Promise<void>

sendAudio(ArrayBuffer | Uint8Array, VoiceAgentEventOptions)

Añade bytes de audio codificados en base 64 al búfer de entrada.

function sendAudio(audio: ArrayBuffer | Uint8Array, options?: VoiceAgentEventOptions): Promise<void>

Parámetros

audio

ArrayBuffer | Uint8Array

options

VoiceAgentEventOptions

Devoluciones

Promise<void>

sendEvent(VoiceAgentClientEvent, VoiceAgentSendOptions)

Envía cualquier evento de protocolo cliente generado.

function sendEvent(event: VoiceAgentClientEvent, options?: VoiceAgentSendOptions): Promise<void>

Parámetros

event

VoiceAgentClientEvent

options

VoiceAgentSendOptions

Devoluciones

Promise<void>

sendText(string, VoiceAgentSendTextOptions)

Añade un elemento de texto de usuario y, por defecto, solicita una respuesta.

function sendText(text: string, options?: VoiceAgentSendTextOptions): Promise<void>

Parámetros

text

string

options

VoiceAgentSendTextOptions

Devoluciones

Promise<void>

sendToolOutput(string, string, VoiceAgentSendToolOutputOptions)

Devuelve un resultado de función ejecutado por el cliente al agente.

function sendToolOutput(callId: string, output: string, options?: VoiceAgentSendToolOutputOptions): Promise<void>

Parámetros

callId

string

output

string

options

VoiceAgentSendToolOutputOptions

Devoluciones

Promise<void>

Detalles de los métodos heredados

[asyncIterator]()

function [asyncIterator](): AsyncIterator<VoiceAgentRealtimeEvent, any, any>

Devoluciones

AsyncIterator<VoiceAgentRealtimeEvent, any, any>

Heredado de AsyncIterable. [asyncIterator]