Interface AnalyzeDocumentRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<AnalyzeDocumentRequest.Builder,
,AnalyzeDocumentRequest> SdkBuilder<AnalyzeDocumentRequest.Builder,
,AnalyzeDocumentRequest> SdkPojo
,SdkRequest.Builder
,TextractRequest.Builder
- Enclosing class:
AnalyzeDocumentRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault AnalyzeDocumentRequest.Builder
adaptersConfig
(Consumer<AdaptersConfig.Builder> adaptersConfig) Specifies the adapter to be used when analyzing a document.adaptersConfig
(AdaptersConfig adaptersConfig) Specifies the adapter to be used when analyzing a document.default AnalyzeDocumentRequest.Builder
document
(Consumer<Document.Builder> document) The input document as base64-encoded bytes or an Amazon S3 object.The input document as base64-encoded bytes or an Amazon S3 object.featureTypes
(Collection<FeatureType> featureTypes) A list of the types of analysis to perform.featureTypes
(FeatureType... featureTypes) A list of the types of analysis to perform.featureTypesWithStrings
(String... featureTypes) A list of the types of analysis to perform.featureTypesWithStrings
(Collection<String> featureTypes) A list of the types of analysis to perform.default AnalyzeDocumentRequest.Builder
humanLoopConfig
(Consumer<HumanLoopConfig.Builder> humanLoopConfig) Sets the configuration for the human in the loop workflow for analyzing documents.humanLoopConfig
(HumanLoopConfig humanLoopConfig) Sets the configuration for the human in the loop workflow for analyzing documents.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default AnalyzeDocumentRequest.Builder
queriesConfig
(Consumer<QueriesConfig.Builder> queriesConfig) Contains Queries and the alias for those Queries, as determined by the input.queriesConfig
(QueriesConfig queriesConfig) Contains Queries and the alias for those Queries, as determined by the input.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
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
Methods inherited from interface software.amazon.awssdk.services.textract.model.TextractRequest.Builder
build
-
Method Details
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
This is a convenience method that creates an instance of theBytes
field.Document.Builder
avoiding the need to create one manually viaDocument.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todocument(Document)
.- Parameters:
document
- a consumer that will call methods onDocument.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
featureTypesWithStrings
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. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of
FeatureTypes
).- Parameters:
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. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value ofFeatureTypes
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
featureTypesWithStrings
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. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of
FeatureTypes
).- Parameters:
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. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value ofFeatureTypes
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of
FeatureTypes
).- Parameters:
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. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value ofFeatureTypes
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of
FeatureTypes
).- Parameters:
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. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value ofFeatureTypes
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
humanLoopConfig
Sets the configuration for the human in the loop workflow for analyzing documents.
- Parameters:
humanLoopConfig
- Sets the configuration for the human in the loop workflow for analyzing documents.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
humanLoopConfig
default AnalyzeDocumentRequest.Builder humanLoopConfig(Consumer<HumanLoopConfig.Builder> humanLoopConfig) Sets the configuration for the human in the loop workflow for analyzing documents.
This is a convenience method that creates an instance of theHumanLoopConfig.Builder
avoiding the need to create one manually viaHumanLoopConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohumanLoopConfig(HumanLoopConfig)
.- Parameters:
humanLoopConfig
- a consumer that will call methods onHumanLoopConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
queriesConfig
Contains Queries and the alias for those Queries, as determined by the input.
- Parameters:
queriesConfig
- Contains Queries and the alias for those Queries, as determined by the input.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
queriesConfig
Contains Queries and the alias for those Queries, as determined by the input.
This is a convenience method that creates an instance of theQueriesConfig.Builder
avoiding the need to create one manually viaQueriesConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toqueriesConfig(QueriesConfig)
.- Parameters:
queriesConfig
- a consumer that will call methods onQueriesConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
adaptersConfig
Specifies the adapter to be used when analyzing a document.
- Parameters:
adaptersConfig
- Specifies the adapter to be used when analyzing a document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
adaptersConfig
default AnalyzeDocumentRequest.Builder adaptersConfig(Consumer<AdaptersConfig.Builder> adaptersConfig) Specifies the adapter to be used when analyzing a document.
This is a convenience method that creates an instance of theAdaptersConfig.Builder
avoiding the need to create one manually viaAdaptersConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toadaptersConfig(AdaptersConfig)
.- Parameters:
adaptersConfig
- a consumer that will call methods onAdaptersConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
AnalyzeDocumentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
AnalyzeDocumentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-