Class RealtimeParameters

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

Inheritance
object
RealtimeParameters
Inherited Members
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.

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.

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

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

ModelDomain

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

Model Domain.

PartialSilenceThresholdInMs

Declaration
[JsonProperty(PropertyName = "partialSilenceThresholdInMs")]
public int? PartialSilenceThresholdInMs { get; set; }
Property Value
Type Description
int?

Silence threshold for Realtime Speech partial results in milliseconds.

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

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.

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