VoiceAgentWebSocketTransport interface

Pacote:

@azure/ai-projects

Um transporte WebSocket plugável usado pelo VoiceAgentRealtimeClient. Implemente essa interface para personalizar como a conexão em tempo real é estabelecida, por exemplo, para roteá-la por um relé autenticado.

Métodos

close(number, string)	Encerra a conexão.
connect(VoiceAgentWebSocketConnectOptions)	Estabelece a conexão WebSocket.
send(string, AbortSignalLike)	Envia uma mensagem pela conexão.
setHandlers(VoiceAgentWebSocketHandlers)	Registra os manipuladores invocados conforme eventos de conexão ocorrem.

Detalhes do método

close(number, string)

Encerra a conexão.

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

Parâmetros

code

number

reason

string

Retornos

Promise<void>

connect(VoiceAgentWebSocketConnectOptions)

Estabelece a conexão WebSocket.

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

Parâmetros

options

VoiceAgentWebSocketConnectOptions

Retornos

Promise<void>

send(string, AbortSignalLike)

Envia uma mensagem pela conexão.

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

Parâmetros

data

string

abortSignal

AbortSignalLike

Retornos

Promise<void>

setHandlers(VoiceAgentWebSocketHandlers)

Registra os manipuladores invocados conforme eventos de conexão ocorrem.

function setHandlers(handlers: VoiceAgentWebSocketHandlers)

Parâmetros

handlers

VoiceAgentWebSocketHandlers