VoiceAgentRealtimeClientConnectOptions interface

Paket:

@azure/ai-projects

Alternativ för att koppla realtidsklienten till en röstagent.

Extends

OperationOptions

Egenskaper

abortSignal	Avbryter anslutningsförsöket.
agentSessionId	Identifierare som används för att korrelera röstsessionen.
agentVersionOverride	Väljer en specifik version av oföränderlig agent.
connectionTimeoutInMs	Överskrider klientanslutningens timeout på millisekunder.
onConnectionStateChange	Tar emot anslutnings-tillståndsövergångar.
query	Ytterligare frågeparametrar för denna anslutnings WebSocket-uppgraderings-URL. Tillhandahåll ett vanligt objekt, inklusive ett null-prototypobjekt. Värden åsidosätter matchande endpoint-frågeparametrar; undefined tar bort en parameter. Värden kodas automatiskt via URL:er. Antalet måste vara ändligt. SDK-hanterade parametrar, autentiseringsparametrar och namn som börjar med h- är reserverade (kasuskänsligt) och orsakar en TypeError. Använd istället motsvarande typade alternativ för session, version, lagring, transport och strukturerade promptinmatningar. Båda structured_input och structured_inputs är reserverade. Inkludera inte hemligheter: frågeparametrar kan förekomma i server- eller proxyloggar.
store	Åsidosätter om samtalet som skapats av denna session fortsätter.
structuredInputs	Värden som används för att rendera agentens strukturerade promptinmatningar. Serialiserat när connect() anropas, före autentisering.
transport	Väljer transporten som används för realtidsanslutningen. Standardinställningen är "websocket". Ställ in till "webrtc" för att förhandla en WebRTC-peer-anslutning istället; uppringaren ansvarar för att slutföra SDP-erbjudande/svar-utbytet med hjälp av och rtc.call.sdp.created händelser rtc.call.sdp.create (se VoiceAgentRealtimeEvent).

Ärvda egenskaper

onResponse	En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.
requestOptions	Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.
tracingOptions	Alternativ som används när spårning är aktiverat.

Egenskapsinformation

abortSignal

Avbryter anslutningsförsöket.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

agentSessionId

Identifierare som används för att korrelera röstsessionen.

agentSessionId?: string

Egenskapsvärde

string

agentVersionOverride

Väljer en specifik version av oföränderlig agent.

agentVersionOverride?: string

Egenskapsvärde

string

connectionTimeoutInMs

Överskrider klientanslutningens timeout på millisekunder.

connectionTimeoutInMs?: number

Egenskapsvärde

number

onConnectionStateChange

Tar emot anslutnings-tillståndsövergångar.

onConnectionStateChange?: VoiceAgentConnectionStateChangedHandler

Egenskapsvärde

VoiceAgentConnectionStateChangedHandler

query

Ytterligare frågeparametrar för denna anslutnings WebSocket-uppgraderings-URL. Tillhandahåll ett vanligt objekt, inklusive ett null-prototypobjekt. Värden åsidosätter matchande endpoint-frågeparametrar; undefined tar bort en parameter. Värden kodas automatiskt via URL:er. Antalet måste vara ändligt. SDK-hanterade parametrar, autentiseringsparametrar och namn som börjar med h- är reserverade (kasuskänsligt) och orsakar en TypeError. Använd istället motsvarande typade alternativ för session, version, lagring, transport och strukturerade promptinmatningar. Båda structured_input och structured_inputs är reserverade. Inkludera inte hemligheter: frågeparametrar kan förekomma i server- eller proxyloggar.

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

Egenskapsvärde

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

store

Åsidosätter om samtalet som skapats av denna session fortsätter.

store?: boolean

Egenskapsvärde

boolean

structuredInputs

Värden som används för att rendera agentens strukturerade promptinmatningar. Serialiserat när connect() anropas, före autentisering.

structuredInputs?: Record<string, unknown>

Egenskapsvärde

Record<string, unknown>

transport

Väljer transporten som används för realtidsanslutningen. Standardinställningen är "websocket". Ställ in till "webrtc" för att förhandla en WebRTC-peer-anslutning istället; uppringaren ansvarar för att slutföra SDP-erbjudande/svar-utbytet med hjälp av och rtc.call.sdp.created händelser rtc.call.sdp.create (se VoiceAgentRealtimeEvent).

transport?: VoiceAgentTransport

Egenskapsvärde

VoiceAgentTransport

Information om ärvda egenskaper

onResponse

En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.

onResponse?: RawResponseCallback

Egenskapsvärde

RawResponseCallback

ärvd från OperationOptions.onResponse

requestOptions

Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.

requestOptions?: OperationRequestOptions

Egenskapsvärde

OperationRequestOptions

ärvd från OperationOptions.requestOptions

tracingOptions

Alternativ som används när spårning är aktiverat.

tracingOptions?: OperationTracingOptions

Egenskapsvärde

OperationTracingOptions

ärvd från OperationOptions.tracingOptions