VoiceAgentRealtimeClientOptions interface

パッケージ:

@azure/ai-projects

Voice Agentsのリアルタイムクライアントのオプション。

プロパティ

apiVersion	WebSocketのアップグレード時にAPIバージョンが送られました。
connectionTimeoutInMs	デフォルトの接続タイムアウトはミリ秒単位です。
credentialScopes	Microsoft Entra スコープは WebSocket アクセストークンを取得するために使用されます。
userAgentPrefix	Node.jsでSDKのユーザーエージェント値に追加されたプレフィックス。
webSocketFactory	リアルタイムWebSocket接続確立に使用されたトランスポートを上書きします。 デフォルトはプラットフォームトランスポート(Node.jsではws 、ブラウザやReact Nativeではブラウザのネイティブ WebSocket )です。 カスタムファクトリーを提供し、接続環境をカスタマイズしましょう。

プロパティの詳細

apiVersion

WebSocketのアップグレード時にAPIバージョンが送られました。

apiVersion?: string

プロパティ値

string

connectionTimeoutInMs

デフォルトの接続タイムアウトはミリ秒単位です。

connectionTimeoutInMs?: number

プロパティ値

number

credentialScopes

Microsoft Entra スコープは WebSocket アクセストークンを取得するために使用されます。

credentialScopes?: string | string[]

プロパティ値

string | string[]

userAgentPrefix

Node.jsでSDKのユーザーエージェント値に追加されたプレフィックス。

userAgentPrefix?: string

プロパティ値

string

webSocketFactory

リアルタイムWebSocket接続確立に使用されたトランスポートを上書きします。 デフォルトはプラットフォームトランスポート(Node.jsではws 、ブラウザやReact Nativeではブラウザのネイティブ WebSocket )です。 カスタムファクトリーを提供し、接続環境をカスタマイズしましょう。

webSocketFactory?: VoiceAgentWebSocketFactory

プロパティ値

VoiceAgentWebSocketFactory