VoiceAgentRealtimeClientConnectOptions interface

Pacchetto:

@azure/ai-projects

Opzioni per collegare il client in tempo reale a un agente vocale.

Extends

OperationOptions

Proprietà

abortSignal	Annulla il tentativo di connessione.
agentSessionId	Identificatore usato per correlare la sessione vocale.
agentVersionOverride	Seleziona una versione specifica dell'agente immutabile.
connectionTimeoutInMs	Sovrascrive il timeout della connessione client in millisecondi.
onConnectionStateChange	Riceve transizioni di stato di connessione.
query	Parametri aggiuntivi di query per l'URL di aggiornamento WebSocket di questa connessione. Fornire un oggetto semplice, incluso un oggetto null-prototype. I valori sovrascrivono i parametri undefined di query dell'endpoint; rimuove un parametro. I valori sono codificati automaticamente tramite URL. I numeri devono essere finiti. I parametri gestiti dagli SDK, i parametri di autenticazione e i nomi che iniziano con h- sono riservati (in modo insensibile alla maiuscolagem) e causano un TypeError. Usa invece le opzioni tipografiche corrispondenti per sessione, versione, archiviazione, trasporto e input strutturati di prompt. Entrambi structured_input e structured_inputs sono riservati. Non includere segreti: i parametri di query possono apparire nei log server o proxy.
store	Sovrascrive se la conversazione creata da questa sessione viene mantenuta.
structuredInputs	Valori utilizzati per visualizzare gli input strutturati dei prompt dell'agente. Serializzato quando connect() viene chiamato, prima dell'autenticazione.
transport	Seleziona il trasporto utilizzato per la connessione in tempo reale. Di default è "websocket". Impostato per "webrtc" negoziare invece una connessione peer WebRTC; il chiamante è responsabile di completare lo scambio offerta/risposta SDP utilizzando gli rtc.call.sdp.create eventi e rtc.call.sdp.created (vedi VoiceAgentRealtimeEvent).

Proprietà ereditate

onResponse	Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.
requestOptions	Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.
tracingOptions	Opzioni utilizzate quando la traccia è abilitata.

Dettagli proprietà

abortSignal

Annulla il tentativo di connessione.

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

agentSessionId

Identificatore usato per correlare la sessione vocale.

agentSessionId?: string

Valore della proprietà

string

agentVersionOverride

Seleziona una versione specifica dell'agente immutabile.

agentVersionOverride?: string

Valore della proprietà

string

connectionTimeoutInMs

Sovrascrive il timeout della connessione client in millisecondi.

connectionTimeoutInMs?: number

Valore della proprietà

number

onConnectionStateChange

Riceve transizioni di stato di connessione.

onConnectionStateChange?: VoiceAgentConnectionStateChangedHandler

Valore della proprietà

VoiceAgentConnectionStateChangedHandler

query

Parametri aggiuntivi di query per l'URL di aggiornamento WebSocket di questa connessione. Fornire un oggetto semplice, incluso un oggetto null-prototype. I valori sovrascrivono i parametri undefined di query dell'endpoint; rimuove un parametro. I valori sono codificati automaticamente tramite URL. I numeri devono essere finiti. I parametri gestiti dagli SDK, i parametri di autenticazione e i nomi che iniziano con h- sono riservati (in modo insensibile alla maiuscolagem) e causano un TypeError. Usa invece le opzioni tipografiche corrispondenti per sessione, versione, archiviazione, trasporto e input strutturati di prompt. Entrambi structured_input e structured_inputs sono riservati. Non includere segreti: i parametri di query possono apparire nei log server o proxy.

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

Valore della proprietà

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

store

Sovrascrive se la conversazione creata da questa sessione viene mantenuta.

store?: boolean

Valore della proprietà

boolean

structuredInputs

Valori utilizzati per visualizzare gli input strutturati dei prompt dell'agente. Serializzato quando connect() viene chiamato, prima dell'autenticazione.

structuredInputs?: Record<string, unknown>

Valore della proprietà

Record<string, unknown>

transport

Seleziona il trasporto utilizzato per la connessione in tempo reale. Di default è "websocket". Impostato per "webrtc" negoziare invece una connessione peer WebRTC; il chiamante è responsabile di completare lo scambio offerta/risposta SDP utilizzando gli rtc.call.sdp.create eventi e rtc.call.sdp.created (vedi VoiceAgentRealtimeEvent).

transport?: VoiceAgentTransport

Valore della proprietà

VoiceAgentTransport

Dettagli proprietà ereditate

onResponse

Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.

onResponse?: RawResponseCallback

Valore della proprietà

RawResponseCallback

Ereditato da OperationOptions.onResponse

requestOptions

Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.

requestOptions?: OperationRequestOptions

Valore della proprietà

OperationRequestOptions

Ereditato da OperationOptions.requestOptions

tracingOptions

Opzioni utilizzate quando la traccia è abilitata.

tracingOptions?: OperationTracingOptions

Valore della proprietà

OperationTracingOptions

Ereditato da OperationOptions.tracingOptions