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("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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<UtteranceEvent.Builder,UtteranceEvent>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from interface: ToCopyableBuilder
      A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.
      Specified by:
      copy in interface ToCopyableBuilder<UtteranceEvent.Builder,UtteranceEvent>
      Parameters:
      modifier - A function that mutates this immutable object using the provided builder.
      Returns:
      A new copy of this object with the requested modifications.

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.

    • 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.