VoiceAgentWebSocketTransport interface

套件:

@azure/ai-projects

VoiceAgentRealtimeClient 使用的可插拔式 WebSocket 傳輸工具。 實作此介面以自訂即時連線的建立方式，例如將連線路由經過認證的中繼站。

方法

close(number, string)	關閉連線。
connect(VoiceAgentWebSocketConnectOptions)	建立 WebSocket 連線。
send(string, AbortSignalLike)	透過連線發送訊息。
setHandlers(VoiceAgentWebSocketHandlers)	登錄連線事件發生時呼叫的處理器。

方法詳細資料

close(number, string)

關閉連線。

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

參數

code

number

reason

string

傳回

Promise<void>

connect(VoiceAgentWebSocketConnectOptions)

建立 WebSocket 連線。

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

參數

options

VoiceAgentWebSocketConnectOptions

傳回

Promise<void>

send(string, AbortSignalLike)

透過連線發送訊息。

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

參數

data

string

abortSignal

AbortSignalLike

傳回

Promise<void>

setHandlers(VoiceAgentWebSocketHandlers)

登錄連線事件發生時呼叫的處理器。

function setHandlers(handlers: VoiceAgentWebSocketHandlers)

參數

handlers

VoiceAgentWebSocketHandlers