Class RealtimeParameters

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

Inheritance

object

RealtimeParameters

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.AispeechService.Models

Assembly: OCI.DotNetSDK.Aispeech.dll

Syntax

public class RealtimeParameters

Properties

Customizations

Declaration

[JsonProperty(PropertyName = "customizations")]
public List<CustomizationInference> Customizations { get; set; }

Property Value

Type	Description
List<CustomizationInference>	Array of customization objects. Currently supported only for Oracle model.

Encoding

Declaration

[JsonProperty(PropertyName = "encoding")]
public string Encoding { get; set; }

Property Value

Type	Description
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

FinalSilenceThresholdInMs

Declaration

[JsonProperty(PropertyName = "finalSilenceThresholdInMs")]
public int? FinalSilenceThresholdInMs { get; set; }

Property Value

Type	Description
int?	Silence threshold for Realtime Speech final results in milliseconds. Currently supported only for Oracle model.

IsAckEnabled

Declaration

[JsonProperty(PropertyName = "isAckEnabled")]
public bool? IsAckEnabled { get; set; }

Property Value

Type	Description
bool?	Toggle for ack messages.

LanguageCode

Declaration

[JsonProperty(PropertyName = "languageCode")]
public string LanguageCode { get; set; }

Property Value

Type

Description

string

Oracle model supported language codes are locale specific. Locale value as per given in [https://datatracker.ietf.org/doc/html/rfc5646] en-US: English - United States (default) 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 Whisper model supported language codes are locale agnostic auto: Auto-detect language af: Afrikaans am: Amharic ar: Arabic as: Assamese az: Azerbaijani ba: Bashkir be: Belarusian bg: Bulgarian bn: Bengali bo: Tibetan br: Breton bs: Bosnian ca: Catalan cs: Czech cy: Welsh da: Danish de: German el: Greek en: English (default) es: Spanish et: Estonian eu: Basque fa: Persian fi: Finnish fo: Faroese fr: French gl: Galician gu: Gujarati ha: Hausa haw: Hawaiian he: Hebrew hi: Hindi hr: Croatian ht: Haitian Creole hu: Hungarian hy: Armenian id: Indonesian is: Icelandic it: Italian ja: Japanese jv: Javanese ka: Georgian kk: Kazakh km: Khmer kn: Kannada ko: Korean la: Latin lb: Luxembourgish ln: Lingala lo: Lao lt: Lithuanian lv: Latvian mg: Malagasy mi: Maori mk: Macedonian ml: Malayalam mn: Mongolian mr: Marathi ms: Malay mt: Maltese my: Burmese ne: Nepali nl: Dutch nn: Norwegian Nynorsk no: Norwegian oc: Occitan pa: Punjabi pl: Polish ps: Pashto pt: Portuguese ro: Romanian ru: Russian sa: Sanskrit sd: Sindhi si: Sinhala sk: Slovak sl: Slovenian sn: Shona so: Somali sq: Albanian sr: Serbian su: Sundanese sv: Swedish sw: Swahili ta: Tamil te: Telugu tg: Tajik th: Thai tk: Turkmen tl: Tagalog tr: Turkish tt: Tatar uk: Ukrainian ur: Urdu uz: Uzbek vi: Vietnamese yi: Yiddish yo: Yoruba zh: Chinese

ModelDomain

Declaration

[JsonProperty(PropertyName = "modelDomain")]
[JsonConverter(typeof(StringEnumConverter))]
public RealtimeParameters.ModelDomainEnum? ModelDomain { get; set; }

Property Value

Type	Description
RealtimeParameters.ModelDomainEnum?	Model Domain.

ModelType

Declaration

[JsonProperty(PropertyName = "modelType")]
public string ModelType { get; set; }

Property Value

Type	Description
string	Select a model to use for generating transcriptions. Currently supported models are: ORACLE WHISPER

PartialSilenceThresholdInMs

Declaration

[JsonProperty(PropertyName = "partialSilenceThresholdInMs")]
public int? PartialSilenceThresholdInMs { get; set; }

Property Value

Type	Description
int?	Silence threshold for Realtime Speech partial results in milliseconds. Currently supported only for Oracle model.

Punctuation

Declaration

[JsonProperty(PropertyName = "punctuation")]
[JsonConverter(typeof(StringEnumConverter))]
public RealtimeParameters.PunctuationEnum? Punctuation { get; set; }

Property Value

Type	Description
RealtimeParameters.PunctuationEnum?	Configure punctuations in the generated transcriptions. Disabled by default. NONE: No punctuation in the transcription response SPOKEN: Punctuations in response only when verbally spoken AUTO: Automatic punctuation in the response, spoken punctuations are disabled Spoken punctuation is currently supported only for the Oracle model in the Medical domain.

ShouldIgnoreInvalidCustomizations

Declaration

[JsonProperty(PropertyName = "shouldIgnoreInvalidCustomizations")]
public bool? ShouldIgnoreInvalidCustomizations { get; set; }

Property Value

Type

Description

bool?

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. Currently supported only for Oracle model.

StabilizePartialResults

Declaration

[JsonProperty(PropertyName = "stabilizePartialResults")]
[JsonConverter(typeof(StringEnumConverter))]
public RealtimeParameters.StabilizePartialResultsEnum? StabilizePartialResults { get; set; }

Property Value

Type	Description
RealtimeParameters.StabilizePartialResultsEnum?	When enabled sets the amount of confidence required for latest tokens before returning them as part of a new partial result Currently supported only for Oracle model.