Interface RealTimeContactAnalysisSegmentExtractedInformation.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RealTimeContactAnalysisSegmentExtractedInformation.Builder,RealTimeContactAnalysisSegmentExtractedInformation>, SdkBuilder<RealTimeContactAnalysisSegmentExtractedInformation.Builder,RealTimeContactAnalysisSegmentExtractedInformation>, SdkPojo

Enclosing class:

RealTimeContactAnalysisSegmentExtractedInformation

@Mutable
@NotThreadSafe
public static interface RealTimeContactAnalysisSegmentExtractedInformation.Builder
extends SdkPojo, CopyableBuilder<RealTimeContactAnalysisSegmentExtractedInformation.Builder,RealTimeContactAnalysisSegmentExtractedInformation>

Method Summary

Modifier and Type	Method	Description
RealTimeContactAnalysisSegmentExtractedInformation.Builder	extractedValues(Collection<RealTimeContactAnalysisExtractedInformationValue> extractedValues)	The list of values extracted from the conversation for this extraction definition.
RealTimeContactAnalysisSegmentExtractedInformation.Builder	extractedValues(Consumer<RealTimeContactAnalysisExtractedInformationValue.Builder>... extractedValues)	The list of values extracted from the conversation for this extraction definition.
RealTimeContactAnalysisSegmentExtractedInformation.Builder	extractedValues(RealTimeContactAnalysisExtractedInformationValue... extractedValues)	The list of values extracted from the conversation for this extraction definition.
RealTimeContactAnalysisSegmentExtractedInformation.Builder	extractionDefinitionDisplayLabel(String extractionDefinitionDisplayLabel)	The display label of the extraction definition that produced this result.
RealTimeContactAnalysisSegmentExtractedInformation.Builder	extractionDefinitionId(String extractionDefinitionId)	The identifier of the extraction definition that produced this result.
RealTimeContactAnalysisSegmentExtractedInformation.Builder	extractionDefinitionName(String extractionDefinitionName)	The name of the extraction definition that produced this result.
RealTimeContactAnalysisSegmentExtractedInformation.Builder	failureCode(String failureCode)	If the information failed to be extracted, one of the following failure codes occurs:
RealTimeContactAnalysisSegmentExtractedInformation.Builder	failureCode(RealTimeContactAnalysisExtractedInformationFailureCode failureCode)	If the information failed to be extracted, one of the following failure codes occurs:

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

extractionDefinitionId

RealTimeContactAnalysisSegmentExtractedInformation.Builder extractionDefinitionId(String extractionDefinitionId)

The identifier of the extraction definition that produced this result.

Parameters:

extractionDefinitionId - The identifier of the extraction definition that produced this result.

Returns:

Returns a reference to this object so that method calls can be chained together.

extractionDefinitionName

RealTimeContactAnalysisSegmentExtractedInformation.Builder extractionDefinitionName(String extractionDefinitionName)

The name of the extraction definition that produced this result.

Parameters:

extractionDefinitionName - The name of the extraction definition that produced this result.

Returns:

Returns a reference to this object so that method calls can be chained together.

extractionDefinitionDisplayLabel

RealTimeContactAnalysisSegmentExtractedInformation.Builder extractionDefinitionDisplayLabel(String extractionDefinitionDisplayLabel)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

extractedValues

RealTimeContactAnalysisSegmentExtractedInformation.Builder extractedValues(Collection<RealTimeContactAnalysisExtractedInformationValue> extractedValues)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

extractedValues

RealTimeContactAnalysisSegmentExtractedInformation.Builder extractedValues(RealTimeContactAnalysisExtractedInformationValue... extractedValues)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

extractedValues

RealTimeContactAnalysisSegmentExtractedInformation.Builder extractedValues(Consumer<RealTimeContactAnalysisExtractedInformationValue.Builder>... extractedValues)

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

This is a convenience method that creates an instance of the RealTimeContactAnalysisExtractedInformationValue.Builder avoiding the need to create one manually via RealTimeContactAnalysisExtractedInformationValue.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to extractedValues(List<RealTimeContactAnalysisExtractedInformationValue>).

Parameters:

extractedValues - a consumer that will call methods on RealTimeContactAnalysisExtractedInformationValue.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• extractedValues(java.util.Collection<RealTimeContactAnalysisExtractedInformationValue>)

failureCode

RealTimeContactAnalysisSegmentExtractedInformation.Builder failureCode(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• RealTimeContactAnalysisExtractedInformationFailureCode
• RealTimeContactAnalysisExtractedInformationFailureCode

failureCode

RealTimeContactAnalysisSegmentExtractedInformation.Builder failureCode(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• RealTimeContactAnalysisExtractedInformationFailureCode
• RealTimeContactAnalysisExtractedInformationFailureCode