VoiceAgentRealtimeClientConnectOptions interface

Anuluje próbę połączenia.

abortSignal?: AbortSignalLike

Wartość właściwości

Identyfikator używany do korelacji sesji głosowej.

agentSessionId?: string

Wartość właściwości

Wybiera konkretną wersję niezmiennego agenta.

agentVersionOverride?: string

Wartość właściwości

Nadpisuje czas połączenia klienta w milisekundach.

connectionTimeoutInMs?: number

Wartość właściwości

Otrzymuje przejścia między stanami połączenia.

onConnectionStateChange?: VoiceAgentConnectionStateChangedHandler

Wartość właściwości

Dodatkowe parametry zapytania dla aktualizacji WebSocket tego połączenia. Zapewnij zwykły obiekt, w tym obiekt typu null-prototype. Nadpisuje wartości dopasowania parametrów zapytania końcowego; undefined usuwa parametr. Wartości są kodowane automatycznie w URL. Liczby muszą być skończone. Parametry zarządzane przez SDK, parametry uwierzytelniania oraz nazwy zaczynające się od h- są zarezerwowane (bez znaczenia wielkości liter) i powodują .TypeError Zamiast tego użyj odpowiednich typowych opcji dla sesji, wersji, przechowywania, transportu i strukturalnych promptów. Oba są structured_input zarezerwowane structured_inputs . Nie uwzględniaj sekretów: parametry zapytań mogą pojawić się w logach serwera lub proxy.

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

Wartość właściwości

Nadpisuje, czy rozmowa utworzona przez tę sesję jest kontynuowana.

store?: boolean

Wartość właściwości

Wartości używane do renderowania strukturyzowanych promptów agenta. Serializowane po connect() wywołaniu, przed uwierzytelnianiem.

structuredInputs?: Record<string, unknown>

Wartość właściwości

Wybiera transport używany do połączenia w czasie rzeczywistym. Wartość domyślna to "websocket". Ustawiane tak, aby "webrtc" negocjował połączenie WebRTC peer; dzwoniący odpowiada za zakończenie wymiany ofert/odpowiedzi SDP za pomocą zdarzeń rtc.call.sdp.create i rtc.call.sdp.created (patrz VoiceAgentRealtimeEvent).

transport?: VoiceAgentTransport

Wartość właściwości

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

onResponse?: RawResponseCallback

Wartość właściwości

Dziedziczone z OperationOptions.onResponse

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

requestOptions?: OperationRequestOptions

Wartość właściwości

Dziedziczone z OperationOptions.requestOptions

Opcje używane podczas śledzenia są włączone.

tracingOptions?: OperationTracingOptions

Wartość właściwości

Dziedziczone z OperationOptions.tracingOptions