VoiceAgentRealtimeClientConnectOptions interface
リアルタイムクライアントとボイスエージェントを接続するオプション。
- Extends
プロパティ
| abort |
接続試行をキャンセルします。 |
| agent |
音声セッションを関連付けるために使われる識別子。 |
| agent |
特定の不変エージェントバージョンを選択します。 |
| connection |
クライアント接続のタイムアウトをミリ秒単位で上書きします。 |
| on |
接続状態遷移を受信します。 |
| store | このセッションで作成された会話が永続化されているかどうかを上書きします。 |
| structured |
エージェントの構造化されたプロンプト入力をレンダリングするために使われる値。 |
継承されたプロパティ
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
abortSignal
agentSessionId
音声セッションを関連付けるために使われる識別子。
agentSessionId?: stringプロパティ値
string
agentVersionOverride
特定の不変エージェントバージョンを選択します。
agentVersionOverride?: stringプロパティ値
string
connectionTimeoutInMs
クライアント接続のタイムアウトをミリ秒単位で上書きします。
connectionTimeoutInMs?: numberプロパティ値
number
onConnectionStateChange
接続状態遷移を受信します。
onConnectionStateChange?: VoiceAgentConnectionStateChangedHandlerプロパティ値
store
このセッションで作成された会話が永続化されているかどうかを上書きします。
store?: booleanプロパティ値
boolean
structuredInputs
エージェントの構造化されたプロンプト入力をレンダリングするために使われる値。
structuredInputs?: Record<string, unknown>プロパティ値
Record<string, unknown>
継承されたプロパティの詳細
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallbackプロパティ値
OperationOptions.onResponse から継承された
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptionsプロパティ値
OperationOptions.requestOptions から継承された
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptionsプロパティ値
OperationOptions.tracingOptions から継承された