VoiceAgentRealtimeClientConnectOptions interface

Pakket:

@azure/ai-projects

Opties om de realtime client te verbinden met een voice agent.

Uitbreiding

OperationOptions

Eigenschappen

abortSignal	Annuleert de verbindingspoging.
agentSessionId	Identificatie gebruikt om de spraaksessie te correleren.
agentVersionOverride	Selecteert een specifieke versie van onveranderlijke agent.
connectionTimeoutInMs	Overschrijft de time-out van de clientverbinding in milliseconden.
onConnectionStateChange	Ontvangt verbindings-toestandsovergangen.
query	Aanvullende queryparameters voor de WebSocket-upgrade-URL van deze verbinding. Bied een eenvoudig object aan, inclusief een null-prototype object. Waarden overschrijven de parameters van het overeenkomende eindpunt; undefined verwijdert een parameter. Waarden worden automatisch via URL's gecodeerd. Getallen moeten eindig zijn. SDK-beheerde parameters, authenticatieparameters en namen die beginnen met h- worden gereserveerd (hoofdletter-ongevoelig) en veroorzaken een TypeError. Gebruik in plaats daarvan de bijbehorende getypeerde opties voor sessie-, versie-, opslag-, transport- en gestructureerde prompt-invoer. Beide structured_input en structured_inputs zijn gereserveerd. Sluit geen geheimen op: queryparameters kunnen voorkomen in server- of proxylogs.
store	Heft op of het gesprek dat door deze sessie is ontstaan wordt voortgezet.
structuredInputs	Waarden die worden gebruikt om de gestructureerde prompt-invoer van de agent weer te geven. Geserialiseerd wanneer connect() wordt aangeroepen, vóór authenticatie.
transport	Selecteert het transport dat wordt gebruikt voor de realtime verbinding. Wordt standaard ingesteld op "websocket". Stel in plaats daarvan in om "webrtc" een WebRTC-peerverbinding te onderhandelen; de beller is verantwoordelijk voor het voltooien van de SDP-aanbieding/antwoorduitwisseling via de rtc.call.sdp.create en rtc.call.sdp.created gebeurtenissen (zie VoiceAgentRealtimeEvent).

Overgenomen eigenschappen

onResponse	Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.
requestOptions	Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.
tracingOptions	Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

abortSignal

Annuleert de verbindingspoging.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

agentSessionId

Identificatie gebruikt om de spraaksessie te correleren.

agentSessionId?: string

Waarde van eigenschap

string

agentVersionOverride

Selecteert een specifieke versie van onveranderlijke agent.

agentVersionOverride?: string

Waarde van eigenschap

string

connectionTimeoutInMs

Overschrijft de time-out van de clientverbinding in milliseconden.

connectionTimeoutInMs?: number

Waarde van eigenschap

number

onConnectionStateChange

Ontvangt verbindings-toestandsovergangen.

onConnectionStateChange?: VoiceAgentConnectionStateChangedHandler

Waarde van eigenschap

VoiceAgentConnectionStateChangedHandler

query

Aanvullende queryparameters voor de WebSocket-upgrade-URL van deze verbinding. Bied een eenvoudig object aan, inclusief een null-prototype object. Waarden overschrijven de parameters van het overeenkomende eindpunt; undefined verwijdert een parameter. Waarden worden automatisch via URL's gecodeerd. Getallen moeten eindig zijn. SDK-beheerde parameters, authenticatieparameters en namen die beginnen met h- worden gereserveerd (hoofdletter-ongevoelig) en veroorzaken een TypeError. Gebruik in plaats daarvan de bijbehorende getypeerde opties voor sessie-, versie-, opslag-, transport- en gestructureerde prompt-invoer. Beide structured_input en structured_inputs zijn gereserveerd. Sluit geen geheimen op: queryparameters kunnen voorkomen in server- of proxylogs.

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

Waarde van eigenschap

Readonly<Record<string, string | number | boolean | undefined>>

store

Heft op of het gesprek dat door deze sessie is ontstaan wordt voortgezet.

store?: boolean

Waarde van eigenschap

boolean

structuredInputs

Waarden die worden gebruikt om de gestructureerde prompt-invoer van de agent weer te geven. Geserialiseerd wanneer connect() wordt aangeroepen, vóór authenticatie.

structuredInputs?: Record<string, unknown>

Waarde van eigenschap

Record<string, unknown>

transport

Selecteert het transport dat wordt gebruikt voor de realtime verbinding. Wordt standaard ingesteld op "websocket". Stel in plaats daarvan in om "webrtc" een WebRTC-peerverbinding te onderhandelen; de beller is verantwoordelijk voor het voltooien van de SDP-aanbieding/antwoorduitwisseling via de rtc.call.sdp.create en rtc.call.sdp.created gebeurtenissen (zie VoiceAgentRealtimeEvent).

transport?: VoiceAgentTransport

Waarde van eigenschap

VoiceAgentTransport

Details van overgenomen eigenschap

onResponse

Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

onResponse?: RawResponseCallback

Waarde van eigenschap

RawResponseCallback

overgenomen van OperationOptions.onResponse

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

requestOptions?: OperationRequestOptions

Waarde van eigenschap

OperationRequestOptions

overgenomen van OperationOptions.requestOptions

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

overgenomen van OperationOptions.tracingOptions