VoiceAgentConnection interface

Paket:

@azure/ai-projects

En sammankopplad, tvåvägs röstagentström.

Stöder exakt en for await iteration över serverhändelser; ett andra försök kastar. Att lämna loopen tidigt (break, , returneller ett oupptäckt fel i loopkroppen) stänger anslutningen som en bieffekt. Oigenkända serverhändelsetyper levereras som VoiceAgentUnknownEvent utan att strömmen avbryts. Felaktiga händelser misslyckas fortfarande med iterationen vid ett protokollfel.

Extends

AsyncIterable<VoiceAgentRealtimeEvent>

Egenskaper

closed	Löses när anslutningen är avslutad.
state	Nuvarande anslutningsstatus.

Metoder

cancelResponse(VoiceAgentCancelResponseOptions)	Avbryter ett pågående svar.
clearInputAudio(VoiceAgentEventOptions)	Rensar buffrat ingångsljud.
clearOutputAudio(VoiceAgentEventOptions)	Rensar väntande utgångsljud vid tjänsten.
close(number, string)	Stänger smidigt WebSocket-anslutningen.
commitAudio(VoiceAgentEventOptions)	Commits buffrat ingångsljud.
configureSession(VoiceAgentSessionUpdateConfig, VoiceAgentSessionUpdateOptions)	Uppdateringar stödde inställningar för live-sessioner.
dispose()	Släpper anslutningen. Ekvivalent med close().
requestResponse(VoiceAgentResponseOptions)	Begär ett nytt svar.
sendAudio(ArrayBuffer | Uint8Array, VoiceAgentEventOptions)	Lägger till base64-kodade ljudbyte i ingångsbufferten.
sendEvent(VoiceAgentClientEvent, VoiceAgentSendOptions)	Skickar vilken genererad klientprotokollhändelse som helst.
sendText(string, VoiceAgentSendTextOptions)	Lägger till ett användartextobjekt och begär som standard ett svar.
sendToolOutput(string, string, VoiceAgentSendToolOutputOptions)	Returnerar ett klientkört funktionsresultat till agenten.

Ärvda metoder

[asyncIterator]()

Egenskapsinformation

closed

Löses när anslutningen är avslutad.

closed: Promise<VoiceAgentCloseResult>

Egenskapsvärde

Promise<VoiceAgentCloseResult>

state

Nuvarande anslutningsstatus.

state: VoiceAgentConnectionState

Egenskapsvärde

VoiceAgentConnectionState

Metodinformation

cancelResponse(VoiceAgentCancelResponseOptions)

Avbryter ett pågående svar.

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

Parametrar

options

VoiceAgentCancelResponseOptions

Returer

Promise<void>

clearInputAudio(VoiceAgentEventOptions)

Rensar buffrat ingångsljud.

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

Parametrar

options

VoiceAgentEventOptions

Returer

Promise<void>

clearOutputAudio(VoiceAgentEventOptions)

Rensar väntande utgångsljud vid tjänsten.

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

Parametrar

options

VoiceAgentEventOptions

Returer

Promise<void>

close(number, string)

Stänger smidigt WebSocket-anslutningen.

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

Parametrar

code

number

reason

string

Returer

Promise<void>

commitAudio(VoiceAgentEventOptions)

Commits buffrat ingångsljud.

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

Parametrar

options

VoiceAgentEventOptions

Returer

Promise<void>

configureSession(VoiceAgentSessionUpdateConfig, VoiceAgentSessionUpdateOptions)

Uppdateringar stödde inställningar för live-sessioner.

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

Parametrar

session

VoiceAgentSessionUpdateConfig

options

VoiceAgentSessionUpdateOptions

Returer

Promise<void>

dispose()

Släpper anslutningen. Ekvivalent med close().

function dispose(): Promise<void>

Returer

Promise<void>

requestResponse(VoiceAgentResponseOptions)

Begär ett nytt svar.

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

Parametrar

options

VoiceAgentResponseOptions

Returer

Promise<void>

sendAudio(ArrayBuffer | Uint8Array, VoiceAgentEventOptions)

Lägger till base64-kodade ljudbyte i ingångsbufferten.

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

Parametrar

audio

ArrayBuffer | Uint8Array

options

VoiceAgentEventOptions

Returer

Promise<void>

sendEvent(VoiceAgentClientEvent, VoiceAgentSendOptions)

Skickar vilken genererad klientprotokollhändelse som helst.

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

Parametrar

event

VoiceAgentClientEvent

options

VoiceAgentSendOptions

Returer

Promise<void>

sendText(string, VoiceAgentSendTextOptions)

Lägger till ett användartextobjekt och begär som standard ett svar.

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

Parametrar

text

string

options

VoiceAgentSendTextOptions

Returer

Promise<void>

sendToolOutput(string, string, VoiceAgentSendToolOutputOptions)

Returnerar ett klientkört funktionsresultat till agenten.

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

Parametrar

callId

string

output

string

options

VoiceAgentSendToolOutputOptions

Returer

Promise<void>

Ärvd metodinformation

[asyncIterator]()

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

Returer

AsyncIterator<VoiceAgentRealtimeEvent, any, any>

Ärvd från Asynkerbar. [asynkerator]