VoiceAgentWebSocketTransport interface

Paket:
@azure/ai-projects

En pluggbar WebSocket-transport som används av VoiceAgentRealtimeClient. Implementera detta gränssnitt för att anpassa hur realtidsanslutningen etableras, till exempel för att dirigera den genom ett autentiserat relä.

Metoder

close(number, string)

Stänger ned anslutningen.
connect(VoiceAgentWebSocketConnectOptions)

Etablerar WebSocket-anslutningen.
send(string, AbortSignalLike)

Skickar ett meddelande över anslutningen.
setHandlers(VoiceAgentWebSocketHandlers)

Registrerar de hanterare som anropas när anslutningshändelser inträffar.

Metodinformation

close(number, string)

Stänger ned anslutningen.

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

Parametrar

code

number

reason

string

Returer

Promise<void>

connect(VoiceAgentWebSocketConnectOptions)

Etablerar WebSocket-anslutningen.

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

Parametrar

options
VoiceAgentWebSocketConnectOptions

Returer

Promise<void>

send(string, AbortSignalLike)

Skickar ett meddelande över anslutningen.

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

Parametrar

data

string

abortSignal
AbortSignalLike

Returer

Promise<void>

setHandlers(VoiceAgentWebSocketHandlers)

Registrerar de hanterare som anropas när anslutningshändelser inträffar.

function setHandlers(handlers: VoiceAgentWebSocketHandlers)

Parametrar

handlers
VoiceAgentWebSocketHandlers