VoiceAgentWebSocketTransport interface

Pakiet:

@azure/ai-projects

Przenośny WebSocket transport, używany przez VoiceAgentRealtimeClient. Zaimplementuj ten interfejs, aby dostosować sposób nawiązywania połączenia w czasie rzeczywistym, na przykład aby kierować je przez uwierzytelniony przekaźnik.

Metody

close(number, string)	Zamknięcie połączenia.
connect(VoiceAgentWebSocketConnectOptions)	Ustanawia połączenie z WebSocket.
send(string, AbortSignalLike)	Wysyła wiadomość przez połączenie.
setHandlers(VoiceAgentWebSocketHandlers)	Rejestruje handlery wywoływane w momencie wystąpienia zdarzeń połączenia.

Szczegóły metody

close(number, string)

Zamknięcie połączenia.

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

Parametry

code

number

reason

string

Zwraca

Promise<void>

connect(VoiceAgentWebSocketConnectOptions)

Ustanawia połączenie z WebSocket.

function connect(options: VoiceAgentWebSocketConnectOptions): Promise<void>

Parametry

options

VoiceAgentWebSocketConnectOptions

Zwraca

Promise<void>

send(string, AbortSignalLike)

Wysyła wiadomość przez połączenie.

function send(data: string, abortSignal?: AbortSignalLike): Promise<void>

Parametry

data

string

abortSignal

AbortSignalLike

Zwraca

Promise<void>

setHandlers(VoiceAgentWebSocketHandlers)

Rejestruje handlery wywoływane w momencie wystąpienia zdarzeń połączenia.

function setHandlers(handlers: VoiceAgentWebSocketHandlers)

Parametry

handlers

VoiceAgentWebSocketHandlers