VoiceAgentConnection interface

Pakket:

@azure/ai-projects

Een verbonden, bidirectionele voice-agent-stroom.

Ondersteunt precies één for await iteratie over servergebeurtenissen; een tweede poging gooit dit. Het vroegtijdig verlaten van de lus (break, , returnof een onopgemerkte fout in het luslichaam) sluit de verbinding als neveneffect. Niet-herkende servergebeurtenistypen worden geleverd als VoiceAgentUnknownEvent zonder de stroom te onderbreken. Misvormde gebeurtenissen mislukken nog steeds bij de iteratie met een protocolfout.

Uitbreiding

AsyncIterable<VoiceAgentRealtimeEvent>

Eigenschappen

closed	Lost op zodra de verbinding is gesloten.
state	Huidige verbindingsstatus.

Methoden

cancelResponse(VoiceAgentCancelResponseOptions)	Annuleert een lopende reactie.
clearInputAudio(VoiceAgentEventOptions)	Verwijdert gebuffde input-audio.
clearOutputAudio(VoiceAgentEventOptions)	Verwijdert de afwachtende uitgang van audio tijdens de dienst.
close(number, string)	Sluit de WebSocket-verbinding gracieus.
commitAudio(VoiceAgentEventOptions)	Commits gebuffte inputaudio.
configureSession(VoiceAgentSessionUpdateConfig, VoiceAgentSessionUpdateOptions)	Updates ondersteunden live-sessie-instellingen.
dispose()	Verbreekt de verbinding. Equivalent aan close().
requestResponse(VoiceAgentResponseOptions)	Vraagt om een nieuw antwoord.
sendAudio(ArrayBuffer | Uint8Array, VoiceAgentEventOptions)	Voegt base64-gecodeerde audiobytes toe aan de inputbuffer.
sendEvent(VoiceAgentClientEvent, VoiceAgentSendOptions)	Stuurt elk gegenereerd clientprotocol-event.
sendText(string, VoiceAgentSendTextOptions)	Voegt een gebruikerstekstitem toe en vraagt standaard om een reactie.
sendToolOutput(string, string, VoiceAgentSendToolOutputOptions)	Geeft een door de client uitgevoerde functieresultaat terug aan de agent.

Overgenomen methoden

[asyncIterator]()

Eigenschapdetails

closed

Lost op zodra de verbinding is gesloten.

closed: Promise<VoiceAgentCloseResult>

Waarde van eigenschap

Promise<VoiceAgentCloseResult>

state

Huidige verbindingsstatus.

state: VoiceAgentConnectionState

Waarde van eigenschap

VoiceAgentConnectionState

Methodedetails

cancelResponse(VoiceAgentCancelResponseOptions)

Annuleert een lopende reactie.

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

Parameters

options

VoiceAgentCancelResponseOptions

Retouren

Promise<void>

clearInputAudio(VoiceAgentEventOptions)

Verwijdert gebuffde input-audio.

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

Parameters

options

VoiceAgentEventOptions

Retouren

Promise<void>

clearOutputAudio(VoiceAgentEventOptions)

Verwijdert de afwachtende uitgang van audio tijdens de dienst.

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

Parameters

options

VoiceAgentEventOptions

Retouren

Promise<void>

close(number, string)

Sluit de WebSocket-verbinding gracieus.

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

Parameters

code

number

reason

string

Retouren

Promise<void>

commitAudio(VoiceAgentEventOptions)

Commits gebuffte inputaudio.

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

Parameters

options

VoiceAgentEventOptions

Retouren

Promise<void>

configureSession(VoiceAgentSessionUpdateConfig, VoiceAgentSessionUpdateOptions)

Updates ondersteunden live-sessie-instellingen.

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

Parameters

session

VoiceAgentSessionUpdateConfig

options

VoiceAgentSessionUpdateOptions

Retouren

Promise<void>

dispose()

Verbreekt de verbinding. Equivalent aan close().

function dispose(): Promise<void>

Retouren

Promise<void>

requestResponse(VoiceAgentResponseOptions)

Vraagt om een nieuw antwoord.

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

Parameters

options

VoiceAgentResponseOptions

Retouren

Promise<void>

sendAudio(ArrayBuffer | Uint8Array, VoiceAgentEventOptions)

Voegt base64-gecodeerde audiobytes toe aan de inputbuffer.

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

Parameters

audio

ArrayBuffer | Uint8Array

options

VoiceAgentEventOptions

Retouren

Promise<void>

sendEvent(VoiceAgentClientEvent, VoiceAgentSendOptions)

Stuurt elk gegenereerd clientprotocol-event.

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

Parameters

event

VoiceAgentClientEvent

options

VoiceAgentSendOptions

Retouren

Promise<void>

sendText(string, VoiceAgentSendTextOptions)

Voegt een gebruikerstekstitem toe en vraagt standaard om een reactie.

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

Parameters

text

string

options

VoiceAgentSendTextOptions

Retouren

Promise<void>

sendToolOutput(string, string, VoiceAgentSendToolOutputOptions)

Geeft een door de client uitgevoerde functieresultaat terug aan de agent.

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

Parameters

callId

string

output

string

options

VoiceAgentSendToolOutputOptions

Retouren

Promise<void>

Details overgenomen methode

[asyncIterator]()

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

Retouren

AsyncIterator<VoiceAgentRealtimeEvent, any, any>

Geërfd van Asynciterabel. [asynciterator]