VoiceAgentWebSocketTransport interface

Balíček:

@azure/ai-projects

Připojitelný WebSocket transport používaný VoiceAgentRealtimeClient. Toto rozhraní implementujte pro přizpůsobení způsobu navázání spojení v reálném čase, například pro směrování přes autentizované relé.

Metody

close(number, string)	Ukončí připojení.
connect(VoiceAgentWebSocketConnectOptions)	Tím se naváže spojení s WebSocketem.
send(string, AbortSignalLike)	Odešle zprávu přes spojení.
setHandlers(VoiceAgentWebSocketHandlers)	Registruje handlery vyvolané při událostech spojení.

Podrobnosti metody

close(number, string)

Ukončí připojení.

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

Parametry

code

number

reason

string

Návraty

Promise<void>

connect(VoiceAgentWebSocketConnectOptions)

Tím se naváže spojení s WebSocketem.

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

Parametry

options

VoiceAgentWebSocketConnectOptions

Návraty

Promise<void>

send(string, AbortSignalLike)

Odešle zprávu přes spojení.

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

Parametry

data

string

abortSignal

AbortSignalLike

Návraty

Promise<void>

setHandlers(VoiceAgentWebSocketHandlers)

Registruje handlery vyvolané při událostech spojení.

function setHandlers(handlers: VoiceAgentWebSocketHandlers)

Parametry

handlers

VoiceAgentWebSocketHandlers