Interface InputDataConfig.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<InputDataConfig.Builder,InputDataConfig>,SdkBuilder<InputDataConfig.Builder,InputDataConfig>,SdkPojo
- Enclosing class:
- InputDataConfig
public static interface InputDataConfig.Builder extends SdkPojo, CopyableBuilder<InputDataConfig.Builder,InputDataConfig>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default InputDataConfig.BuilderdocumentReaderConfig(Consumer<DocumentReaderConfig.Builder> documentReaderConfig)Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.InputDataConfig.BuilderdocumentReaderConfig(DocumentReaderConfig documentReaderConfig)Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.InputDataConfig.BuilderinputFormat(String inputFormat)Specifies how the text in an input file should be processed:InputDataConfig.BuilderinputFormat(InputFormat inputFormat)Specifies how the text in an input file should be processed:InputDataConfig.Builders3Uri(String s3Uri)The Amazon S3 URI for the input data.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
s3Uri
InputDataConfig.Builder s3Uri(String 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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputFormat
InputDataConfig.Builder inputFormat(String 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InputFormat,InputFormat
-
-
inputFormat
InputDataConfig.Builder inputFormat(InputFormat 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
InputFormat,InputFormat
-
-
documentReaderConfig
InputDataConfig.Builder documentReaderConfig(DocumentReaderConfig documentReaderConfig)
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
- Parameters:
documentReaderConfig- Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentReaderConfig
default InputDataConfig.Builder documentReaderConfig(Consumer<DocumentReaderConfig.Builder> documentReaderConfig)
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
This is a convenience method that creates an instance of theDocumentReaderConfig.Builderavoiding the need to create one manually viaDocumentReaderConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todocumentReaderConfig(DocumentReaderConfig).- Parameters:
documentReaderConfig- a consumer that will call methods onDocumentReaderConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
documentReaderConfig(DocumentReaderConfig)
-
-