Interface AnalyzeDocumentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<AnalyzeDocumentRequest.Builder,AnalyzeDocumentRequest>, SdkBuilder<AnalyzeDocumentRequest.Builder,AnalyzeDocumentRequest>, SdkPojo, SdkRequest.Builder, TextractRequest.Builder
Enclosing class:
AnalyzeDocumentRequest
public static interface AnalyzeDocumentRequest.Builder extends TextractRequest.Builder, SdkPojo, CopyableBuilder<AnalyzeDocumentRequest.Builder,AnalyzeDocumentRequest>

  • Method Details

    • document

      AnalyzeDocumentRequest.Builder document(Document document)

      The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

      If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

      Parameters:
      document - The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

      If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

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

    • document

      default AnalyzeDocumentRequest.Builder document(Consumer<Document.Builder> document)

      The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

      If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to document(Document).

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

    • featureTypesWithStrings

      AnalyzeDocumentRequest.Builder featureTypesWithStrings(Collection<String> featureTypes)

      A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

      Parameters:
      featureTypes - A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • featureTypesWithStrings

      AnalyzeDocumentRequest.Builder featureTypesWithStrings(String... featureTypes)

      A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

      Parameters:
      featureTypes - A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • featureTypes

      AnalyzeDocumentRequest.Builder featureTypes(Collection<FeatureType> featureTypes)

      A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

      Parameters:
      featureTypes - A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • featureTypes

      AnalyzeDocumentRequest.Builder featureTypes(FeatureType... featureTypes)

      A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

      Parameters:
      featureTypes - A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • humanLoopConfig

      AnalyzeDocumentRequest.Builder humanLoopConfig(HumanLoopConfig humanLoopConfig)

      Sets the configuration for the human in the loop workflow for analyzing documents.

      Parameters:
      humanLoopConfig - Sets the configuration for the human in the loop workflow for analyzing documents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • humanLoopConfig

      default AnalyzeDocumentRequest.Builder humanLoopConfig(Consumer<HumanLoopConfig.Builder> humanLoopConfig)

      Sets the configuration for the human in the loop workflow for analyzing documents.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to humanLoopConfig(HumanLoopConfig).

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

    • queriesConfig

      AnalyzeDocumentRequest.Builder queriesConfig(QueriesConfig queriesConfig)

      Contains Queries and the alias for those Queries, as determined by the input.

      Parameters:
      queriesConfig - Contains Queries and the alias for those Queries, as determined by the input.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queriesConfig

      default AnalyzeDocumentRequest.Builder queriesConfig(Consumer<QueriesConfig.Builder> queriesConfig)

      Contains Queries and the alias for those Queries, as determined by the input.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queriesConfig(QueriesConfig).

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

    • adaptersConfig

      AnalyzeDocumentRequest.Builder adaptersConfig(AdaptersConfig adaptersConfig)

      Specifies the adapter to be used when analyzing a document.

      Parameters:
      adaptersConfig - Specifies the adapter to be used when analyzing a document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adaptersConfig

      default AnalyzeDocumentRequest.Builder adaptersConfig(Consumer<AdaptersConfig.Builder> adaptersConfig)

      Specifies the adapter to be used when analyzing a document.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to adaptersConfig(AdaptersConfig).

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

    • overrideConfiguration

      AnalyzeDocumentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      AnalyzeDocumentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.