software.amazon.awssdk.services.transcribestreaming.model

Class UtteranceEvent

java.lang.Object

software.amazon.awssdk.services.transcribestreaming.model.UtteranceEvent

All Implemented Interfaces:

Serializable, SdkPojo, CallAnalyticsTranscriptResultStream, ToCopyableBuilder<UtteranceEvent.Builder,UtteranceEvent>

Direct Known Subclasses:

DefaultUtteranceEvent

@Generated(value="software.amazon.awssdk:codegen")
public class UtteranceEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UtteranceEvent.Builder,UtteranceEvent>, CallAnalyticsTranscriptResultStream

Contains set of transcription results from one or more audio segments, along with additional information about the parameters included in your request. For example, channel definitions, partial result stabilization, sentiment, and issue detection.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UtteranceEvent.Builder
protected static class	UtteranceEvent.BuilderImpl

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.transcribestreaming.model.CallAnalyticsTranscriptResultStream

CallAnalyticsTranscriptResultStream.EventType

Field Summary

Fields inherited from interface software.amazon.awssdk.services.transcribestreaming.model.CallAnalyticsTranscriptResultStream

UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UtteranceEvent(UtteranceEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method and Description
void	accept(StartCallAnalyticsStreamTranscriptionResponseHandler.Visitor visitor) Calls the appropriate visit method depending on the subtype of UtteranceEvent.
Long	beginOffsetMillis() The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent .
static UtteranceEvent.Builder	builder()
UtteranceEvent	copy(Consumer<? super UtteranceEvent.Builder> modifier)
Long	endOffsetMillis() The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent .
List<CallAnalyticsEntity>	entities() Contains entities identified as personally identifiable information (PII) in your transcription output.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEntities() For responses, this returns true if the service returned a value for the Entities property.
int	hashCode()
boolean	hasIssuesDetected() For responses, this returns true if the service returned a value for the IssuesDetected property.
boolean	hasItems() For responses, this returns true if the service returned a value for the Items property.
Boolean	isPartial() Indicates whether the segment in the UtteranceEvent is complete (FALSE) or partial ( TRUE).
List<IssueDetected>	issuesDetected() Provides the issue that was detected in the specified segment.
List<CallAnalyticsItem>	items() Contains words, phrases, or punctuation marks that are associated with the specified UtteranceEvent.
ParticipantRole	participantRole() Provides the role of the speaker for each audio channel, either CUSTOMER or AGENT.
String	participantRoleAsString() Provides the role of the speaker for each audio channel, either CUSTOMER or AGENT.
List<SdkField<?>>	sdkFields()
Sentiment	sentiment() Provides the sentiment that was detected in the specified segment.
String	sentimentAsString() Provides the sentiment that was detected in the specified segment.
static Class<? extends UtteranceEvent.Builder>	serializableBuilderClass()
UtteranceEvent.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	transcript() Contains transcribed text.
String	utteranceId() The unique identifier that is associated with the specified UtteranceEvent.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.services.transcribestreaming.model.CallAnalyticsTranscriptResultStream

categoryEventBuilder, sdkEventType, utteranceEventBuilder

Constructor Detail

UtteranceEvent

protected UtteranceEvent(UtteranceEvent.BuilderImpl builder)

Method Detail

utteranceId

public final String utteranceId()

The unique identifier that is associated with the specified UtteranceEvent.

Returns:

The unique identifier that is associated with the specified UtteranceEvent.

isPartial

public final Boolean isPartial()

Indicates whether the segment in the UtteranceEvent is complete (FALSE) or partial ( TRUE).

Returns:

Indicates whether the segment in the UtteranceEvent is complete (FALSE) or partial (TRUE).

participantRole

public final ParticipantRole participantRole()

Provides the role of the speaker for each audio channel, either CUSTOMER or AGENT.

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

Returns:

Provides the role of the speaker for each audio channel, either CUSTOMER or AGENT.

See Also:

ParticipantRole

participantRoleAsString

public final String participantRoleAsString()

Provides the role of the speaker for each audio channel, either CUSTOMER or AGENT.

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

Returns:

Provides the role of the speaker for each audio channel, either CUSTOMER or AGENT.

See Also:

ParticipantRole

beginOffsetMillis

public final Long beginOffsetMillis()

The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent .

Returns:

The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent.

endOffsetMillis

public final Long endOffsetMillis()

The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent .

Returns:

The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent.

transcript

public final String transcript()

Contains transcribed text.

Returns:

Contains transcribed text.

hasItems

public final boolean hasItems()

For responses, this returns true if the service returned a value for the Items property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

items

public final List<CallAnalyticsItem> items()

Contains words, phrases, or punctuation marks that are associated with the specified UtteranceEvent.

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 hasItems() method.

Returns:

Contains words, phrases, or punctuation marks that are associated with the specified UtteranceEvent.

hasEntities

public final boolean hasEntities()

For responses, this returns true if the service returned a value for the Entities property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

entities

public final List<CallAnalyticsEntity> entities()

Contains entities identified as personally identifiable information (PII) in your transcription output.

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 hasEntities() method.

Returns:

Contains entities identified as personally identifiable information (PII) in your transcription output.

sentiment

public final Sentiment sentiment()

Provides the sentiment that was detected in the specified segment.

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

Returns:

Provides the sentiment that was detected in the specified segment.

See Also:

Sentiment

sentimentAsString

public final String sentimentAsString()

Provides the sentiment that was detected in the specified segment.

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

Returns:

Provides the sentiment that was detected in the specified segment.

See Also:

Sentiment

hasIssuesDetected

public final boolean hasIssuesDetected()

For responses, this returns true if the service returned a value for the IssuesDetected property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

issuesDetected

public final List<IssueDetected> issuesDetected()

Provides the issue that was detected in the specified segment.

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 hasIssuesDetected() method.

Returns:

Provides the issue that was detected in the specified segment.

toBuilder

public UtteranceEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UtteranceEvent.Builder,UtteranceEvent>

builder

public static UtteranceEvent.Builder builder()

serializableBuilderClass

public static Class<? extends UtteranceEvent.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)

copy

public final UtteranceEvent copy(Consumer<? super UtteranceEvent.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<UtteranceEvent.Builder,UtteranceEvent>

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

accept

public void accept(StartCallAnalyticsStreamTranscriptionResponseHandler.Visitor visitor)

Calls the appropriate visit method depending on the subtype of UtteranceEvent.

Specified by:

accept in interface CallAnalyticsTranscriptResultStream

Parameters:

visitor - Visitor to invoke.