VoiceAgentWebSocketConnectOptions interface

Package:

@azure/ai-projects

Options passed to VoiceAgentWebSocketTransport.connect.

Properties

abortSignal	Cancels the connection attempt.
connectionTimeoutInMs	Connection timeout, in milliseconds.
headers	Headers to send with the connection upgrade request, where supported by the transport.
protocols	The WebSocket subprotocols to negotiate.
url	The WebSocket URL to connect to.

Property Details

abortSignal

Cancels the connection attempt.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

connectionTimeoutInMs

Connection timeout, in milliseconds.

connectionTimeoutInMs: number

Property Value

number

headers

Headers to send with the connection upgrade request, where supported by the transport.

headers: Record<string, string>

Property Value

Record<string, string>

protocols

The WebSocket subprotocols to negotiate.

protocols: string[]

Property Value

string[]

url

The WebSocket URL to connect to.

url: string

Property Value

string