VoiceAgentConnection interface

Pacote:

@azure/ai-projects

Um fluxo de agente de voz bidirecional conectado.

Suporta exatamente uma for await iteração sobre eventos do servidor; uma segunda tentativa lança. Sair do loop antes do tempo (break, return, ou um erro não detectado no corpo do loop) fecha a conexão como efeito colateral. Tipos de eventos de servidor não reconhecidos são entregues como VoiceAgentUnknownEvent sem interromper a transmissão. Eventos malformados ainda falham na iteração com um erro de protocolo.

Extends

AsyncIterable<VoiceAgentRealtimeEvent>

Propriedades

closed	Resolve quando a conexão é fechada.
state	Estado atual da conexão.

Métodos

cancelResponse(VoiceAgentCancelResponseOptions)	Cancela uma resposta em andamento.
clearInputAudio(VoiceAgentEventOptions)	Limpa o áudio de entrada em buffer.
clearOutputAudio(VoiceAgentEventOptions)	Limpa o áudio de saída pendente no serviço.
close(number, string)	Fecha a conexão WebSocket com elegância.
commitAudio(VoiceAgentEventOptions)	Faz commit de áudio de entrada em buffer.
configureSession(VoiceAgentSessionUpdateConfig, VoiceAgentSessionUpdateOptions)	Atualizações suportavam configurações de sessões ao vivo.
dispose()	Libera a conexão. Equivalente a fechar().
requestResponse(VoiceAgentResponseOptions)	Solicita 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 usuário e, por padrão, solicita uma resposta.
sendToolOutput(string, string, VoiceAgentSendToolOutputOptions)	Retorna um resultado de função executada pelo cliente ao agente.

Métodos herdados

[asyncIterator]()

Detalhes da propriedade

closed

Resolve quando a conexão é fechada.

closed: Promise<VoiceAgentCloseResult>

Valor da propriedade

Promise<VoiceAgentCloseResult>

state

Estado atual da conexão.

state: VoiceAgentConnectionState

Valor da propriedade

VoiceAgentConnectionState

Detalhes do método

cancelResponse(VoiceAgentCancelResponseOptions)

Cancela uma resposta em andamento.

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

Parâmetros

options

VoiceAgentCancelResponseOptions

Retornos

Promise<void>

clearInputAudio(VoiceAgentEventOptions)

Limpa o áudio de entrada em buffer.

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

Parâmetros

options

VoiceAgentEventOptions

Retornos

Promise<void>

clearOutputAudio(VoiceAgentEventOptions)

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

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

Parâmetros

options

VoiceAgentEventOptions

Retornos

Promise<void>

close(number, string)

Fecha a conexão WebSocket com elegância.

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

Parâmetros

code

number

reason

string

Retornos

Promise<void>

commitAudio(VoiceAgentEventOptions)

Faz commit de áudio de entrada em buffer.

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

Parâmetros

options

VoiceAgentEventOptions

Retornos

Promise<void>

configureSession(VoiceAgentSessionUpdateConfig, VoiceAgentSessionUpdateOptions)

Atualizações suportavam configurações de sessões ao vivo.

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

Parâmetros

session

VoiceAgentSessionUpdateConfig

options

VoiceAgentSessionUpdateOptions

Retornos

Promise<void>

dispose()

Libera a conexão. Equivalente a fechar().

function dispose(): Promise<void>

Retornos

Promise<void>

requestResponse(VoiceAgentResponseOptions)

Solicita uma nova resposta.

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

Parâmetros

options

VoiceAgentResponseOptions

Retornos

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

Retornos

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

Retornos

Promise<void>

sendText(string, VoiceAgentSendTextOptions)

Adiciona um item de texto do usuário e, por padrão, solicita uma resposta.

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

Parâmetros

text

string

options

VoiceAgentSendTextOptions

Retornos

Promise<void>

sendToolOutput(string, string, VoiceAgentSendToolOutputOptions)

Retorna um resultado de função executada pelo cliente ao agente.

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

Parâmetros

callId

string

output

string

options

VoiceAgentSendToolOutputOptions

Retornos

Promise<void>

Detalhes do método herdado

[asyncIterator]()

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

Retornos

AsyncIterator<VoiceAgentRealtimeEvent, any, any>

Herdado de Assíncrono. [assíncrono]