VoiceAgentConnection interface

Pacote:

@azure/ai-projects

Um fluxo de agente de voz bidirecional e interligado.

Suporta exatamente uma for await iteração sobre eventos do servidor; uma segunda tentativa lança. Sair do loop cedo (break, return, ou um erro não detetado no corpo do loop) fecha a ligação como efeito secundário. Tipos de eventos de servidor não reconhecidos são entregues como VoiceAgentUnknownEvent sem interromper o fluxo. Eventos malformados continuam a falhar na iteração devido a um erro de protocolo.

Extends

AsyncIterable<VoiceAgentRealtimeEvent>

Propriedades

closed	Resolve-se assim que a ligação é fechada.
state	Estado atual da ligação.

Métodos

cancelResponse(VoiceAgentCancelResponseOptions)	Cancela uma resposta em curso.
clearInputAudio(VoiceAgentEventOptions)	Limpa o áudio de entrada em buffer.
clearOutputAudio(VoiceAgentEventOptions)	Apaga o áudio de saída pendente no serviço.
close(number, string)	Fecha a ligação WebSocket com elegância.
commitAudio(VoiceAgentEventOptions)	Faz commits de áudio de entrada em buffer.
configureSession(VoiceAgentSessionUpdateConfig, VoiceAgentSessionUpdateOptions)	As atualizações suportavam as definições de sessões ao vivo.
dispose()	Liberta a ligação. Equivalente a fechar().
requestResponse(VoiceAgentResponseOptions)	Pede uma nova resposta.
sendAudio(ArrayBuffer | Uint8Array, VoiceAgentEventOptions)	Adiciona bytes de áudio codificados em base 64 ao buffer de entrada.
sendEvent(VoiceAgentClientEvent, VoiceAgentSendOptions)	Envia qualquer evento de protocolo cliente gerado.
sendText(string, VoiceAgentSendTextOptions)	Adiciona um item de texto do utilizador e, por defeito, solicita uma resposta.
sendToolOutput(string, string, VoiceAgentSendToolOutputOptions)	Devolve um resultado de função executado pelo cliente ao agente.

Métodos Herdados

[asyncIterator]()

Detalhes de Propriedade

closed

Resolve-se assim que a ligação é fechada.

closed: Promise<VoiceAgentCloseResult>

Valor de Propriedade

Promise<VoiceAgentCloseResult>

state

Estado atual da ligação.

state: VoiceAgentConnectionState

Valor de Propriedade

VoiceAgentConnectionState

Detalhes de Método

cancelResponse(VoiceAgentCancelResponseOptions)

Cancela uma resposta em curso.

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

Parâmetros

options

VoiceAgentCancelResponseOptions

Devoluções

Promise<void>

clearInputAudio(VoiceAgentEventOptions)

Limpa o áudio de entrada em buffer.

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

Parâmetros

options

VoiceAgentEventOptions

Devoluções

Promise<void>

clearOutputAudio(VoiceAgentEventOptions)

Apaga o áudio de saída pendente no serviço.

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

Parâmetros

options

VoiceAgentEventOptions

Devoluções

Promise<void>

close(number, string)

Fecha a ligação WebSocket com elegância.

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

Parâmetros

code

number

reason

string

Devoluções

Promise<void>

commitAudio(VoiceAgentEventOptions)

Faz commits de áudio de entrada em buffer.

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

Parâmetros

options

VoiceAgentEventOptions

Devoluções

Promise<void>

configureSession(VoiceAgentSessionUpdateConfig, VoiceAgentSessionUpdateOptions)

As atualizações suportavam as definições de sessões ao vivo.

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

Parâmetros

session

VoiceAgentSessionUpdateConfig

options

VoiceAgentSessionUpdateOptions

Devoluções

Promise<void>

dispose()

Liberta a ligação. Equivalente a fechar().

function dispose(): Promise<void>

Devoluções

Promise<void>

requestResponse(VoiceAgentResponseOptions)

Pede uma nova resposta.

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

Parâmetros

options

VoiceAgentResponseOptions

Devoluções

Promise<void>

sendAudio(ArrayBuffer | Uint8Array, VoiceAgentEventOptions)

Adiciona bytes de áudio codificados em base 64 ao buffer de entrada.

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

Parâmetros

audio

ArrayBuffer | Uint8Array

options

VoiceAgentEventOptions

Devoluções

Promise<void>

sendEvent(VoiceAgentClientEvent, VoiceAgentSendOptions)

Envia qualquer evento de protocolo cliente gerado.

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

Parâmetros

event

VoiceAgentClientEvent

options

VoiceAgentSendOptions

Devoluções

Promise<void>

sendText(string, VoiceAgentSendTextOptions)

Adiciona um item de texto do utilizador e, por defeito, solicita uma resposta.

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

Parâmetros

text

string

options

VoiceAgentSendTextOptions

Devoluções

Promise<void>

sendToolOutput(string, string, VoiceAgentSendToolOutputOptions)

Devolve um resultado de função executado pelo cliente ao agente.

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

Parâmetros

callId

string

output

string

options

VoiceAgentSendToolOutputOptions

Devoluções

Promise<void>

Detalhes do Método Herdado

[asyncIterator]()

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

Devoluções

AsyncIterator<VoiceAgentRealtimeEvent, any, any>

Herdado de Assíncrono. [assíncrono]