Class RealTimeContactAnalysisSegmentPostContactSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RealTimeContactAnalysisSegmentPostContactSummary.Builder,
RealTimeContactAnalysisSegmentPostContactSummary>
Information about the post-contact summary for a real-time contact segment.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
content()
The content of the summary.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.If the summary failed to be generated, one of the following failure codes occurs:final String
If the summary failed to be generated, one of the following failure codes occurs:final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends RealTimeContactAnalysisSegmentPostContactSummary.Builder> status()
Whether the summary was successfully COMPLETED or FAILED to be generated.final String
Whether the summary was successfully COMPLETED or FAILED to be generated.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
content
The content of the summary.
- Returns:
- The content of the summary.
-
status
Whether the summary was successfully COMPLETED or FAILED to be generated.
If the service returns an enum value that is not available in the current SDK version,
status
will returnRealTimeContactAnalysisPostContactSummaryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Whether the summary was successfully COMPLETED or FAILED to be generated.
- See Also:
-
statusAsString
Whether the summary was successfully COMPLETED or FAILED to be generated.
If the service returns an enum value that is not available in the current SDK version,
status
will returnRealTimeContactAnalysisPostContactSummaryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Whether the summary was successfully COMPLETED or FAILED to be generated.
- See Also:
-
failureCode
If the summary failed to be generated, one of the following failure codes occurs:
-
QUOTA_EXCEEDED
: The number of concurrent analytics jobs reached your service quota. -
INSUFFICIENT_CONVERSATION_CONTENT
: The conversation needs to have at least one turn from both the participants in order to generate the summary. -
FAILED_SAFETY_GUIDELINES
: The generated summary cannot be provided because it failed to meet system safety guidelines. -
INVALID_ANALYSIS_CONFIGURATION
: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries. -
INTERNAL_ERROR
: Internal system error.
If the service returns an enum value that is not available in the current SDK version,
failureCode
will returnRealTimeContactAnalysisPostContactSummaryFailureCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfailureCodeAsString()
.- Returns:
- If the summary failed to be generated, one of the following failure codes occurs:
-
QUOTA_EXCEEDED
: The number of concurrent analytics jobs reached your service quota. -
INSUFFICIENT_CONVERSATION_CONTENT
: The conversation needs to have at least one turn from both the participants in order to generate the summary. -
FAILED_SAFETY_GUIDELINES
: The generated summary cannot be provided because it failed to meet system safety guidelines. -
INVALID_ANALYSIS_CONFIGURATION
: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries. -
INTERNAL_ERROR
: Internal system error.
-
- See Also:
-
-
failureCodeAsString
If the summary failed to be generated, one of the following failure codes occurs:
-
QUOTA_EXCEEDED
: The number of concurrent analytics jobs reached your service quota. -
INSUFFICIENT_CONVERSATION_CONTENT
: The conversation needs to have at least one turn from both the participants in order to generate the summary. -
FAILED_SAFETY_GUIDELINES
: The generated summary cannot be provided because it failed to meet system safety guidelines. -
INVALID_ANALYSIS_CONFIGURATION
: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries. -
INTERNAL_ERROR
: Internal system error.
If the service returns an enum value that is not available in the current SDK version,
failureCode
will returnRealTimeContactAnalysisPostContactSummaryFailureCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfailureCodeAsString()
.- Returns:
- If the summary failed to be generated, one of the following failure codes occurs:
-
QUOTA_EXCEEDED
: The number of concurrent analytics jobs reached your service quota. -
INSUFFICIENT_CONVERSATION_CONTENT
: The conversation needs to have at least one turn from both the participants in order to generate the summary. -
FAILED_SAFETY_GUIDELINES
: The generated summary cannot be provided because it failed to meet system safety guidelines. -
INVALID_ANALYSIS_CONFIGURATION
: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries. -
INTERNAL_ERROR
: Internal system error.
-
- See Also:
-
-
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 interfaceToCopyableBuilder<RealTimeContactAnalysisSegmentPostContactSummary.Builder,
RealTimeContactAnalysisSegmentPostContactSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends RealTimeContactAnalysisSegmentPostContactSummary.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-