Package software.amazon.awssdk.services.textract.model

Interface AnalyzeDocumentRequest.Builder

    • Method Detail

      • 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:
        document(Document)

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

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

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