Package com.oracle.bmc.aispeech.model
Class RealtimeParameters
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.aispeech.model.RealtimeParameters
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20220101") public final class RealtimeParameters extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Parameters to be sent to the realtime speech service over a websocket connection.
Note: Objects should always be created or deserialized using theRealtimeParameters.Builder
. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of theRealtimeParameters.Builder
, which maintain a set of all explicitly set fields calledRealtimeParameters.Builder.__explicitlySet__
. ThehashCode()
andequals(Object)
methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RealtimeParameters.Builder
static class
RealtimeParameters.ModelDomain
Model Domain.static class
RealtimeParameters.Punctuation
Configure punctuations in the generated transcriptions.static class
RealtimeParameters.StabilizePartialResults
When enabled sets the amount of confidence required for latest tokens before returning them as part of a new partial result
-
Constructor Summary
Constructors Constructor Description RealtimeParameters(String encoding, Boolean isAckEnabled, Integer partialSilenceThresholdInMs, Integer finalSilenceThresholdInMs, RealtimeParameters.StabilizePartialResults stabilizePartialResults, RealtimeParameters.ModelDomain modelDomain, String languageCode, Boolean shouldIgnoreInvalidCustomizations, List<CustomizationInference> customizations, RealtimeParameters.Punctuation punctuation)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RealtimeParameters.Builder
builder()
Create a new builder.boolean
equals(Object o)
List<CustomizationInference>
getCustomizations()
Array of customization objects.String
getEncoding()
Audio encoding to use - audio/raw;rate=16000 - audio/raw;rate=8000 - audio/raw;rate=8000;codec=mulaw - audio/raw;rate=8000;codec=alawInteger
getFinalSilenceThresholdInMs()
Silence threshold for Realtime Speech final results in milliseconds.Boolean
getIsAckEnabled()
Toggle for ack messages.String
getLanguageCode()
Locale value as per given in [https://datatracker.ietf.org/doc/html/rfc5646].RealtimeParameters.ModelDomain
getModelDomain()
Model Domain.Integer
getPartialSilenceThresholdInMs()
Silence threshold for Realtime Speech partial results in milliseconds.RealtimeParameters.Punctuation
getPunctuation()
Configure punctuations in the generated transcriptions.Boolean
getShouldIgnoreInvalidCustomizations()
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.RealtimeParameters.StabilizePartialResults
getStabilizePartialResults()
When enabled sets the amount of confidence required for latest tokens before returning them as part of a new partial resultint
hashCode()
RealtimeParameters.Builder
toBuilder()
String
toString()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
RealtimeParameters
@Deprecated @ConstructorProperties({"encoding","isAckEnabled","partialSilenceThresholdInMs","finalSilenceThresholdInMs","stabilizePartialResults","modelDomain","languageCode","shouldIgnoreInvalidCustomizations","customizations","punctuation"}) public RealtimeParameters(String encoding, Boolean isAckEnabled, Integer partialSilenceThresholdInMs, Integer finalSilenceThresholdInMs, RealtimeParameters.StabilizePartialResults stabilizePartialResults, RealtimeParameters.ModelDomain modelDomain, String languageCode, Boolean shouldIgnoreInvalidCustomizations, List<CustomizationInference> customizations, RealtimeParameters.Punctuation punctuation)
Deprecated.
-
-
Method Detail
-
builder
public static RealtimeParameters.Builder builder()
Create a new builder.
-
toBuilder
public RealtimeParameters.Builder toBuilder()
-
getEncoding
public String getEncoding()
Audio encoding to use - audio/raw;rate=16000 - audio/raw;rate=8000 - audio/raw;rate=8000;codec=mulaw - audio/raw;rate=8000;codec=alaw- Returns:
- the value
-
getIsAckEnabled
public Boolean getIsAckEnabled()
Toggle for ack messages.- Returns:
- the value
-
getPartialSilenceThresholdInMs
public Integer getPartialSilenceThresholdInMs()
Silence threshold for Realtime Speech partial results in milliseconds.- Returns:
- the value
-
getFinalSilenceThresholdInMs
public Integer getFinalSilenceThresholdInMs()
Silence threshold for Realtime Speech final results in milliseconds.- Returns:
- the value
-
getStabilizePartialResults
public RealtimeParameters.StabilizePartialResults getStabilizePartialResults()
When enabled sets the amount of confidence required for latest tokens before returning them as part of a new partial result- Returns:
- the value
-
getModelDomain
public RealtimeParameters.ModelDomain getModelDomain()
Model Domain.- Returns:
- the value
-
getLanguageCode
public String getLanguageCode()
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
- Returns:
- the value
-
getShouldIgnoreInvalidCustomizations
public Boolean getShouldIgnoreInvalidCustomizations()
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.
- Returns:
- the value
-
getCustomizations
public List<CustomizationInference> getCustomizations()
Array of customization objects.- Returns:
- the value
-
getPunctuation
public RealtimeParameters.Punctuation getPunctuation()
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
- Returns:
- the value
-
toString
public String toString()
- Overrides:
toString
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
toString
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.- Parameters:
includeByteArrayContents
- true to include the full contents of byte arrays- Returns:
- string representation
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-