VoiceAgentRealtimeClientConnectOptions interface

Paket:

@azure/ai-projects

Optionen, um den Echtzeit-Client mit einem Sprachagenten zu verbinden.

Extends

OperationOptions

Eigenschaften

abortSignal	Hebt den Verbindungsversuch ab.
agentSessionId	Identifikator, der zur Korrelation der Sprachsitzung verwendet wird.
agentVersionOverride	Wählt eine spezifische Version des unveränderlichen Agenten aus.
connectionTimeoutInMs	Überschreibt das Timeout der Client-Verbindung in Millisekunden.
onConnectionStateChange	Empfängt Verbindungszustandsübergänge.
store	Überschreibt, ob das durch diese Sitzung ausgelöste Gespräch fortgesetzt wird.
structuredInputs	Werte, die verwendet werden, um die strukturierten Prompt-Eingaben des Agenten darzustellen.

Geerbte Eigenschaften

onResponse	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.
requestOptions	Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.
tracingOptions	Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

Details zur Eigenschaft

abortSignal

Hebt den Verbindungsversuch ab.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

agentSessionId

Identifikator, der zur Korrelation der Sprachsitzung verwendet wird.

agentSessionId?: string

Eigenschaftswert

string

agentVersionOverride

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

agentVersionOverride?: string

Eigenschaftswert

string

connectionTimeoutInMs

Überschreibt das Timeout der Client-Verbindung in Millisekunden.

connectionTimeoutInMs?: number

Eigenschaftswert

number

onConnectionStateChange

Empfängt Verbindungszustandsübergänge.

onConnectionStateChange?: VoiceAgentConnectionStateChangedHandler

Eigenschaftswert

VoiceAgentConnectionStateChangedHandler

store

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

store?: boolean

Eigenschaftswert

boolean

structuredInputs

Werte, die verwendet werden, um die strukturierten Prompt-Eingaben des Agenten darzustellen.

structuredInputs?: Record<string, unknown>

Eigenschaftswert

Record<string, unknown>

Geerbte Eigenschaftsdetails

onResponse

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

RawResponseCallback

Geerbt von OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Eigenschaftswert

OperationRequestOptions

Geerbt von OperationOptions.requestOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

Geerbt von OperationOptions.tracingOptions