Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace RealtimeParameters

Parameters to be sent to the realtime speech service over a websocket connection.

Enumerations

Properties

Functions

Properties

Optional customizations

customizations: Array<CustomizationInference>

Array of customization objects.

Optional encoding

encoding: undefined | string

Audio encoding to use

  • audio/raw;rate=16000
  • audio/raw;rate=8000
  • audio/raw;rate=8000;codec=mulaw
  • audio/raw;rate=8000;codec=alaw

Optional finalSilenceThresholdInMs

finalSilenceThresholdInMs: undefined | number

Silence threshold for Realtime Speech final results in milliseconds. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional isAckEnabled

isAckEnabled: undefined | false | true

Toggle for ack messages.

Optional languageCode

languageCode: undefined | string

Locale value as per given in [https://datatracker.ietf.org/doc/html/rfc5646].

  • en-US: English - United States
  • es-ES: Spanish - Spain
  • pt-BR: Portuguese - Brazil
  • en-GB: English - Great Britain
  • en-AU: English - Australia
  • en-IN: English - India
  • hi-IN: Hindi - India
  • fr-FR: French - France
  • de-DE: German - Germany
  • it-IT: Italian - Italy

Optional modelDomain

modelDomain: ModelDomain

Model Domain.

Optional partialSilenceThresholdInMs

partialSilenceThresholdInMs: undefined | number

Silence threshold for Realtime Speech partial results in milliseconds. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional shouldIgnoreInvalidCustomizations

shouldIgnoreInvalidCustomizations: undefined | false | true

If set to true, the service will not fail connection attempt if it encounters any issues that prevent the loading of all specified user customizations. Any invalid customizations will simply be ignored and connection will continue being established with the default base model and any remaining valid customizations. If set to false, if the service is unable to load any of the specified customizations, an error detailing why will be returned and the session will end.

Optional stabilizePartialResults

stabilizePartialResults: StabilizePartialResults

When enabled sets the amount of confidence required for latest tokens before returning them as part of a new partial result

Functions

getDeserializedJsonObj

getJsonObj