VoiceAgentRealtimeClientConnectOptions interface

Pacote:

@azure/ai-projects

Opções para conectar o cliente em tempo real a um agente de voz.

Extends

OperationOptions

Propriedades

abortSignal	Cancela a tentativa de conexão.
agentSessionId	Identificador usado para correlacionar a sessão de voz.
agentVersionOverride	Seleciona uma versão específica do agente imutável.
connectionTimeoutInMs	Anula o tempo limite da conexão do cliente em milissegundos.
onConnectionStateChange	Recebe transições de estado de conexão.
store	Anula se a conversa criada por esta sessão foi mantida.
structuredInputs	Valores usados para renderizar as entradas estruturadas de prompt do agente.

Propriedades herdadas

onResponse	Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.
requestOptions	Opções usadas ao criar e enviar solicitações HTTP para esta operação.
tracingOptions	Opções usadas quando o rastreamento está habilitado.

Detalhes da propriedade

abortSignal

Cancela a tentativa de conexão.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

agentSessionId

Identificador usado para correlacionar a sessão de voz.

agentSessionId?: string

Valor da propriedade

string

agentVersionOverride

Seleciona uma versão específica do agente imutável.

agentVersionOverride?: string

Valor da propriedade

string

connectionTimeoutInMs

Anula o tempo limite da conexão do cliente em milissegundos.

connectionTimeoutInMs?: number

Valor da propriedade

number

onConnectionStateChange

Recebe transições de estado de conexão.

onConnectionStateChange?: VoiceAgentConnectionStateChangedHandler

Valor da propriedade

VoiceAgentConnectionStateChangedHandler

store

Anula se a conversa criada por esta sessão foi mantida.

store?: boolean

Valor da propriedade

boolean

structuredInputs

Valores usados para renderizar as entradas estruturadas de prompt do agente.

structuredInputs?: Record<string, unknown>

Valor da propriedade

Record<string, unknown>

Detalhes das propriedades herdadas

onResponse

Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor da propriedade

RawResponseCallback

herdado de OperationOptions.onResponse

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor da propriedade

OperationRequestOptions

Herdado de OperationOptions.requestOptions

tracingOptions

Opções usadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor da propriedade

OperationTracingOptions

herdado de OperationOptions.tracingOptions