VoiceAgentWebSocketTransport interface

Package:

@azure/ai-projects

Un transport WebSocket branchable utilisé par VoiceAgentRealtimeClient. Implémentez cette interface pour personnaliser la manière dont la connexion en temps réel est établie, par exemple pour la faire passer par un relais authentifié.

Méthodes

close(number, string)	Ferme la connexion.
connect(VoiceAgentWebSocketConnectOptions)	Établit la connexion WebSocket.
send(string, AbortSignalLike)	Il envoie un message via la connexion.
setHandlers(VoiceAgentWebSocketHandlers)	Enregistre les gestionnaires invoqués au fur et à mesure que les événements de connexion se produisent.

Détails de la méthode

close(number, string)

Ferme la connexion.

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

Paramètres

code

number

reason

string

Retours

Promise<void>

connect(VoiceAgentWebSocketConnectOptions)

Établit la connexion WebSocket.

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

Paramètres

options

VoiceAgentWebSocketConnectOptions

Retours

Promise<void>

send(string, AbortSignalLike)

Il envoie un message via la connexion.

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

Paramètres

data

string

abortSignal

AbortSignalLike

Retours

Promise<void>

setHandlers(VoiceAgentWebSocketHandlers)

Enregistre les gestionnaires invoqués au fur et à mesure que les événements de connexion se produisent.

function setHandlers(handlers: VoiceAgentWebSocketHandlers)

Paramètres

handlers

VoiceAgentWebSocketHandlers