VoiceAgentRealtimeClientConnectOptions interface
連接即時客戶端與語音代理的選項。
- Extends
屬性
| abort |
取消連線嘗試。 |
| agent |
用於關聯語音會話的識別碼。 |
| agent |
選擇特定的不變代理版本。 |
| connection |
能在毫秒內覆寫用戶端連線逾時。 |
| on |
接收連線狀態轉換。 |
| query | 此連線 WebSocket 升級網址的額外查詢參數。
提供一個純物件，包括一個空原型物件。
值會覆蓋匹配端點查詢參數; |
| store | 覆寫此會話所產生的對話是否持續存在。 |
| structured |
用於渲染代理結構化提示輸入的值。
在 |
| transport | 選擇用於即時連線的傳輸方式。 預設為 |
繼承的屬性
| on |
每次從伺服器收到回應時，要呼叫的函式，同時執行要求的作業。 可以多次呼叫。 |
| request |
建立和傳送此作業之 HTTP 要求時所使用的選項。 |
| tracing |
啟用追蹤時所使用的選項。 |
屬性詳細資料
abortSignal
agentSessionId
用於關聯語音會話的識別碼。
agentSessionId?: string屬性值
string
agentVersionOverride
選擇特定的不變代理版本。
agentVersionOverride?: string屬性值
string
connectionTimeoutInMs
能在毫秒內覆寫用戶端連線逾時。
connectionTimeoutInMs?: number屬性值
number
onConnectionStateChange
接收連線狀態轉換。
onConnectionStateChange?: VoiceAgentConnectionStateChangedHandler屬性值
query
此連線 WebSocket 升級網址的額外查詢參數。
提供一個純物件，包括一個空原型物件。
值會覆蓋匹配端點查詢參數; undefined 移除一個參數。
數值會自動以網址編碼。 數字必須有限。
SDK 管理的參數、認證參數及以 為h-首的名稱皆被保留（不區分大小寫），並導致 。TypeError 改用對應的打字選項，分別是會話、版本、儲存、傳輸和結構化提示輸入。
兩者皆structured_inputstructured_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.created 事件完成 SDP 的報價/接聽交換（參見 VoiceAgentRealtimeEvent）。
transport?: VoiceAgentTransport屬性值
繼承的屬性詳細資料
onResponse
每次從伺服器收到回應時，要呼叫的函式，同時執行要求的作業。 可以多次呼叫。
onResponse?: RawResponseCallback屬性值
繼承自 OperationOptions.onResponse
requestOptions
建立和傳送此作業之 HTTP 要求時所使用的選項。
requestOptions?: OperationRequestOptions屬性值
繼承自 OperationOptions.requestOptions
tracingOptions
啟用追蹤時所使用的選項。
tracingOptions?: OperationTracingOptions屬性值
繼承自 OperationOptions.tracingOptions