VoiceAgentRealtimeClientOptions interface

Pakket:

@azure/ai-projects

Opties voor de realtime client van Voice Agents.

Eigenschappen

apiVersion	API-versie verzonden tijdens de WebSocket-upgrade.
connectionTimeoutInMs	Standaard verbindingstimeout in milliseconden.
credentialScopes	Microsoft Entra scopes werden gebruikt om een WebSocket-toegangstoken te verkrijgen.
userAgentPrefix	Prefix toegevoegd aan de SDK user-agent waarde in Node.js.
webSocketFactory	Overschrijft het transport dat werd gebruikt om de realtime WebSocket-verbinding tot stand te brengen. Standaard is het platformtransport (ws in Node.js, de browser is native WebSocket in browsers/React Native). Bied een aangepaste fabriek aan om de verbinding aan te passen.

Eigenschapdetails

apiVersion

API-versie verzonden tijdens de WebSocket-upgrade.

apiVersion?: string

Waarde van eigenschap

string

connectionTimeoutInMs

Standaard verbindingstimeout in milliseconden.

connectionTimeoutInMs?: number

Waarde van eigenschap

number

credentialScopes

Microsoft Entra scopes werden gebruikt om een WebSocket-toegangstoken te verkrijgen.

credentialScopes?: string | string[]

Waarde van eigenschap

string | string[]

userAgentPrefix

Prefix toegevoegd aan de SDK user-agent waarde in Node.js.

userAgentPrefix?: string

Waarde van eigenschap

string

webSocketFactory

Overschrijft het transport dat werd gebruikt om de realtime WebSocket-verbinding tot stand te brengen. Standaard is het platformtransport (ws in Node.js, de browser is native WebSocket in browsers/React Native). Bied een aangepaste fabriek aan om de verbinding aan te passen.

webSocketFactory?: VoiceAgentWebSocketFactory

Waarde van eigenschap

VoiceAgentWebSocketFactory