VoiceAgentRealtimeClientConnectOptions interface

Package:

@azure/ai-projects

Options pour connecter le client en temps réel à un agent vocal.

Extends

OperationOptions

Propriétés

abortSignal	Annule la tentative de connexion.
agentSessionId	Identifiant utilisé pour corréler la session vocale.
agentVersionOverride	Sélectionne une version d’agent immuable spécifique.
connectionTimeoutInMs	Annule le délai d’attente de la connexion client en millisecondes.
onConnectionStateChange	Reçoit les transitions de connexion-état.
query	Paramètres de requête supplémentaires pour l’URL de mise à niveau WebSocket de cette connexion. Fournir un objet simple, y compris un objet prototype nul. Les valeurs suppriment la correspondance des paramètres de requête des terminaux ; undefined supprime un paramètre. Les valeurs sont encodées automatiquement par URL. Les nombres doivent être finis. Les paramètres gérés par SDK, les paramètres d’authentification et les noms commençant par h- sont réservés (insensibles à la majuscule) et provoquent un TypeError. Utilisez plutôt les options tapées correspondantes pour la session, la version, le stockage, le transport et les entrées d’invite structurées. Les deux structured_input et structured_inputs sont réservés. N’incluez pas de secrets : les paramètres de requête peuvent apparaître dans les journaux serveur ou proxy.
store	Outrepasse la poursuite de la conversation créée par cette session.
structuredInputs	Valeurs utilisées pour afficher les entrées structurées de l’agent en prompt. Sérialisé lorsque connect() l’appel est appelé, avant l’authentification.
transport	Sélectionne le transport utilisé pour la connexion en temps réel. La valeur par défaut est "websocket". Réglé pour "webrtc" négocier une connexion peer WebRTC à la place ; l’appelant est responsable de compléter l’échange offre/réponse SDP en utilisant les rtc.call.sdp.create événements et rtc.call.sdp.created ( voir VoiceAgentRealtimeEvent).

Propriétés héritées

onResponse	Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.
requestOptions	Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.
tracingOptions	Options utilisées lorsque le suivi est activé.

Détails de la propriété

abortSignal

Annule la tentative de connexion.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

agentSessionId

Identifiant utilisé pour corréler la session vocale.

agentSessionId?: string

Valeur de propriété

string

agentVersionOverride

Sélectionne une version d’agent immuable spécifique.

agentVersionOverride?: string

Valeur de propriété

string

connectionTimeoutInMs

Annule le délai d’attente de la connexion client en millisecondes.

connectionTimeoutInMs?: number

Valeur de propriété

number

onConnectionStateChange

Reçoit les transitions de connexion-état.

onConnectionStateChange?: VoiceAgentConnectionStateChangedHandler

Valeur de propriété

VoiceAgentConnectionStateChangedHandler

query

Paramètres de requête supplémentaires pour l’URL de mise à niveau WebSocket de cette connexion. Fournir un objet simple, y compris un objet prototype nul. Les valeurs suppriment la correspondance des paramètres de requête des terminaux ; undefined supprime un paramètre. Les valeurs sont encodées automatiquement par URL. Les nombres doivent être finis. Les paramètres gérés par SDK, les paramètres d’authentification et les noms commençant par h- sont réservés (insensibles à la majuscule) et provoquent un TypeError. Utilisez plutôt les options tapées correspondantes pour la session, la version, le stockage, le transport et les entrées d’invite structurées. Les deux structured_input et structured_inputs sont réservés. N’incluez pas de secrets : les paramètres de requête peuvent apparaître dans les journaux serveur ou proxy.

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

Valeur de propriété

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

store

Outrepasse la poursuite de la conversation créée par cette session.

store?: boolean

Valeur de propriété

boolean

structuredInputs

Valeurs utilisées pour afficher les entrées structurées de l’agent en prompt. Sérialisé lorsque connect() l’appel est appelé, avant l’authentification.

structuredInputs?: Record<string, unknown>

Valeur de propriété

Record<string, unknown>

transport

Sélectionne le transport utilisé pour la connexion en temps réel. La valeur par défaut est "websocket". Réglé pour "webrtc" négocier une connexion peer WebRTC à la place ; l’appelant est responsable de compléter l’échange offre/réponse SDP en utilisant les rtc.call.sdp.create événements et rtc.call.sdp.created ( voir VoiceAgentRealtimeEvent).

transport?: VoiceAgentTransport

Valeur de propriété

VoiceAgentTransport

Détails de la propriété héritée

onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.

onResponse?: RawResponseCallback

Valeur de propriété

RawResponseCallback

Hérité de OperationOptions.onResponse

requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.

requestOptions?: OperationRequestOptions

Valeur de propriété

OperationRequestOptions

Hérité de OperationOptions.requestOptions

tracingOptions

Options utilisées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

Hérité de OperationOptions.tracingOptions