VoiceAgentRealtimeClientConnectOptions interface

Cancela a tentativa de conexão.

abortSignal?: AbortSignalLike

Valor da propriedade

Identificador usado para correlacionar a sessão de voz.

agentSessionId?: string

Valor da propriedade

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

agentVersionOverride?: string

Valor da propriedade

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

connectionTimeoutInMs?: number

Valor da propriedade

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

onConnectionStateChange?: VoiceAgentConnectionStateChangedHandler

Valor da propriedade

Parâmetros adicionais de consulta para a URL de atualização do WebSocket desta conexão. Forneça um objeto simples, incluindo um objeto protótipo nulo. Valores substituem parâmetros undefined de consulta de endpoint; remove um parâmetro. Os valores são codificados automaticamente por URL. Os números devem ser finitos. Parâmetros gerenciados por SDK, parâmetros de autenticação e nomes começando com h- são reservados (insensíveis a maiúsculas e minúsculas) e causam um TypeError. Use as opções digitadas correspondentes para entradas, versão, armazenamento, transporte e prompts estruturados. Ambos structured_input e structured_inputs são reservados. Não inclua segredos: parâmetros de consulta podem aparecer em logs de servidores ou proxy.

query?: Readonly<Record<string, string | number | boolean | undefined>>

Valor da propriedade

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

store?: boolean

Valor da propriedade

Valores usados para renderizar as entradas estruturadas de prompt do agente. Serializado quando connect() é chamado, antes da autenticação.

structuredInputs?: Record<string, unknown>

Valor da propriedade

Seleciona o transporte usado para a conexão em tempo real. Usa "websocket" como padrão. Configurado para "webrtc" negociar uma conexão entre pares WebRTC; o chamador é responsável por completar a troca de oferta/resposta SDP usando os rtc.call.sdp.create eventos e rtc.call.sdp.created (veja VoiceAgentRealtimeEvent).

transport?: VoiceAgentTransport

Valor da propriedade

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

herdado de OperationOptions.onResponse

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

requestOptions?: OperationRequestOptions

Valor da propriedade

Herdado de OperationOptions.requestOptions

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

tracingOptions?: OperationTracingOptions

Valor da propriedade

herdado de OperationOptions.tracingOptions