Package software.amazon.awssdk.services.transcribestreaming.model

Class Item

java.lang.Object

software.amazon.awssdk.services.transcribestreaming.model.Item

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Item.Builder,Item>

@Generated("software.amazon.awssdk:codegen")
public final class Item
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Item.Builder,Item>

A word, phrase, or punctuation mark in your transcription output, along with various associated attributes, such as confidence score, type, and start and end times.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Item.Builder

Method Summary

Modifier and Type	Method	Description
static Item.Builder	builder()
Double	confidence()	The confidence score associated with a word or phrase in your transcript.
String	content()	The word or punctuation that was transcribed.
Double	endTime()	The end time of the transcribed item in seconds, with millisecond precision (e.g., 1.056)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Item.Builder>	serializableBuilderClass()
String	speaker()	If speaker partitioning is enabled, Speaker labels the speaker of the specified item.
Boolean	stable()	If partial result stabilization is enabled, Stable indicates whether the specified item is stable ( true) or if it may change when the segment is complete (false).
Double	startTime()	The start time of the transcribed item in seconds, with millisecond precision (e.g., 1.056)
Item.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ItemType	type()	The type of item identified.
String	typeAsString()	The type of item identified.
Boolean	vocabularyFilterMatch()	Indicates whether the specified item matches a word in the vocabulary filter included in your request.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

startTime

public final Double startTime()

The start time of the transcribed item in seconds, with millisecond precision (e.g., 1.056)

Returns:

The start time of the transcribed item in seconds, with millisecond precision (e.g., 1.056)

endTime

public final Double endTime()

The end time of the transcribed item in seconds, with millisecond precision (e.g., 1.056)

Returns:

The end time of the transcribed item in seconds, with millisecond precision (e.g., 1.056)

type

public final ItemType type()

The type of item identified. Options are: PRONUNCIATION (spoken words) and PUNCTUATION.

If the service returns an enum value that is not available in the current SDK version, type will return ItemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of item identified. Options are: PRONUNCIATION (spoken words) and PUNCTUATION.

See Also:

ItemType

typeAsString

public final String typeAsString()

The type of item identified. Options are: PRONUNCIATION (spoken words) and PUNCTUATION.

If the service returns an enum value that is not available in the current SDK version, type will return ItemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of item identified. Options are: PRONUNCIATION (spoken words) and PUNCTUATION.

See Also:

ItemType

content

public final String content()

The word or punctuation that was transcribed.

Returns:

The word or punctuation that was transcribed.

vocabularyFilterMatch

public final Boolean vocabularyFilterMatch()

Indicates whether the specified item matches a word in the vocabulary filter included in your request. If true, there is a vocabulary filter match.

Returns:

Indicates whether the specified item matches a word in the vocabulary filter included in your request. If true, there is a vocabulary filter match.

speaker

public final String speaker()

If speaker partitioning is enabled, Speaker labels the speaker of the specified item.

Returns:

If speaker partitioning is enabled, Speaker labels the speaker of the specified item.

confidence

public final Double confidence()

The confidence score associated with a word or phrase in your transcript.

Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified item correctly matches the item spoken in your media.

Returns:

The confidence score associated with a word or phrase in your transcript.

Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified item correctly matches the item spoken in your media.

stable

public final Boolean stable()

If partial result stabilization is enabled, Stable indicates whether the specified item is stable ( true) or if it may change when the segment is complete (false).

Returns:

If partial result stabilization is enabled, Stable indicates whether the specified item is stable (true) or if it may change when the segment is complete (false).

toBuilder

public Item.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Item.Builder,Item>

builder

public static Item.Builder builder()

serializableBuilderClass

public static Class<? extends Item.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo