Struct InputDataConfig

#[non_exhaustive]
pub struct InputDataConfig {
    pub s3_uri: String,
    pub input_format: Option<InputFormat>,
    pub document_reader_config: Option<DocumentReaderConfig>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

s3_uri: String

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.

input_format: Option<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.

document_reader_config: Option<DocumentReaderConfig>

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

Implementations

impl InputDataConfig

pub fn s3_uri(&self) -> &str

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.

pub fn input_format(&self) -> Option<&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.

pub fn document_reader_config(&self) -> Option<&DocumentReaderConfig>

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

impl InputDataConfig

pub fn builder() -> InputDataConfigBuilder

Creates a new builder-style object to manufacture InputDataConfig.

Trait Implementations

impl Clone for InputDataConfig

fn clone(&self) -> InputDataConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InputDataConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for InputDataConfig

fn eq(&self, other: &InputDataConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InputDataConfig