VoiceAgentRealtimeClientConnectOptions interface

Pacote:

@azure/ai-projects

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

Extends

OperationOptions

Propriedades

abortSignal	Cancela a tentativa de ligaçã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 timeout da ligação do cliente em milissegundos.
onConnectionStateChange	Recebe transições de estado de ligação.
query	Parâmetros adicionais de consulta para o URL de atualização WebSocket desta ligação. Fornecer um objeto simples, incluindo um objeto protótipo nulo. Valores sobrepõem parâmetros undefined de consulta de endpoint; remove um parâmetro. Os valores são codificados automaticamente por URL. Os números têm de ser finitos. Os parâmetros geridos por SDK, parâmetros de autenticação e nomes que começam por h- são reservados (insensível 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: os parâmetros de consulta podem aparecer em registos do servidor ou proxy.
store	Sobrepõe-se à persistência da conversa criada por esta sessão.
structuredInputs	Valores usados para renderizar as entradas estruturadas de prompt do agente. Serializado quando connect() é chamado, antes da autenticação.
transport	Seleciona o transporte usado para a ligação em tempo real. O valor padrão é "websocket". Definido para "webrtc" negociar uma ligação peer WebRTC em vez disso; o chamador é responsável por completar a troca de oferta/resposta SDP usando os rtc.call.sdp.create eventos e rtc.call.sdp.created (ver VoiceAgentRealtimeEvent).

Propriedades Herdadas

onResponse	Uma função a ser chamada cada vez 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 de Propriedade

abortSignal

Cancela a tentativa de ligação.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

agentSessionId

Identificador usado para correlacionar a sessão de voz.

agentSessionId?: string

Valor de Propriedade

string

agentVersionOverride

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

agentVersionOverride?: string

Valor de Propriedade

string

connectionTimeoutInMs

Anula o timeout da ligação do cliente em milissegundos.

connectionTimeoutInMs?: number

Valor de Propriedade

number

onConnectionStateChange

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

onConnectionStateChange?: VoiceAgentConnectionStateChangedHandler

Valor de Propriedade

VoiceAgentConnectionStateChangedHandler

query

Parâmetros adicionais de consulta para o URL de atualização WebSocket desta ligação. Fornecer um objeto simples, incluindo um objeto protótipo nulo. Valores sobrepõem parâmetros undefined de consulta de endpoint; remove um parâmetro. Os valores são codificados automaticamente por URL. Os números têm de ser finitos. Os parâmetros geridos por SDK, parâmetros de autenticação e nomes que começam por h- são reservados (insensível 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: os parâmetros de consulta podem aparecer em registos do servidor ou proxy.

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

Valor de Propriedade

Readonly<Record<string, string | number | boolean | undefined>>

store

Sobrepõe-se à persistência da conversa criada por esta sessão.

store?: boolean

Valor de Propriedade

boolean

structuredInputs

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

structuredInputs?: Record<string, unknown>

Valor de Propriedade

Record<string, unknown>

transport

Seleciona o transporte usado para a ligação em tempo real. O valor padrão é "websocket". Definido para "webrtc" negociar uma ligação peer WebRTC em vez disso; o chamador é responsável por completar a troca de oferta/resposta SDP usando os rtc.call.sdp.create eventos e rtc.call.sdp.created (ver VoiceAgentRealtimeEvent).

transport?: VoiceAgentTransport

Valor de Propriedade

VoiceAgentTransport

Detalhes da Propriedade Herdada

onResponse

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

onResponse?: RawResponseCallback

Valor de Propriedade

RawResponseCallback

herdado de OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Valor de Propriedade

OperationRequestOptions

herdado de OperationOptions.requestOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

herdado de OperationOptions.tracingOptions