/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { namespace Textract { namespace Model { /** */ class AnalyzeDocumentRequest : public TextractRequest { public: AWS_TEXTRACT_API AnalyzeDocumentRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "AnalyzeDocument"; } AWS_TEXTRACT_API Aws::String SerializePayload() const override; AWS_TEXTRACT_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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.

*/ inline const Document& GetDocument() const{ return m_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.

*/ inline bool DocumentHasBeenSet() const { return m_documentHasBeenSet; } /** *

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.

*/ inline void SetDocument(const Document& value) { m_documentHasBeenSet = true; m_document = value; } /** *

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.

*/ inline void SetDocument(Document&& value) { m_documentHasBeenSet = true; m_document = std::move(value); } /** *

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.

*/ inline AnalyzeDocumentRequest& WithDocument(const Document& value) { SetDocument(value); return *this;} /** *

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.

*/ inline AnalyzeDocumentRequest& WithDocument(Document&& value) { SetDocument(std::move(value)); return *this;} /** *

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. To perform both forms and table analysis, add TABLES and FORMS to * FeatureTypes. To detect signatures within form data and table data, * add SIGNATURES to either TABLES or FORMS. All lines and words detected in the * document are included in the response (including text that isn't related to the * value of FeatureTypes).

*/ inline const Aws::Vector& GetFeatureTypes() const{ return m_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. To perform both forms and table analysis, add TABLES and FORMS to * FeatureTypes. To detect signatures within form data and table data, * add SIGNATURES to either TABLES or FORMS. All lines and words detected in the * document are included in the response (including text that isn't related to the * value of FeatureTypes).

*/ inline bool FeatureTypesHasBeenSet() const { return m_featureTypesHasBeenSet; } /** *

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. To perform both forms and table analysis, add TABLES and FORMS to * FeatureTypes. To detect signatures within form data and table data, * add SIGNATURES to either TABLES or FORMS. All lines and words detected in the * document are included in the response (including text that isn't related to the * value of FeatureTypes).

*/ inline void SetFeatureTypes(const Aws::Vector& value) { m_featureTypesHasBeenSet = true; m_featureTypes = value; } /** *

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. To perform both forms and table analysis, add TABLES and FORMS to * FeatureTypes. To detect signatures within form data and table data, * add SIGNATURES to either TABLES or FORMS. All lines and words detected in the * document are included in the response (including text that isn't related to the * value of FeatureTypes).

*/ inline void SetFeatureTypes(Aws::Vector&& value) { m_featureTypesHasBeenSet = true; m_featureTypes = std::move(value); } /** *

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. To perform both forms and table analysis, add TABLES and FORMS to * FeatureTypes. To detect signatures within form data and table data, * add SIGNATURES to either TABLES or FORMS. All lines and words detected in the * document are included in the response (including text that isn't related to the * value of FeatureTypes).

*/ inline AnalyzeDocumentRequest& WithFeatureTypes(const Aws::Vector& value) { SetFeatureTypes(value); return *this;} /** *

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. To perform both forms and table analysis, add TABLES and FORMS to * FeatureTypes. To detect signatures within form data and table data, * add SIGNATURES to either TABLES or FORMS. All lines and words detected in the * document are included in the response (including text that isn't related to the * value of FeatureTypes).

*/ inline AnalyzeDocumentRequest& WithFeatureTypes(Aws::Vector&& value) { SetFeatureTypes(std::move(value)); return *this;} /** *

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. To perform both forms and table analysis, add TABLES and FORMS to * FeatureTypes. To detect signatures within form data and table data, * add SIGNATURES to either TABLES or FORMS. All lines and words detected in the * document are included in the response (including text that isn't related to the * value of FeatureTypes).

*/ inline AnalyzeDocumentRequest& AddFeatureTypes(const FeatureType& value) { m_featureTypesHasBeenSet = true; m_featureTypes.push_back(value); return *this; } /** *

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. To perform both forms and table analysis, add TABLES and FORMS to * FeatureTypes. To detect signatures within form data and table data, * add SIGNATURES to either TABLES or FORMS. All lines and words detected in the * document are included in the response (including text that isn't related to the * value of FeatureTypes).

*/ inline AnalyzeDocumentRequest& AddFeatureTypes(FeatureType&& value) { m_featureTypesHasBeenSet = true; m_featureTypes.push_back(std::move(value)); return *this; } /** *

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

*/ inline const HumanLoopConfig& GetHumanLoopConfig() const{ return m_humanLoopConfig; } /** *

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

*/ inline bool HumanLoopConfigHasBeenSet() const { return m_humanLoopConfigHasBeenSet; } /** *

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

*/ inline void SetHumanLoopConfig(const HumanLoopConfig& value) { m_humanLoopConfigHasBeenSet = true; m_humanLoopConfig = value; } /** *

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

*/ inline void SetHumanLoopConfig(HumanLoopConfig&& value) { m_humanLoopConfigHasBeenSet = true; m_humanLoopConfig = std::move(value); } /** *

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

*/ inline AnalyzeDocumentRequest& WithHumanLoopConfig(const HumanLoopConfig& value) { SetHumanLoopConfig(value); return *this;} /** *

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

*/ inline AnalyzeDocumentRequest& WithHumanLoopConfig(HumanLoopConfig&& value) { SetHumanLoopConfig(std::move(value)); return *this;} /** *

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

*/ inline const QueriesConfig& GetQueriesConfig() const{ return m_queriesConfig; } /** *

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

*/ inline bool QueriesConfigHasBeenSet() const { return m_queriesConfigHasBeenSet; } /** *

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

*/ inline void SetQueriesConfig(const QueriesConfig& value) { m_queriesConfigHasBeenSet = true; m_queriesConfig = value; } /** *

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

*/ inline void SetQueriesConfig(QueriesConfig&& value) { m_queriesConfigHasBeenSet = true; m_queriesConfig = std::move(value); } /** *

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

*/ inline AnalyzeDocumentRequest& WithQueriesConfig(const QueriesConfig& value) { SetQueriesConfig(value); return *this;} /** *

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

*/ inline AnalyzeDocumentRequest& WithQueriesConfig(QueriesConfig&& value) { SetQueriesConfig(std::move(value)); return *this;} private: Document m_document; bool m_documentHasBeenSet = false; Aws::Vector m_featureTypes; bool m_featureTypesHasBeenSet = false; HumanLoopConfig m_humanLoopConfig; bool m_humanLoopConfigHasBeenSet = false; QueriesConfig m_queriesConfig; bool m_queriesConfigHasBeenSet = false; }; } // namespace Model } // namespace Textract } // namespace Aws