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