/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Comprehend { namespace Model { /** *

The input properties for an inference job. The document reader config field * applies only to non-text inputs for custom analysis.

See Also:

* AWS * API Reference

*/ class InputDataConfig { public: AWS_COMPREHEND_API InputDataConfig(); AWS_COMPREHEND_API InputDataConfig(Aws::Utils::Json::JsonView jsonValue); AWS_COMPREHEND_API InputDataConfig& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_COMPREHEND_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The Amazon S3 URI for the input data. The URI must be in same Region as the * API endpoint that you are calling. The URI can point to a single input file or * it can provide the prefix for a collection of data files.

For example, * if you use the URI S3://bucketName/prefix, if the prefix is a * single file, Amazon Comprehend uses that file as input. If more than one file * begins with the prefix, Amazon Comprehend uses all of them as input.

*/ inline const Aws::String& GetS3Uri() const{ return m_s3Uri; } /** *

The Amazon S3 URI for the input data. The URI must be in same Region as the * API endpoint that you are calling. The URI can point to a single input file or * it can provide the prefix for a collection of data files.

For example, * if you use the URI S3://bucketName/prefix, if the prefix is a * single file, Amazon Comprehend uses that file as input. If more than one file * begins with the prefix, Amazon Comprehend uses all of them as input.

*/ inline bool S3UriHasBeenSet() const { return m_s3UriHasBeenSet; } /** *

The Amazon S3 URI for the input data. The URI must be in same Region as the * API endpoint that you are calling. The URI can point to a single input file or * it can provide the prefix for a collection of data files.

For example, * if you use the URI S3://bucketName/prefix, if the prefix is a * single file, Amazon Comprehend uses that file as input. If more than one file * begins with the prefix, Amazon Comprehend uses all of them as input.

*/ inline void SetS3Uri(const Aws::String& value) { m_s3UriHasBeenSet = true; m_s3Uri = value; } /** *

The Amazon S3 URI for the input data. The URI must be in same Region as the * API endpoint that you are calling. The URI can point to a single input file or * it can provide the prefix for a collection of data files.

For example, * if you use the URI S3://bucketName/prefix, if the prefix is a * single file, Amazon Comprehend uses that file as input. If more than one file * begins with the prefix, Amazon Comprehend uses all of them as input.

*/ inline void SetS3Uri(Aws::String&& value) { m_s3UriHasBeenSet = true; m_s3Uri = std::move(value); } /** *

The Amazon S3 URI for the input data. The URI must be in same Region as the * API endpoint that you are calling. The URI can point to a single input file or * it can provide the prefix for a collection of data files.

For example, * if you use the URI S3://bucketName/prefix, if the prefix is a * single file, Amazon Comprehend uses that file as input. If more than one file * begins with the prefix, Amazon Comprehend uses all of them as input.

*/ inline void SetS3Uri(const char* value) { m_s3UriHasBeenSet = true; m_s3Uri.assign(value); } /** *

The Amazon S3 URI for the input data. The URI must be in same Region as the * API endpoint that you are calling. The URI can point to a single input file or * it can provide the prefix for a collection of data files.

For example, * if you use the URI S3://bucketName/prefix, if the prefix is a * single file, Amazon Comprehend uses that file as input. If more than one file * begins with the prefix, Amazon Comprehend uses all of them as input.

*/ inline InputDataConfig& WithS3Uri(const Aws::String& value) { SetS3Uri(value); return *this;} /** *

The Amazon S3 URI for the input data. The URI must be in same Region as the * API endpoint that you are calling. The URI can point to a single input file or * it can provide the prefix for a collection of data files.

For example, * if you use the URI S3://bucketName/prefix, if the prefix is a * single file, Amazon Comprehend uses that file as input. If more than one file * begins with the prefix, Amazon Comprehend uses all of them as input.

*/ inline InputDataConfig& WithS3Uri(Aws::String&& value) { SetS3Uri(std::move(value)); return *this;} /** *

The Amazon S3 URI for the input data. The URI must be in same Region as the * API endpoint that you are calling. The URI can point to a single input file or * it can provide the prefix for a collection of data files.

For example, * if you use the URI S3://bucketName/prefix, if the prefix is a * single file, Amazon Comprehend uses that file as input. If more than one file * begins with the prefix, Amazon Comprehend uses all of them as input.

*/ inline InputDataConfig& WithS3Uri(const char* value) { SetS3Uri(value); return *this;} /** *

Specifies how the text in an input file should be processed:

  • *

    ONE_DOC_PER_FILE - Each file is considered a separate document. * Use this option when you are processing large documents, such as newspaper * articles or scientific papers.

  • ONE_DOC_PER_LINE * - Each line in a file is considered a separate document. Use this option when * you are processing many short documents, such as text messages.

*/ inline const InputFormat& GetInputFormat() const{ return m_inputFormat; } /** *

Specifies how the text in an input file should be processed:

  • *

    ONE_DOC_PER_FILE - Each file is considered a separate document. * Use this option when you are processing large documents, such as newspaper * articles or scientific papers.

  • ONE_DOC_PER_LINE * - Each line in a file is considered a separate document. Use this option when * you are processing many short documents, such as text messages.

*/ inline bool InputFormatHasBeenSet() const { return m_inputFormatHasBeenSet; } /** *

Specifies how the text in an input file should be processed:

  • *

    ONE_DOC_PER_FILE - Each file is considered a separate document. * Use this option when you are processing large documents, such as newspaper * articles or scientific papers.

  • ONE_DOC_PER_LINE * - Each line in a file is considered a separate document. Use this option when * you are processing many short documents, such as text messages.

*/ inline void SetInputFormat(const InputFormat& value) { m_inputFormatHasBeenSet = true; m_inputFormat = value; } /** *

Specifies how the text in an input file should be processed:

  • *

    ONE_DOC_PER_FILE - Each file is considered a separate document. * Use this option when you are processing large documents, such as newspaper * articles or scientific papers.

  • ONE_DOC_PER_LINE * - Each line in a file is considered a separate document. Use this option when * you are processing many short documents, such as text messages.

*/ inline void SetInputFormat(InputFormat&& value) { m_inputFormatHasBeenSet = true; m_inputFormat = std::move(value); } /** *

Specifies how the text in an input file should be processed:

  • *

    ONE_DOC_PER_FILE - Each file is considered a separate document. * Use this option when you are processing large documents, such as newspaper * articles or scientific papers.

  • ONE_DOC_PER_LINE * - Each line in a file is considered a separate document. Use this option when * you are processing many short documents, such as text messages.

*/ inline InputDataConfig& WithInputFormat(const InputFormat& value) { SetInputFormat(value); return *this;} /** *

Specifies how the text in an input file should be processed:

  • *

    ONE_DOC_PER_FILE - Each file is considered a separate document. * Use this option when you are processing large documents, such as newspaper * articles or scientific papers.

  • ONE_DOC_PER_LINE * - Each line in a file is considered a separate document. Use this option when * you are processing many short documents, such as text messages.

*/ inline InputDataConfig& WithInputFormat(InputFormat&& value) { SetInputFormat(std::move(value)); return *this;} /** *

Provides configuration parameters to override the default actions for * extracting text from PDF documents and image files.

*/ inline const DocumentReaderConfig& GetDocumentReaderConfig() const{ return m_documentReaderConfig; } /** *

Provides configuration parameters to override the default actions for * extracting text from PDF documents and image files.

*/ inline bool DocumentReaderConfigHasBeenSet() const { return m_documentReaderConfigHasBeenSet; } /** *

Provides configuration parameters to override the default actions for * extracting text from PDF documents and image files.

*/ inline void SetDocumentReaderConfig(const DocumentReaderConfig& value) { m_documentReaderConfigHasBeenSet = true; m_documentReaderConfig = value; } /** *

Provides configuration parameters to override the default actions for * extracting text from PDF documents and image files.

*/ inline void SetDocumentReaderConfig(DocumentReaderConfig&& value) { m_documentReaderConfigHasBeenSet = true; m_documentReaderConfig = std::move(value); } /** *

Provides configuration parameters to override the default actions for * extracting text from PDF documents and image files.

*/ inline InputDataConfig& WithDocumentReaderConfig(const DocumentReaderConfig& value) { SetDocumentReaderConfig(value); return *this;} /** *

Provides configuration parameters to override the default actions for * extracting text from PDF documents and image files.

*/ inline InputDataConfig& WithDocumentReaderConfig(DocumentReaderConfig&& value) { SetDocumentReaderConfig(std::move(value)); return *this;} private: Aws::String m_s3Uri; bool m_s3UriHasBeenSet = false; InputFormat m_inputFormat; bool m_inputFormatHasBeenSet = false; DocumentReaderConfig m_documentReaderConfig; bool m_documentReaderConfigHasBeenSet = false; }; } // namespace Model } // namespace Comprehend } // namespace Aws