VoiceAgentWebSocketTransport interface

Pacote:

@azure/ai-projects

Um transporte WebSocket plugável usado pelo VoiceAgentRealtimeClient. Implemente esta interface para personalizar a forma como a ligação em tempo real é estabelecida, por exemplo, para a encaminhar através de um relé autenticado.

Métodos

close(number, string)	Fecha a ligação.
connect(VoiceAgentWebSocketConnectOptions)	Estabelece a ligação WebSocket.
send(string, AbortSignalLike)	Envia uma mensagem pela ligação.
setHandlers(VoiceAgentWebSocketHandlers)	Regista os handlers invocados à medida que ocorrem eventos de ligação.

Detalhes de Método

close(number, string)

Fecha a ligação.

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

Parâmetros

code

number

reason

string

Devoluções

Promise<void>

connect(VoiceAgentWebSocketConnectOptions)

Estabelece a ligação WebSocket.

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

Parâmetros

options

VoiceAgentWebSocketConnectOptions

Devoluções

Promise<void>

send(string, AbortSignalLike)

Envia uma mensagem pela ligação.

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

Parâmetros

data

string

abortSignal

AbortSignalLike

Devoluções

Promise<void>

setHandlers(VoiceAgentWebSocketHandlers)

Regista os handlers invocados à medida que ocorrem eventos de ligação.

function setHandlers(handlers: VoiceAgentWebSocketHandlers)

Parâmetros

handlers

VoiceAgentWebSocketHandlers