VoiceAgentRealtimeClientOptions interface

Opções para o cliente em tempo real Voice Agents.

Propriedades

apiVersion

Versão da API enviada durante a atualização do WebSocket.

connectionTimeoutInMs

Tempo padrão de conexão em milissegundos.

credentialScopes

Escopos Microsoft Entra usados para adquirir um token de acesso WebSocket.

userAgentPrefix

Prefixo adicionado ao valor do user-agent do SDK em Node.js.

webSocketFactory

Sobrescreve o transporte usado para estabelecer a conexão WebSocket em tempo real. O padrão é o transporte da plataforma (ws em Node.js, o navegador nativo WebSocket nos navegadores/React Native). Fornecer uma fábrica personalizada para personalizar o estabelecimento da conexão.

Detalhes da propriedade

apiVersion

Versão da API enviada durante a atualização do WebSocket.

apiVersion?: string

Valor da propriedade

string

connectionTimeoutInMs

Tempo padrão de conexão em milissegundos.

connectionTimeoutInMs?: number

Valor da propriedade

number

credentialScopes

Escopos Microsoft Entra usados para adquirir um token de acesso WebSocket.

credentialScopes?: string | string[]

Valor da propriedade

string | string[]

userAgentPrefix

Prefixo adicionado ao valor do user-agent do SDK em Node.js.

userAgentPrefix?: string

Valor da propriedade

string

webSocketFactory

Sobrescreve o transporte usado para estabelecer a conexão WebSocket em tempo real. O padrão é o transporte da plataforma (ws em Node.js, o navegador nativo WebSocket nos navegadores/React Native). Fornecer uma fábrica personalizada para personalizar o estabelecimento da conexão.

webSocketFactory?: VoiceAgentWebSocketFactory

Valor da propriedade