VoiceAgentConnection interface

Pacchetto:

@azure/ai-projects

Un flusso audio connesso e bidirezionale.

Supporta esattamente un'iterazione for await sugli eventi del server; un secondo tentativo si lancia. Uscire dal loop in anticipo (break, return, o un errore non rilevato nel corpo del loop) chiude la connessione come effetto collaterale. I tipi di eventi server non riconosciuti vengono forniti come VoiceAgentUnknownEvent senza interrompere lo stream. Gli eventi malformati falliscono comunque l'iterazione con un errore di protocollo.

Extends

AsyncIterable<VoiceAgentRealtimeEvent>

Proprietà

closed	Si risolve una volta chiusa la connessione.
state	Stato attuale della connessione.

Metodi

cancelResponse(VoiceAgentCancelResponseOptions)	Annulla una risposta in corso.
clearInputAudio(VoiceAgentEventOptions)	Cancella l'audio in ingresso bufferizzato.
clearOutputAudio(VoiceAgentEventOptions)	Cancella l'audio in uscita in attesa al servizio.
close(number, string)	Chiude con grazia la connessione WebSocket.
commitAudio(VoiceAgentEventOptions)	Emette commit audio in buffer.
configureSession(VoiceAgentSessionUpdateConfig, VoiceAgentSessionUpdateOptions)	Gli aggiornamenti supportano le impostazioni della sessione live.
dispose()	Libera la connessione. Equivalente a close().
requestResponse(VoiceAgentResponseOptions)	Richiede una nuova risposta.
sendAudio(ArrayBuffer | Uint8Array, VoiceAgentEventOptions)	Aggiunge byte audio codificati in base 64 al buffer di ingresso.
sendEvent(VoiceAgentClientEvent, VoiceAgentSendOptions)	Invia qualsiasi evento di protocollo client generato.
sendText(string, VoiceAgentSendTextOptions)	Aggiunge un elemento di testo utente e, di default, richiede una risposta.
sendToolOutput(string, string, VoiceAgentSendToolOutputOptions)	Restituisce un risultato di funzione eseguita dal client all'agente.

Metodi ereditati

[asyncIterator]()

Dettagli proprietà

closed

Si risolve una volta chiusa la connessione.

closed: Promise<VoiceAgentCloseResult>

Valore della proprietà

Promise<VoiceAgentCloseResult>

state

Stato attuale della connessione.

state: VoiceAgentConnectionState

Valore della proprietà

VoiceAgentConnectionState

Dettagli metodo

cancelResponse(VoiceAgentCancelResponseOptions)

Annulla una risposta in corso.

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

Parametri

options

VoiceAgentCancelResponseOptions

Valori restituiti

Promise<void>

clearInputAudio(VoiceAgentEventOptions)

Cancella l'audio in ingresso bufferizzato.

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

Parametri

options

VoiceAgentEventOptions

Valori restituiti

Promise<void>

clearOutputAudio(VoiceAgentEventOptions)

Cancella l'audio in uscita in attesa al servizio.

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

Parametri

options

VoiceAgentEventOptions

Valori restituiti

Promise<void>

close(number, string)

Chiude con grazia la connessione WebSocket.

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

Parametri

code

number

reason

string

Valori restituiti

Promise<void>

commitAudio(VoiceAgentEventOptions)

Emette commit audio in buffer.

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

Parametri

options

VoiceAgentEventOptions

Valori restituiti

Promise<void>

configureSession(VoiceAgentSessionUpdateConfig, VoiceAgentSessionUpdateOptions)

Gli aggiornamenti supportano le impostazioni della sessione live.

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

Parametri

session

VoiceAgentSessionUpdateConfig

options

VoiceAgentSessionUpdateOptions

Valori restituiti

Promise<void>

dispose()

Libera la connessione. Equivalente a close().

function dispose(): Promise<void>

Valori restituiti

Promise<void>

requestResponse(VoiceAgentResponseOptions)

Richiede una nuova risposta.

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

Parametri

options

VoiceAgentResponseOptions

Valori restituiti

Promise<void>

sendAudio(ArrayBuffer | Uint8Array, VoiceAgentEventOptions)

Aggiunge byte audio codificati in base 64 al buffer di ingresso.

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

Parametri

audio

ArrayBuffer | Uint8Array

options

VoiceAgentEventOptions

Valori restituiti

Promise<void>

sendEvent(VoiceAgentClientEvent, VoiceAgentSendOptions)

Invia qualsiasi evento di protocollo client generato.

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

Parametri

event

VoiceAgentClientEvent

options

VoiceAgentSendOptions

Valori restituiti

Promise<void>

sendText(string, VoiceAgentSendTextOptions)

Aggiunge un elemento di testo utente e, di default, richiede una risposta.

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

Parametri

text

string

options

VoiceAgentSendTextOptions

Valori restituiti

Promise<void>

sendToolOutput(string, string, VoiceAgentSendToolOutputOptions)

Restituisce un risultato di funzione eseguita dal client all'agente.

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

Parametri

callId

string

output

string

options

VoiceAgentSendToolOutputOptions

Valori restituiti

Promise<void>

Dettagli dei metodi ereditati

[asyncIterator]()

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

Valori restituiti

AsyncIterator<VoiceAgentRealtimeEvent, any, any>

ereditato da Asincrono. [asincrono]