Interface ExtractedInformation.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ExtractedInformation.Builder,ExtractedInformation>, SdkBuilder<ExtractedInformation.Builder,ExtractedInformation>, SdkPojo
Enclosing class:
ExtractedInformation
@Mutable @NotThreadSafe public static interface ExtractedInformation.Builder extends SdkPojo, CopyableBuilder<ExtractedInformation.Builder,ExtractedInformation>

  • Method Details

    • extractionDefinitionId

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

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

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

      ExtractedInformation.Builder extractedValues(Collection<ExtractedInformationValue> 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

      ExtractedInformation.Builder extractedValues(ExtractedInformationValue... 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

      ExtractedInformation.Builder extractedValues(Consumer<ExtractedInformationValue.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 ExtractedInformationValue.Builder avoiding the need to create one manually via ExtractedInformationValue.builder().

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

      Parameters:
      extractedValues - a consumer that will call methods on ExtractedInformationValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failureCode

      ExtractedInformation.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:

    • failureCode

      ExtractedInformation.Builder failureCode(ExtractedInformationFailureCode 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: