Class RealTimeContactAnalysisSegmentExtractedInformation

java.lang.Object
software.amazon.awssdk.services.connect.model.RealTimeContactAnalysisSegmentExtractedInformation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RealTimeContactAnalysisSegmentExtractedInformation.Builder,RealTimeContactAnalysisSegmentExtractedInformation>
@Generated("software.amazon.awssdk:codegen") public final class RealTimeContactAnalysisSegmentExtractedInformation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RealTimeContactAnalysisSegmentExtractedInformation.Builder,RealTimeContactAnalysisSegmentExtractedInformation>

Segment containing information extracted from the conversation. Each segment represents the results for a single extraction definition.

See Also:

  • Method Details

    • extractionDefinitionId

      public final String extractionDefinitionId()

      The identifier of the extraction definition that produced this result.

      Returns:
      The identifier of the extraction definition that produced this result.

    • extractionDefinitionName

      public final String extractionDefinitionName()

      The name of the extraction definition that produced this result.

      Returns:
      The name of the extraction definition that produced this result.

    • extractionDefinitionDisplayLabel

      public final String extractionDefinitionDisplayLabel()

      The display label of the extraction definition that produced this result.

      Returns:
      The display label of the extraction definition that produced this result.

    • hasExtractedValues

      public final boolean hasExtractedValues()
      For responses, this returns true if the service returned a value for the ExtractedValues 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.

    • extractedValues

      public final List<RealTimeContactAnalysisExtractedInformationValue> extractedValues()

      The list of values extracted from the conversation for this extraction definition. This field is empty when a FailureCode is present.

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

      Returns:
      The list of values extracted from the conversation for this extraction definition. This field is empty when a FailureCode is present.

    • failureCode

      public final RealTimeContactAnalysisExtractedInformationFailureCode failureCode()

      If the information failed to be extracted, one of the following failure codes occurs:

      • QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.

      • INSUFFICIENT_CONVERSATION_CONTENT: Information extraction requires a conversation with at least one turn from each participant.

      • FAILED_SAFETY_GUIDELINES: The extracted information cannot be provided because it failed to meet system safety guidelines.

      • INTERNAL_ERROR: Internal system error.

      • MAX_PACKAGE_FEATURE_ONLY: Information extraction is only available in Amazon Connect Customer instances.

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

      Returns:
      If the information failed to be extracted, one of the following failure codes occurs:

      • QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.

      • INSUFFICIENT_CONVERSATION_CONTENT: Information extraction requires a conversation with at least one turn from each participant.

      • FAILED_SAFETY_GUIDELINES: The extracted information cannot be provided because it failed to meet system safety guidelines.

      • INTERNAL_ERROR: Internal system error.

      • MAX_PACKAGE_FEATURE_ONLY: Information extraction is only available in Amazon Connect Customer instances.

      See Also:

    • failureCodeAsString

      public final String failureCodeAsString()

      If the information failed to be extracted, one of the following failure codes occurs:

      • QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.

      • INSUFFICIENT_CONVERSATION_CONTENT: Information extraction requires a conversation with at least one turn from each participant.

      • FAILED_SAFETY_GUIDELINES: The extracted information cannot be provided because it failed to meet system safety guidelines.

      • INTERNAL_ERROR: Internal system error.

      • MAX_PACKAGE_FEATURE_ONLY: Information extraction is only available in Amazon Connect Customer instances.

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

      Returns:
      If the information failed to be extracted, one of the following failure codes occurs:

      • QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.

      • INSUFFICIENT_CONVERSATION_CONTENT: Information extraction requires a conversation with at least one turn from each participant.

      • FAILED_SAFETY_GUIDELINES: The extracted information cannot be provided because it failed to meet system safety guidelines.

      • INTERNAL_ERROR: Internal system error.

      • MAX_PACKAGE_FEATURE_ONLY: Information extraction is only available in Amazon Connect Customer instances.

      See Also:

    • toBuilder

      public RealTimeContactAnalysisSegmentExtractedInformation.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<RealTimeContactAnalysisSegmentExtractedInformation.Builder,RealTimeContactAnalysisSegmentExtractedInformation>
      Returns:
      a builder for type T

    • builder

      public static RealTimeContactAnalysisSegmentExtractedInformation.Builder builder()

    • serializableBuilderClass

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

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