VoiceAgentRealtimeClientConnectOptions interface

Hebt den Verbindungsversuch ab.

abortSignal?: AbortSignalLike

Eigenschaftswert

Identifikator, der zur Korrelation der Sprachsitzung verwendet wird.

agentSessionId?: string

Eigenschaftswert

Wählt eine spezifische Version des unveränderlichen Agenten aus.

agentVersionOverride?: string

Eigenschaftswert

Überschreibt das Timeout der Client-Verbindung in Millisekunden.

connectionTimeoutInMs?: number

Eigenschaftswert

Empfängt Verbindungszustandsübergänge.

onConnectionStateChange?: VoiceAgentConnectionStateChangedHandler

Eigenschaftswert

Zusätzliche Abfrageparameter für die WebSocket-Upgrade-URL dieser Verbindung. Stellen Sie ein einfaches Objekt bereit, einschließlich eines Null-Prototyp-Objekts. Werte überschreiben passende Endpunkt-Abfrageparameter; undefined entfernt einen Parameter. Werte werden automatisch URL-kodiert. Zahlen müssen endlich sein. SDK-verwaltete Parameter, Authentifizierungsparameter und Namen, die mit h- beginnen, sind reserviert (kleinschreibungsunsensitiv) und verursachen ein TypeError. Verwenden Sie stattdessen die entsprechenden typisierten Optionen für Sitzung, Version, Speicher, Transport und strukturierte Prompt-Eingaben. Beide structured_input sind structured_inputs reserviert. Keine Geheimnisse einbeziehen: Abfrageparameter können in Server- oder Proxy-Logs erscheinen.

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

Eigenschaftswert

Überschreibt, ob das durch diese Sitzung ausgelöste Gespräch fortgesetzt wird.

store?: boolean

Eigenschaftswert

Werte, die verwendet werden, um die strukturierten Prompt-Eingaben des Agenten darzustellen. Serialisiert, wenn connect() aufgerufen wird, vor der Authentifizierung.

structuredInputs?: Record<string, unknown>

Eigenschaftswert

Wählt den Transport aus, der für die Echtzeitverbindung verwendet wird. Wird standardmäßig auf "websocket" festgelegt. Stattdessen auf "webrtc" eine WebRTC-Peer-Verbindung zu verhandeln; der Anrufer ist dafür verantwortlich, den SDP-Angebots-/Antwortaustausch mittels der rtc.call.sdp.create und-Events rtc.call.sdp.created abzuschließen (siehe VoiceAgentRealtimeEvent).

transport?: VoiceAgentTransport

Eigenschaftswert

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

onResponse?: RawResponseCallback

Eigenschaftswert

Geerbt von OperationOptions.onResponse

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

requestOptions?: OperationRequestOptions

Eigenschaftswert

Geerbt von OperationOptions.requestOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

Geerbt von OperationOptions.tracingOptions