VoiceAgentRealtimeClientConnectOptions interface

パッケージ:
@azure/ai-projects

リアルタイムクライアントとボイスエージェントを接続するオプション。

Extends
OperationOptions

プロパティ

abortSignal

接続試行をキャンセルします。
agentSessionId

音声セッションを関連付けるために使われる識別子。
agentVersionOverride

特定の不変エージェントバージョンを選択します。
connectionTimeoutInMs

クライアント接続のタイムアウトをミリ秒単位で上書きします。
onConnectionStateChange

接続状態遷移を受信します。
query

この接続のWebSocketアップグレードURLに関する追加のクエリパラメータ。 ヌルプロトタイプオブジェクトを含むプレーンオブジェクトを提供します。 値は一致するエンドポイントクエリパラメータを上書きします。 undefined パラメータを除去します。 値は自動的にURLでエンコードされます。 数は有限でなければなりません。 SDK管理のパラメータ、認証パラメータ、 h- で始まる名前は(大文字を区別しない形で)予約され、 TypeErrorを引き起こします。 代わりに、セッション、バージョン、ストレージ、トランスポート、構造化プロンプト入力に対応するタイプ付きオプションを使いましょう。 structured_inputもstructured_inputsも予約されています。 シークレットを含めないでください:クエリパラメータはサーバーやプロキシのログに現れることがあります。
store

このセッションで作成された会話が永続化されているかどうかを上書きします。
structuredInputs

エージェントの構造化されたプロンプト入力をレンダリングするために使われる値。 認証前に connect() が呼び出されるとシリアライズされます。
transport

リアルタイム接続に使用されるトランスポートを選択します。 既定値は "websocket" です。 代わりに"webrtc"に設定してWebRTCピア接続を交渉します。発信者はrtc.call.sdp.createおよびrtc.call.sdp.createdVoiceAgentRealtimeEvent(VoiceAgentRealtimeEvent参照)を使ってSDPの申し込み/応答交換を完了する責任があります。

継承されたプロパティ

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。
tracingOptions

トレースが有効な場合に使用されるオプション。

プロパティの詳細

abortSignal

接続試行をキャンセルします。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

agentSessionId

音声セッションを関連付けるために使われる識別子。

agentSessionId?: string

プロパティ値

string

agentVersionOverride

特定の不変エージェントバージョンを選択します。

agentVersionOverride?: string

プロパティ値

string

connectionTimeoutInMs

クライアント接続のタイムアウトをミリ秒単位で上書きします。

connectionTimeoutInMs?: number

プロパティ値

number

onConnectionStateChange

接続状態遷移を受信します。

onConnectionStateChange?: VoiceAgentConnectionStateChangedHandler

プロパティ値

VoiceAgentConnectionStateChangedHandler

query

この接続のWebSocketアップグレードURLに関する追加のクエリパラメータ。 ヌルプロトタイプオブジェクトを含むプレーンオブジェクトを提供します。 値は一致するエンドポイントクエリパラメータを上書きします。 undefined パラメータを除去します。 値は自動的にURLでエンコードされます。 数は有限でなければなりません。 SDK管理のパラメータ、認証パラメータ、 h- で始まる名前は(大文字を区別しない形で)予約され、 TypeErrorを引き起こします。 代わりに、セッション、バージョン、ストレージ、トランスポート、構造化プロンプト入力に対応するタイプ付きオプションを使いましょう。 structured_inputもstructured_inputsも予約されています。 シークレットを含めないでください:クエリパラメータはサーバーやプロキシのログに現れることがあります。

query?: Readonly<Record<string, string | number | boolean | undefined>>

プロパティ値

Readonly<Record<string, string | number | boolean | undefined>>

store

このセッションで作成された会話が永続化されているかどうかを上書きします。

store?: boolean

プロパティ値

boolean

structuredInputs

エージェントの構造化されたプロンプト入力をレンダリングするために使われる値。 認証前に connect() が呼び出されるとシリアライズされます。

structuredInputs?: Record<string, unknown>

プロパティ値

Record<string, unknown>

transport

リアルタイム接続に使用されるトランスポートを選択します。 既定値は "websocket" です。 代わりに"webrtc"に設定してWebRTCピア接続を交渉します。発信者はrtc.call.sdp.createおよびrtc.call.sdp.createdVoiceAgentRealtimeEvent(VoiceAgentRealtimeEvent参照)を使ってSDPの申し込み/応答交換を完了する責任があります。

transport?: VoiceAgentTransport

プロパティ値

VoiceAgentTransport

継承されたプロパティの詳細

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

onResponse?: RawResponseCallback

プロパティ値

RawResponseCallback

OperationOptions.onResponse から継承された

requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

requestOptions?: OperationRequestOptions

プロパティ値

OperationRequestOptions

OperationOptions.requestOptions から継承された

tracingOptions

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

OperationOptions.tracingOptions から継承された