VoiceAgentConnection interface

Package:

@azure/ai-projects

Un flux d’agent vocal bidirectionnel et connecté.

Prend en charge exactement une for await itération sur les événements serveur ; une seconde tentative jette. Sortir de la boucle tôt (break, return, ou une erreur non détectée dans le corps de la boucle) ferme la connexion en conséquence. Les types d’événements serveur non reconnus sont livrés sous forme de VoiceAgentUnknownEvent sans interrompre le flux. Les événements malformés échouent toujours à l’itération avec une erreur de protocole.

Extends

AsyncIterable<VoiceAgentRealtimeEvent>

Propriétés

closed	Ça se résout une fois la connexion fermée.
state	État actuel de la connexion.

Méthodes

cancelResponse(VoiceAgentCancelResponseOptions)	Annule une réponse en cours.
clearInputAudio(VoiceAgentEventOptions)	Ça efface l’audio en mémoire tampon.
clearOutputAudio(VoiceAgentEventOptions)	Annule l’audio en attente au service.
close(number, string)	Ferme gracieusement la connexion WebSocket.
commitAudio(VoiceAgentEventOptions)	Envoie l’audio en mémoire tampon (commence).
configureSession(VoiceAgentSessionUpdateConfig, VoiceAgentSessionUpdateOptions)	Les mises à jour prenaient en charge les paramètres de session en direct.
dispose()	Ça libère la connexion. Équivalent à close().
requestResponse(VoiceAgentResponseOptions)	Demande une nouvelle réponse.
sendAudio(ArrayBuffer | Uint8Array, VoiceAgentEventOptions)	Ajoute des octets audio codés en base 64 au tampon d’entrée.
sendEvent(VoiceAgentClientEvent, VoiceAgentSendOptions)	Envoie tout événement de protocole client généré.
sendText(string, VoiceAgentSendTextOptions)	Ajoute un élément de texte utilisateur et, par défaut, demande une réponse.
sendToolOutput(string, string, VoiceAgentSendToolOutputOptions)	Renvoie un résultat de fonction exécuté par le client à l’agent.

Méthodes héritées

[asyncIterator]()

Détails de la propriété

closed

Ça se résout une fois la connexion fermée.

closed: Promise<VoiceAgentCloseResult>

Valeur de propriété

Promise<VoiceAgentCloseResult>

state

État actuel de la connexion.

state: VoiceAgentConnectionState

Valeur de propriété

VoiceAgentConnectionState

Détails de la méthode

cancelResponse(VoiceAgentCancelResponseOptions)

Annule une réponse en cours.

function cancelResponse(options?: VoiceAgentCancelResponseOptions): Promise<void>

Paramètres

options

VoiceAgentCancelResponseOptions

Retours

Promise<void>

clearInputAudio(VoiceAgentEventOptions)

Ça efface l’audio en mémoire tampon.

function clearInputAudio(options?: VoiceAgentEventOptions): Promise<void>

Paramètres

options

VoiceAgentEventOptions

Retours

Promise<void>

clearOutputAudio(VoiceAgentEventOptions)

Annule l’audio en attente au service.

function clearOutputAudio(options?: VoiceAgentEventOptions): Promise<void>

Paramètres

options

VoiceAgentEventOptions

Retours

Promise<void>

close(number, string)

Ferme gracieusement la connexion WebSocket.

function close(code?: number, reason?: string): Promise<void>

Paramètres

code

number

reason

string

Retours

Promise<void>

commitAudio(VoiceAgentEventOptions)

Envoie l’audio en mémoire tampon (commence).

function commitAudio(options?: VoiceAgentEventOptions): Promise<void>

Paramètres

options

VoiceAgentEventOptions

Retours

Promise<void>

configureSession(VoiceAgentSessionUpdateConfig, VoiceAgentSessionUpdateOptions)

Les mises à jour prenaient en charge les paramètres de session en direct.

function configureSession(session: VoiceAgentSessionUpdateConfig, options?: VoiceAgentSessionUpdateOptions): Promise<void>

Paramètres

session

VoiceAgentSessionUpdateConfig

options

VoiceAgentSessionUpdateOptions

Retours

Promise<void>

dispose()

Ça libère la connexion. Équivalent à close().

function dispose(): Promise<void>

Retours

Promise<void>

requestResponse(VoiceAgentResponseOptions)

Demande une nouvelle réponse.

function requestResponse(options?: VoiceAgentResponseOptions): Promise<void>

Paramètres

options

VoiceAgentResponseOptions

Retours

Promise<void>

sendAudio(ArrayBuffer | Uint8Array, VoiceAgentEventOptions)

Ajoute des octets audio codés en base 64 au tampon d’entrée.

function sendAudio(audio: ArrayBuffer | Uint8Array, options?: VoiceAgentEventOptions): Promise<void>

Paramètres

audio

ArrayBuffer | Uint8Array

options

VoiceAgentEventOptions

Retours

Promise<void>

sendEvent(VoiceAgentClientEvent, VoiceAgentSendOptions)

Envoie tout événement de protocole client généré.

function sendEvent(event: VoiceAgentClientEvent, options?: VoiceAgentSendOptions): Promise<void>

Paramètres

event

VoiceAgentClientEvent

options

VoiceAgentSendOptions

Retours

Promise<void>

sendText(string, VoiceAgentSendTextOptions)

Ajoute un élément de texte utilisateur et, par défaut, demande une réponse.

function sendText(text: string, options?: VoiceAgentSendTextOptions): Promise<void>

Paramètres

text

string

options

VoiceAgentSendTextOptions

Retours

Promise<void>

sendToolOutput(string, string, VoiceAgentSendToolOutputOptions)

Renvoie un résultat de fonction exécuté par le client à l’agent.

function sendToolOutput(callId: string, output: string, options?: VoiceAgentSendToolOutputOptions): Promise<void>

Paramètres

callId

string

output

string

options

VoiceAgentSendToolOutputOptions

Retours

Promise<void>

Détails de la méthode héritée

[asyncIterator]()

function [asyncIterator](): AsyncIterator<VoiceAgentRealtimeEvent, any, any>

Retours

AsyncIterator<VoiceAgentRealtimeEvent, any, any>

hérité de AsyncIterable. [asyncIterator]