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

Class UtteranceEvent

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

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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