Class Result
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Result.Builder,
Result>
The Result
associated with a .
Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identification, partial result stabilization, language identification, and other transcription-related data.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<Alternative> A list of possible alternative transcriptions for the input audio.static Result.Builder
builder()
final String
Indicates which audio channel is associated with theResult
.final Double
endTime()
The end time, in milliseconds, of theResult
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Alternatives property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LanguageIdentification property.final Boolean
Indicates if the segment is complete.final LanguageCode
The language code that represents the language spoken in your audio stream.final String
The language code that represents the language spoken in your audio stream.final List
<LanguageWithScore> The language code of the dominant language identified in your stream.final String
resultId()
Provides a unique identifier for theResult
.static Class
<? extends Result.Builder> final Double
The start time, in milliseconds, of theResult
.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
resultId
Provides a unique identifier for the
Result
.- Returns:
- Provides a unique identifier for the
Result
.
-
startTime
The start time, in milliseconds, of the
Result
.- Returns:
- The start time, in milliseconds, of the
Result
.
-
endTime
The end time, in milliseconds, of the
Result
.- Returns:
- The end time, in milliseconds, of the
Result
.
-
isPartial
Indicates if the segment is complete.
If
IsPartial
istrue
, the segment is not complete. IfIsPartial
isfalse
, the segment is complete.- Returns:
- Indicates if the segment is complete.
If
IsPartial
istrue
, the segment is not complete. IfIsPartial
isfalse
, the segment is complete.
-
hasAlternatives
public final boolean hasAlternatives()For responses, this returns true if the service returned a value for the Alternatives property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
alternatives
A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of
Items
,Entities
, orTranscript
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAlternatives()
method.- Returns:
- A list of possible alternative transcriptions for the input audio. Each alternative may contain one or
more of
Items
,Entities
, orTranscript
.
-
channelId
Indicates which audio channel is associated with the
Result
.- Returns:
- Indicates which audio channel is associated with the
Result
.
-
languageCode
The language code that represents the language spoken in your audio stream.
If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The language code that represents the language spoken in your audio stream.
- See Also:
-
languageCodeAsString
The language code that represents the language spoken in your audio stream.
If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The language code that represents the language spoken in your audio stream.
- See Also:
-
hasLanguageIdentification
public final boolean hasLanguageIdentification()For responses, this returns true if the service returned a value for the LanguageIdentification property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
languageIdentification
The language code of the dominant language identified in your stream.
If you enabled channel identification and each channel of your audio contains a different language, you may have more than one result.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasLanguageIdentification()
method.- Returns:
- The language code of the dominant language identified in your stream.
If you enabled channel identification and each channel of your audio contains a different language, you may have more than one result.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Result.Builder,
Result> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-