Class: Aws::Comprehend::Types::InputDataConfig

Inherits:

Struct

Object
Struct
Aws::Comprehend::Types::InputDataConfig

show all

Defined in:: gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

Note:

When making an API call, you may pass InputDataConfig data as a hash:

{
  s3_uri: "S3Uri", # required
  input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
}

The input properties for a topic detection job.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#input_format ⇒ String
Specifies how the text in an input file should be processed:.
#s3_uri ⇒ String
The Amazon S3 URI for the input data.

Instance Attribute Details

#input_format ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2843

class InputDataConfig < Struct.new(
  :s3_uri,
  :input_format)
  SENSITIVE = []
  include Aws::Structure
end

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