| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Textract
Contents
- Service Configuration
- Errors
- InvalidJobIdException
- AccessDeniedException
- BadDocumentException
- InvalidParameterException
- UnsupportedDocumentException
- InvalidS3ObjectException
- ProvisionedThroughputExceededException
- InvalidKMSKeyException
- ThrottlingException
- InternalServerError
- IdempotentParameterMismatchException
- HumanLoopQuotaExceededException
- DocumentTooLargeException
- LimitExceededException
- Waiters
- Operations
- Types
- BlockType
- ContentClassifier
- EntityType
- FeatureType
- JobStatus
- RelationshipType
- SelectionStatus
- TextType
- Block
- BoundingBox
- Document
- DocumentLocation
- DocumentMetadata
- ExpenseDetection
- ExpenseDocument
- ExpenseField
- ExpenseType
- Geometry
- HumanLoopActivationOutput
- HumanLoopConfig
- HumanLoopDataAttributes
- LineItemFields
- LineItemGroup
- NotificationChannel
- OutputConfig
- Point
- Relationship
- S3Object
- Warning
Description
Derived from API version 2018-06-27 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.
Synopsis
- defaultService :: Service
- _InvalidJobIdException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadDocumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedDocumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidS3ObjectException :: AsError a => Getting (First ServiceError) a ServiceError
- _ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidKMSKeyException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError
- _IdempotentParameterMismatchException :: AsError a => Getting (First ServiceError) a ServiceError
- _HumanLoopQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _DocumentTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data DetectDocumentText = DetectDocumentText' Document
- newDetectDocumentText :: Document -> DetectDocumentText
- data DetectDocumentTextResponse = DetectDocumentTextResponse' (Maybe DocumentMetadata) (Maybe [Block]) (Maybe Text) Int
- newDetectDocumentTextResponse :: Int -> DetectDocumentTextResponse
- data StartDocumentAnalysis = StartDocumentAnalysis' (Maybe Text) (Maybe NotificationChannel) (Maybe Text) (Maybe OutputConfig) (Maybe Text) DocumentLocation [FeatureType]
- newStartDocumentAnalysis :: DocumentLocation -> StartDocumentAnalysis
- data StartDocumentAnalysisResponse = StartDocumentAnalysisResponse' (Maybe Text) Int
- newStartDocumentAnalysisResponse :: Int -> StartDocumentAnalysisResponse
- data AnalyzeDocument = AnalyzeDocument' (Maybe HumanLoopConfig) Document [FeatureType]
- newAnalyzeDocument :: Document -> AnalyzeDocument
- data AnalyzeDocumentResponse = AnalyzeDocumentResponse' (Maybe DocumentMetadata) (Maybe [Block]) (Maybe HumanLoopActivationOutput) (Maybe Text) Int
- newAnalyzeDocumentResponse :: Int -> AnalyzeDocumentResponse
- data GetDocumentTextDetection = GetDocumentTextDetection' (Maybe Text) (Maybe Natural) Text
- newGetDocumentTextDetection :: Text -> GetDocumentTextDetection
- data GetDocumentTextDetectionResponse = GetDocumentTextDetectionResponse' (Maybe DocumentMetadata) (Maybe [Block]) (Maybe [Warning]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe JobStatus) Int
- newGetDocumentTextDetectionResponse :: Int -> GetDocumentTextDetectionResponse
- data AnalyzeExpense = AnalyzeExpense' Document
- newAnalyzeExpense :: Document -> AnalyzeExpense
- data AnalyzeExpenseResponse = AnalyzeExpenseResponse' (Maybe DocumentMetadata) (Maybe [ExpenseDocument]) Int
- newAnalyzeExpenseResponse :: Int -> AnalyzeExpenseResponse
- data StartDocumentTextDetection = StartDocumentTextDetection' (Maybe Text) (Maybe NotificationChannel) (Maybe Text) (Maybe OutputConfig) (Maybe Text) DocumentLocation
- newStartDocumentTextDetection :: DocumentLocation -> StartDocumentTextDetection
- data StartDocumentTextDetectionResponse = StartDocumentTextDetectionResponse' (Maybe Text) Int
- newStartDocumentTextDetectionResponse :: Int -> StartDocumentTextDetectionResponse
- data GetDocumentAnalysis = GetDocumentAnalysis' (Maybe Text) (Maybe Natural) Text
- newGetDocumentAnalysis :: Text -> GetDocumentAnalysis
- data GetDocumentAnalysisResponse = GetDocumentAnalysisResponse' (Maybe DocumentMetadata) (Maybe [Block]) (Maybe Text) (Maybe [Warning]) (Maybe Text) (Maybe Text) (Maybe JobStatus) Int
- newGetDocumentAnalysisResponse :: Int -> GetDocumentAnalysisResponse
- newtype BlockType where
- BlockType' { }
- pattern BlockType_CELL :: BlockType
- pattern BlockType_KEY_VALUE_SET :: BlockType
- pattern BlockType_LINE :: BlockType
- pattern BlockType_PAGE :: BlockType
- pattern BlockType_SELECTION_ELEMENT :: BlockType
- pattern BlockType_TABLE :: BlockType
- pattern BlockType_WORD :: BlockType
- newtype ContentClassifier where
- newtype EntityType where
- EntityType' { }
- pattern EntityType_KEY :: EntityType
- pattern EntityType_VALUE :: EntityType
- newtype FeatureType where
- FeatureType' { }
- pattern FeatureType_FORMS :: FeatureType
- pattern FeatureType_TABLES :: FeatureType
- newtype JobStatus where
- JobStatus' { }
- pattern JobStatus_FAILED :: JobStatus
- pattern JobStatus_IN_PROGRESS :: JobStatus
- pattern JobStatus_PARTIAL_SUCCESS :: JobStatus
- pattern JobStatus_SUCCEEDED :: JobStatus
- newtype RelationshipType where
- RelationshipType' { }
- pattern RelationshipType_CHILD :: RelationshipType
- pattern RelationshipType_COMPLEX_FEATURES :: RelationshipType
- pattern RelationshipType_VALUE :: RelationshipType
- newtype SelectionStatus where
- SelectionStatus' { }
- pattern SelectionStatus_NOT_SELECTED :: SelectionStatus
- pattern SelectionStatus_SELECTED :: SelectionStatus
- newtype TextType where
- TextType' {
- fromTextType :: Text
- pattern TextType_HANDWRITING :: TextType
- pattern TextType_PRINTED :: TextType
- TextType' {
- data Block = Block' (Maybe Natural) (Maybe Text) (Maybe [EntityType]) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe SelectionStatus) (Maybe Natural) (Maybe Double) (Maybe [Relationship]) (Maybe Geometry) (Maybe TextType) (Maybe Text) (Maybe BlockType)
- newBlock :: Block
- data BoundingBox = BoundingBox' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double)
- newBoundingBox :: BoundingBox
- data Document = Document' (Maybe S3Object) (Maybe Base64)
- newDocument :: Document
- data DocumentLocation = DocumentLocation' (Maybe S3Object)
- newDocumentLocation :: DocumentLocation
- data DocumentMetadata = DocumentMetadata' (Maybe Natural)
- newDocumentMetadata :: DocumentMetadata
- data ExpenseDetection = ExpenseDetection' (Maybe Text) (Maybe Double) (Maybe Geometry)
- newExpenseDetection :: ExpenseDetection
- data ExpenseDocument = ExpenseDocument' (Maybe [LineItemGroup]) (Maybe [ExpenseField]) (Maybe Natural)
- newExpenseDocument :: ExpenseDocument
- data ExpenseField = ExpenseField' (Maybe ExpenseDetection) (Maybe ExpenseDetection) (Maybe ExpenseType) (Maybe Natural)
- newExpenseField :: ExpenseField
- data ExpenseType = ExpenseType' (Maybe Text) (Maybe Double)
- newExpenseType :: ExpenseType
- data Geometry = Geometry' (Maybe BoundingBox) (Maybe [Point])
- newGeometry :: Geometry
- data HumanLoopActivationOutput = HumanLoopActivationOutput' (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text)
- newHumanLoopActivationOutput :: HumanLoopActivationOutput
- data HumanLoopConfig = HumanLoopConfig' (Maybe HumanLoopDataAttributes) Text Text
- newHumanLoopConfig :: Text -> Text -> HumanLoopConfig
- data HumanLoopDataAttributes = HumanLoopDataAttributes' (Maybe [ContentClassifier])
- newHumanLoopDataAttributes :: HumanLoopDataAttributes
- data LineItemFields = LineItemFields' (Maybe [ExpenseField])
- newLineItemFields :: LineItemFields
- data LineItemGroup = LineItemGroup' (Maybe [LineItemFields]) (Maybe Natural)
- newLineItemGroup :: LineItemGroup
- data NotificationChannel = NotificationChannel' Text Text
- newNotificationChannel :: Text -> Text -> NotificationChannel
- data OutputConfig = OutputConfig' (Maybe Text) Text
- newOutputConfig :: Text -> OutputConfig
- data Point = Point' (Maybe Double) (Maybe Double)
- newPoint :: Point
- data Relationship = Relationship' (Maybe [Text]) (Maybe RelationshipType)
- newRelationship :: Relationship
- data S3Object = S3Object' (Maybe Text) (Maybe Text) (Maybe Text)
- newS3Object :: S3Object
- data Warning = Warning' (Maybe [Natural]) (Maybe Text)
- newWarning :: Warning
Service Configuration
defaultService :: Service Source #
API version 2018-06-27 of the Amazon Textract SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Textract.
InvalidJobIdException
_InvalidJobIdException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An invalid job identifier was passed to GetDocumentAnalysis or to GetDocumentAnalysis.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
BadDocumentException
_BadDocumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An input parameter violated a constraint. For example, in synchronous
operations, an InvalidParameterException exception occurs when neither
of the S3Object or Bytes values are supplied in the Document
request parameter. Validate your parameter before calling the API
operation again.
UnsupportedDocumentException
_UnsupportedDocumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The format of the input document isn't supported. Documents for synchronous operations can be in PNG or JPEG format. Documents for asynchronous operations can also be in PDF format.
InvalidS3ObjectException
_InvalidS3ObjectException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
ProvisionedThroughputExceededException
_ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
InvalidKMSKeyException
_InvalidKMSKeyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
ThrottlingException
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Textract is temporarily unable to process the request. Try your call again.
InternalServerError
_InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Textract experienced a service issue. Try your call again.
IdempotentParameterMismatchException
_IdempotentParameterMismatchException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A ClientRequestToken input parameter was reused with an operation, but
at least one of the other input parameters is different from the
previous call to the operation.
HumanLoopQuotaExceededException
_HumanLoopQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates you have exceeded the maximum number of active human in the loop workflows available
DocumentTooLargeException
_DocumentTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An Amazon Textract service limit was exceeded. For example, if you start
too many asynchronous jobs concurrently, calls to start operations
(StartDocumentTextDetection, for example) raise a
LimitExceededException exception (HTTP status code: 400) until the
number of concurrently running jobs is below the Amazon Textract service
limit.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DetectDocumentText
data DetectDocumentText Source #
See: newDetectDocumentText smart constructor.
Constructors
| DetectDocumentText' Document |
Instances
newDetectDocumentText Source #
Arguments
| :: Document | |
| -> DetectDocumentText |
Create a value of DetectDocumentText with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:document:DetectDocumentText', detectDocumentText_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 or PNG 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.
data DetectDocumentTextResponse Source #
See: newDetectDocumentTextResponse smart constructor.
Constructors
| DetectDocumentTextResponse' (Maybe DocumentMetadata) (Maybe [Block]) (Maybe Text) Int |
Instances
newDetectDocumentTextResponse Source #
Create a value of DetectDocumentTextResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:documentMetadata:DetectDocumentTextResponse', detectDocumentTextResponse_documentMetadata - Metadata about the document. It contains the number of pages that are
detected in the document.
$sel:blocks:DetectDocumentTextResponse', detectDocumentTextResponse_blocks - An array of Block objects that contain the text that's detected in
the document.
$sel:detectDocumentTextModelVersion:DetectDocumentTextResponse', detectDocumentTextResponse_detectDocumentTextModelVersion -
$sel:httpStatus:DetectDocumentTextResponse', detectDocumentTextResponse_httpStatus - The response's http status code.
StartDocumentAnalysis
data StartDocumentAnalysis Source #
See: newStartDocumentAnalysis smart constructor.
Constructors
| StartDocumentAnalysis' (Maybe Text) (Maybe NotificationChannel) (Maybe Text) (Maybe OutputConfig) (Maybe Text) DocumentLocation [FeatureType] |
Instances
newStartDocumentAnalysis Source #
Create a value of StartDocumentAnalysis with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobTag:StartDocumentAnalysis', startDocumentAnalysis_jobTag - An identifier that you specify that's included in the completion
notification published to the Amazon SNS topic. For example, you can use
JobTag to identify the type of document that the completion
notification corresponds to (such as a tax form or a receipt).
$sel:notificationChannel:StartDocumentAnalysis', startDocumentAnalysis_notificationChannel - The Amazon SNS topic ARN that you want Amazon Textract to publish the
completion status of the operation to.
$sel:kmsKeyId:StartDocumentAnalysis', startDocumentAnalysis_kmsKeyId - The KMS key used to encrypt the inference results. This can be in either
Key ID or Key Alias format. When a KMS key is provided, the KMS key will
be used for server-side encryption of the objects in the customer
bucket. When this parameter is not enabled, the result will be encrypted
server side,using SSE-S3.
$sel:outputConfig:StartDocumentAnalysis', startDocumentAnalysis_outputConfig - Sets if the output will go to a customer defined bucket. By default,
Amazon Textract will save the results internally to be accessed by the
GetDocumentAnalysis operation.
$sel:clientRequestToken:StartDocumentAnalysis', startDocumentAnalysis_clientRequestToken - The idempotent token that you use to identify the start request. If you
use the same token with multiple StartDocumentAnalysis requests, the
same JobId is returned. Use ClientRequestToken to prevent the same
job from being accidentally started more than once. For more
information, see
Calling Amazon Textract Asynchronous Operations.
$sel:documentLocation:StartDocumentAnalysis', startDocumentAnalysis_documentLocation - The location of the document to be processed.
$sel:featureTypes:StartDocumentAnalysis', startDocumentAnalysis_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. To perform both types
of analysis, add TABLES and FORMS to FeatureTypes. All lines and words
detected in the document are included in the response (including text
that isn't related to the value of FeatureTypes).
data StartDocumentAnalysisResponse Source #
See: newStartDocumentAnalysisResponse smart constructor.
Constructors
| StartDocumentAnalysisResponse' (Maybe Text) Int |
Instances
newStartDocumentAnalysisResponse Source #
Create a value of StartDocumentAnalysisResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartDocumentAnalysisResponse', startDocumentAnalysisResponse_jobId - The identifier for the document text detection job. Use JobId to
identify the job in a subsequent call to GetDocumentAnalysis. A
JobId value is only valid for 7 days.
$sel:httpStatus:StartDocumentAnalysisResponse', startDocumentAnalysisResponse_httpStatus - The response's http status code.
AnalyzeDocument
data AnalyzeDocument Source #
See: newAnalyzeDocument smart constructor.
Constructors
| AnalyzeDocument' (Maybe HumanLoopConfig) Document [FeatureType] |
Instances
Arguments
| :: Document | |
| -> AnalyzeDocument |
Create a value of AnalyzeDocument with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:humanLoopConfig:AnalyzeDocument', analyzeDocument_humanLoopConfig - Sets the configuration for the human in the loop workflow for analyzing
documents.
$sel:document:AnalyzeDocument', analyzeDocument_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 or PNG 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.
$sel:featureTypes:AnalyzeDocument', analyzeDocument_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. To perform both types
of analysis, add TABLES and FORMS to FeatureTypes. All lines and words
detected in the document are included in the response (including text
that isn't related to the value of FeatureTypes).
data AnalyzeDocumentResponse Source #
See: newAnalyzeDocumentResponse smart constructor.
Constructors
| AnalyzeDocumentResponse' (Maybe DocumentMetadata) (Maybe [Block]) (Maybe HumanLoopActivationOutput) (Maybe Text) Int |
Instances
newAnalyzeDocumentResponse Source #
Create a value of AnalyzeDocumentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:documentMetadata:AnalyzeDocumentResponse', analyzeDocumentResponse_documentMetadata - Metadata about the analyzed document. An example is the number of pages.
$sel:blocks:AnalyzeDocumentResponse', analyzeDocumentResponse_blocks - The items that are detected and analyzed by AnalyzeDocument.
$sel:humanLoopActivationOutput:AnalyzeDocumentResponse', analyzeDocumentResponse_humanLoopActivationOutput - Shows the results of the human in the loop evaluation.
$sel:analyzeDocumentModelVersion:AnalyzeDocumentResponse', analyzeDocumentResponse_analyzeDocumentModelVersion - The version of the model used to analyze the document.
$sel:httpStatus:AnalyzeDocumentResponse', analyzeDocumentResponse_httpStatus - The response's http status code.
GetDocumentTextDetection
data GetDocumentTextDetection Source #
See: newGetDocumentTextDetection smart constructor.
Instances
newGetDocumentTextDetection Source #
Create a value of GetDocumentTextDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetDocumentTextDetection', getDocumentTextDetection_nextToken - If the previous response was incomplete (because there are more blocks
to retrieve), Amazon Textract returns a pagination token in the
response. You can use this pagination token to retrieve the next set of
blocks.
$sel:maxResults:GetDocumentTextDetection', getDocumentTextDetection_maxResults - The maximum number of results to return per paginated call. The largest
value you can specify is 1,000. If you specify a value greater than
1,000, a maximum of 1,000 results is returned. The default value is
1,000.
$sel:jobId:GetDocumentTextDetection', getDocumentTextDetection_jobId - A unique identifier for the text detection job. The JobId is returned
from StartDocumentTextDetection. A JobId value is only valid for 7
days.
data GetDocumentTextDetectionResponse Source #
See: newGetDocumentTextDetectionResponse smart constructor.
Constructors
| GetDocumentTextDetectionResponse' (Maybe DocumentMetadata) (Maybe [Block]) (Maybe [Warning]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe JobStatus) Int |
Instances
newGetDocumentTextDetectionResponse Source #
Create a value of GetDocumentTextDetectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:documentMetadata:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_documentMetadata - Information about a document that Amazon Textract processed.
DocumentMetadata is returned in every page of paginated responses from
an Amazon Textract video operation.
$sel:blocks:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_blocks - The results of the text-detection operation.
$sel:warnings:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_warnings - A list of warnings that occurred during the text-detection operation for
the document.
$sel:nextToken:GetDocumentTextDetection', getDocumentTextDetectionResponse_nextToken - If the response is truncated, Amazon Textract returns this token. You
can use this token in the subsequent request to retrieve the next set of
text-detection results.
$sel:statusMessage:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_statusMessage - Returns if the detection job could not be completed. Contains
explanation for what error occured.
$sel:detectDocumentTextModelVersion:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_detectDocumentTextModelVersion -
$sel:jobStatus:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_jobStatus - The current status of the text detection job.
$sel:httpStatus:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_httpStatus - The response's http status code.
AnalyzeExpense
data AnalyzeExpense Source #
See: newAnalyzeExpense smart constructor.
Constructors
| AnalyzeExpense' Document |
Instances
Arguments
| :: Document | |
| -> AnalyzeExpense |
Create a value of AnalyzeExpense with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:document:AnalyzeExpense', analyzeExpense_document - Undocumented member.
data AnalyzeExpenseResponse Source #
See: newAnalyzeExpenseResponse smart constructor.
Constructors
| AnalyzeExpenseResponse' (Maybe DocumentMetadata) (Maybe [ExpenseDocument]) Int |
Instances
newAnalyzeExpenseResponse Source #
Create a value of AnalyzeExpenseResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:documentMetadata:AnalyzeExpenseResponse', analyzeExpenseResponse_documentMetadata - Undocumented member.
$sel:expenseDocuments:AnalyzeExpenseResponse', analyzeExpenseResponse_expenseDocuments - The expenses detected by Amazon Textract.
$sel:httpStatus:AnalyzeExpenseResponse', analyzeExpenseResponse_httpStatus - The response's http status code.
StartDocumentTextDetection
data StartDocumentTextDetection Source #
See: newStartDocumentTextDetection smart constructor.
Constructors
| StartDocumentTextDetection' (Maybe Text) (Maybe NotificationChannel) (Maybe Text) (Maybe OutputConfig) (Maybe Text) DocumentLocation |
Instances
newStartDocumentTextDetection Source #
Arguments
| :: DocumentLocation | |
| -> StartDocumentTextDetection |
Create a value of StartDocumentTextDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobTag:StartDocumentTextDetection', startDocumentTextDetection_jobTag - An identifier that you specify that's included in the completion
notification published to the Amazon SNS topic. For example, you can use
JobTag to identify the type of document that the completion
notification corresponds to (such as a tax form or a receipt).
$sel:notificationChannel:StartDocumentTextDetection', startDocumentTextDetection_notificationChannel - The Amazon SNS topic ARN that you want Amazon Textract to publish the
completion status of the operation to.
$sel:kmsKeyId:StartDocumentTextDetection', startDocumentTextDetection_kmsKeyId - The KMS key used to encrypt the inference results. This can be in either
Key ID or Key Alias format. When a KMS key is provided, the KMS key will
be used for server-side encryption of the objects in the customer
bucket. When this parameter is not enabled, the result will be encrypted
server side,using SSE-S3.
$sel:outputConfig:StartDocumentTextDetection', startDocumentTextDetection_outputConfig - Sets if the output will go to a customer defined bucket. By default
Amazon Textract will save the results internally to be accessed with the
GetDocumentTextDetection operation.
$sel:clientRequestToken:StartDocumentTextDetection', startDocumentTextDetection_clientRequestToken - The idempotent token that's used to identify the start request. If you
use the same token with multiple StartDocumentTextDetection requests,
the same JobId is returned. Use ClientRequestToken to prevent the
same job from being accidentally started more than once. For more
information, see
Calling Amazon Textract Asynchronous Operations.
$sel:documentLocation:StartDocumentTextDetection', startDocumentTextDetection_documentLocation - The location of the document to be processed.
data StartDocumentTextDetectionResponse Source #
See: newStartDocumentTextDetectionResponse smart constructor.
Constructors
| StartDocumentTextDetectionResponse' (Maybe Text) Int |
Instances
newStartDocumentTextDetectionResponse Source #
Arguments
| :: Int | |
| -> StartDocumentTextDetectionResponse |
Create a value of StartDocumentTextDetectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartDocumentTextDetectionResponse', startDocumentTextDetectionResponse_jobId - The identifier of the text detection job for the document. Use JobId
to identify the job in a subsequent call to GetDocumentTextDetection.
A JobId value is only valid for 7 days.
$sel:httpStatus:StartDocumentTextDetectionResponse', startDocumentTextDetectionResponse_httpStatus - The response's http status code.
GetDocumentAnalysis
data GetDocumentAnalysis Source #
See: newGetDocumentAnalysis smart constructor.
Instances
newGetDocumentAnalysis Source #
Arguments
| :: Text | |
| -> GetDocumentAnalysis |
Create a value of GetDocumentAnalysis with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetDocumentAnalysis', getDocumentAnalysis_nextToken - If the previous response was incomplete (because there are more blocks
to retrieve), Amazon Textract returns a pagination token in the
response. You can use this pagination token to retrieve the next set of
blocks.
$sel:maxResults:GetDocumentAnalysis', getDocumentAnalysis_maxResults - The maximum number of results to return per paginated call. The largest
value that you can specify is 1,000. If you specify a value greater than
1,000, a maximum of 1,000 results is returned. The default value is
1,000.
$sel:jobId:GetDocumentAnalysis', getDocumentAnalysis_jobId - A unique identifier for the text-detection job. The JobId is returned
from StartDocumentAnalysis. A JobId value is only valid for 7 days.
data GetDocumentAnalysisResponse Source #
See: newGetDocumentAnalysisResponse smart constructor.
Constructors
| GetDocumentAnalysisResponse' (Maybe DocumentMetadata) (Maybe [Block]) (Maybe Text) (Maybe [Warning]) (Maybe Text) (Maybe Text) (Maybe JobStatus) Int |
Instances
newGetDocumentAnalysisResponse Source #
Create a value of GetDocumentAnalysisResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:documentMetadata:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_documentMetadata - Information about a document that Amazon Textract processed.
DocumentMetadata is returned in every page of paginated responses from
an Amazon Textract video operation.
$sel:blocks:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_blocks - The results of the text-analysis operation.
$sel:analyzeDocumentModelVersion:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_analyzeDocumentModelVersion -
$sel:warnings:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_warnings - A list of warnings that occurred during the document-analysis operation.
$sel:nextToken:GetDocumentAnalysis', getDocumentAnalysisResponse_nextToken - If the response is truncated, Amazon Textract returns this token. You
can use this token in the subsequent request to retrieve the next set of
text detection results.
$sel:statusMessage:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_statusMessage - Returns if the detection job could not be completed. Contains
explanation for what error occured.
$sel:jobStatus:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_jobStatus - The current status of the text detection job.
$sel:httpStatus:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_httpStatus - The response's http status code.
Types
BlockType
Constructors
| BlockType' | |
Fields | |
Bundled Patterns
| pattern BlockType_CELL :: BlockType | |
| pattern BlockType_KEY_VALUE_SET :: BlockType | |
| pattern BlockType_LINE :: BlockType | |
| pattern BlockType_PAGE :: BlockType | |
| pattern BlockType_SELECTION_ELEMENT :: BlockType | |
| pattern BlockType_TABLE :: BlockType | |
| pattern BlockType_WORD :: BlockType |
Instances
ContentClassifier
newtype ContentClassifier Source #
Constructors
| ContentClassifier' | |
Fields | |
Bundled Patterns
| pattern ContentClassifier_FreeOfAdultContent :: ContentClassifier | |
| pattern ContentClassifier_FreeOfPersonallyIdentifiableInformation :: ContentClassifier |
Instances
EntityType
newtype EntityType Source #
Constructors
| EntityType' | |
Fields | |
Bundled Patterns
| pattern EntityType_KEY :: EntityType | |
| pattern EntityType_VALUE :: EntityType |
Instances
FeatureType
newtype FeatureType Source #
Constructors
| FeatureType' | |
Fields | |
Bundled Patterns
| pattern FeatureType_FORMS :: FeatureType | |
| pattern FeatureType_TABLES :: FeatureType |
Instances
JobStatus
Constructors
| JobStatus' | |
Fields | |
Bundled Patterns
| pattern JobStatus_FAILED :: JobStatus | |
| pattern JobStatus_IN_PROGRESS :: JobStatus | |
| pattern JobStatus_PARTIAL_SUCCESS :: JobStatus | |
| pattern JobStatus_SUCCEEDED :: JobStatus |
Instances
RelationshipType
newtype RelationshipType Source #
Constructors
| RelationshipType' | |
Fields | |
Bundled Patterns
| pattern RelationshipType_CHILD :: RelationshipType | |
| pattern RelationshipType_COMPLEX_FEATURES :: RelationshipType | |
| pattern RelationshipType_VALUE :: RelationshipType |
Instances
SelectionStatus
newtype SelectionStatus Source #
Constructors
| SelectionStatus' | |
Fields | |
Bundled Patterns
| pattern SelectionStatus_NOT_SELECTED :: SelectionStatus | |
| pattern SelectionStatus_SELECTED :: SelectionStatus |
Instances
TextType
Constructors
| TextType' | |
Fields
| |
Bundled Patterns
| pattern TextType_HANDWRITING :: TextType | |
| pattern TextType_PRINTED :: TextType |
Instances
Block
A Block represents items that are recognized in a document within a
group of pixels close to each other. The information returned in a
Block object depends on the type of operation. In text detection for
documents (for example DetectDocumentText), you get information about
the detected words and lines of text. In text analysis (for example
AnalyzeDocument), you can also get information about the fields, tables,
and selection elements that are detected in the document.
An array of Block objects is returned by both synchronous and
asynchronous operations. In synchronous operations, such as
DetectDocumentText, the array of Block objects is the entire set of
results. In asynchronous operations, such as GetDocumentAnalysis, the
array is returned over one or more responses.
For more information, see How Amazon Textract Works.
See: newBlock smart constructor.
Constructors
| Block' (Maybe Natural) (Maybe Text) (Maybe [EntityType]) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe SelectionStatus) (Maybe Natural) (Maybe Double) (Maybe [Relationship]) (Maybe Geometry) (Maybe TextType) (Maybe Text) (Maybe BlockType) |
Instances
Create a value of Block with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:columnSpan:Block', block_columnSpan - The number of columns that a table cell spans. Currently this value is
always 1, even if the number of columns spanned is greater than 1.
ColumnSpan isn't returned by DetectDocumentText and
GetDocumentTextDetection.
$sel:text:Block', block_text - The word or line of text that's recognized by Amazon Textract.
$sel:entityTypes:Block', block_entityTypes - The type of entity. The following can be returned:
- KEY - An identifier for a field on the document.
- VALUE - The field text.
EntityTypes isn't returned by DetectDocumentText and
GetDocumentTextDetection.
$sel:columnIndex:Block', block_columnIndex - The column in which a table cell appears. The first column position is
1. ColumnIndex isn't returned by DetectDocumentText and
GetDocumentTextDetection.
$sel:page:Block', block_page - The page on which a block was detected. Page is returned by
asynchronous operations. Page values greater than 1 are only returned
for multipage documents that are in PDF format. A scanned image
(JPEG/PNG), even if it contains multiple document pages, is considered
to be a single-page document. The value of Page is always 1.
Synchronous operations don't return Page because every input document
is considered to be a single-page document.
$sel:rowSpan:Block', block_rowSpan - The number of rows that a table cell spans. Currently this value is
always 1, even if the number of rows spanned is greater than 1.
RowSpan isn't returned by DetectDocumentText and
GetDocumentTextDetection.
$sel:selectionStatus:Block', block_selectionStatus - The selection status of a selection element, such as an option button or
check box.
$sel:rowIndex:Block', block_rowIndex - The row in which a table cell is located. The first row position is 1.
RowIndex isn't returned by DetectDocumentText and
GetDocumentTextDetection.
$sel:confidence:Block', block_confidence - The confidence score that Amazon Textract has in the accuracy of the
recognized text and the accuracy of the geometry points around the
recognized text.
$sel:relationships:Block', block_relationships - A list of child blocks of the current block. For example, a LINE object
has child blocks for each WORD block that's part of the line of text.
There aren't Relationship objects in the list for relationships that
don't exist, such as when the current block has no child blocks. The
list size can be the following:
- 0 - The block has no child blocks.
- 1 - The block has child blocks.
$sel:geometry:Block', block_geometry - The location of the recognized text on the image. It includes an
axis-aligned, coarse bounding box that surrounds the text, and a
finer-grain polygon for more accurate spatial information.
$sel:textType:Block', block_textType - The kind of text that Amazon Textract has detected. Can check for
handwritten text and printed text.
$sel:id:Block', block_id - The identifier for the recognized text. The identifier is only unique
for a single operation.
$sel:blockType:Block', block_blockType - The type of text item that's recognized. In operations for text
detection, the following types are returned:
- PAGE - Contains a list of the LINE
Blockobjects that are detected on a document page. - WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
- LINE - A string of tab-delimited, contiguous words that are detected on a document page.
In text analysis operations, the following types are returned:
- PAGE - Contains a list of child
Blockobjects that are detected on a document page. - KEY_VALUE_SET - Stores the KEY and VALUE
Blockobjects for linked text that's detected on a document page. Use theEntityTypefield to determine if a KEY_VALUE_SET object is a KEYBlockobject or a VALUEBlockobject. - WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
- LINE - A string of tab-delimited, contiguous words that are detected on a document page.
- TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
- CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
- SELECTION_ELEMENT - A selection element such as an option button
(radio button) or a check box that's detected on a document page.
Use the value of
SelectionStatusto determine the status of the selection element.
BoundingBox
data BoundingBox Source #
The bounding box around the detected page, text, key-value pair, table,
table cell, or selection element on a document page. The left
(x-coordinate) and top (y-coordinate) are coordinates that represent
the top and left sides of the bounding box. Note that the upper-left
corner of the image is the origin (0,0).
The top and left values returned are ratios of the overall document
page size. For example, if the input image is 700 x 200 pixels, and the
top-left coordinate of the bounding box is 350 x 50 pixels, the API
returns a left value of 0.5 (350/700) and a top value of 0.25
(50/200).
The width and height values represent the dimensions of the bounding
box as a ratio of the overall document page dimension. For example, if
the document page size is 700 x 200 pixels, and the bounding box width
is 70 pixels, the width returned is 0.1.
See: newBoundingBox smart constructor.
Instances
newBoundingBox :: BoundingBox Source #
Create a value of BoundingBox with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:height:BoundingBox', boundingBox_height - The height of the bounding box as a ratio of the overall document page
height.
$sel:left:BoundingBox', boundingBox_left - The left coordinate of the bounding box as a ratio of overall document
page width.
$sel:width:BoundingBox', boundingBox_width - The width of the bounding box as a ratio of the overall document page
width.
$sel:top:BoundingBox', boundingBox_top - The top coordinate of the bounding box as a ratio of overall document
page height.
Document
The input document, either as bytes or as an S3 object.
You pass image bytes to an Amazon Textract API operation by using the
Bytes property. For example, you would use the Bytes property to
pass a document loaded from a local file system. Image bytes passed by
using the Bytes property must be base64 encoded. Your code might not
need to encode document file bytes if you're using an AWS SDK to call
Amazon Textract API operations.
You pass images stored in an S3 bucket to an Amazon Textract API
operation by using the S3Object property. Documents stored in an S3
bucket don't need to be base64 encoded.
The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations.
If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property.
For Amazon Textract to process an S3 object, the user must have permission to access the S3 object.
See: newDocument smart constructor.
Instances
| Eq Document Source # | |
| Read Document Source # | |
| Show Document Source # | |
| Generic Document Source # | |
| NFData Document Source # | |
Defined in Amazonka.Textract.Types.Document | |
| Hashable Document Source # | |
Defined in Amazonka.Textract.Types.Document | |
| ToJSON Document Source # | |
Defined in Amazonka.Textract.Types.Document | |
| type Rep Document Source # | |
Defined in Amazonka.Textract.Types.Document type Rep Document = D1 ('MetaData "Document" "Amazonka.Textract.Types.Document" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "Document'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3Object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Object)) :*: S1 ('MetaSel ('Just "bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)))) | |
newDocument :: Document Source #
Create a value of Document with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Object:Document', document_s3Object - Identifies an S3 object as the document source. The maximum size of a
document that's stored in an S3 bucket is 5 MB.
$sel:bytes:Document', document_bytes - A blob of base64-encoded document bytes. The maximum size of a document
that's provided in a blob of bytes is 5 MB. The document bytes must be
in PNG or JPEG format.
If you're using an AWS SDK to call Amazon Textract, you might not need
to base64-encode image bytes passed using the Bytes field.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
DocumentLocation
data DocumentLocation Source #
The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations such as StartDocumentTextDetection.
The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.
See: newDocumentLocation smart constructor.
Constructors
| DocumentLocation' (Maybe S3Object) |
Instances
newDocumentLocation :: DocumentLocation Source #
Create a value of DocumentLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Object:DocumentLocation', documentLocation_s3Object - The Amazon S3 bucket that contains the input document.
DocumentMetadata
data DocumentMetadata Source #
Information about the input document.
See: newDocumentMetadata smart constructor.
Constructors
| DocumentMetadata' (Maybe Natural) |
Instances
newDocumentMetadata :: DocumentMetadata Source #
Create a value of DocumentMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pages:DocumentMetadata', documentMetadata_pages - The number of pages that are detected in the document.
ExpenseDetection
data ExpenseDetection Source #
An object used to store information about the Value or Label detected by Amazon Textract.
See: newExpenseDetection smart constructor.
Instances
newExpenseDetection :: ExpenseDetection Source #
Create a value of ExpenseDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:ExpenseDetection', expenseDetection_text - The word or line of text recognized by Amazon Textract
$sel:confidence:ExpenseDetection', expenseDetection_confidence - The confidence in detection, as a percentage
$sel:geometry:ExpenseDetection', expenseDetection_geometry - Undocumented member.
ExpenseDocument
data ExpenseDocument Source #
The structure holding all the information returned by AnalyzeExpense
See: newExpenseDocument smart constructor.
Constructors
| ExpenseDocument' (Maybe [LineItemGroup]) (Maybe [ExpenseField]) (Maybe Natural) |
Instances
newExpenseDocument :: ExpenseDocument Source #
Create a value of ExpenseDocument with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lineItemGroups:ExpenseDocument', expenseDocument_lineItemGroups - Information detected on each table of a document, seperated into
LineItems.
$sel:summaryFields:ExpenseDocument', expenseDocument_summaryFields - Any information found outside of a table by Amazon Textract.
$sel:expenseIndex:ExpenseDocument', expenseDocument_expenseIndex - Denotes which invoice or receipt in the document the information is
coming from. First document will be 1, the second 2, and so on.
ExpenseField
data ExpenseField Source #
Breakdown of detected information, seperated into the catagories Type, LableDetection, and ValueDetection
See: newExpenseField smart constructor.
Constructors
| ExpenseField' (Maybe ExpenseDetection) (Maybe ExpenseDetection) (Maybe ExpenseType) (Maybe Natural) |
Instances
newExpenseField :: ExpenseField Source #
Create a value of ExpenseField with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:labelDetection:ExpenseField', expenseField_labelDetection - The explicitly stated label of a detected element.
$sel:valueDetection:ExpenseField', expenseField_valueDetection - The value of a detected element. Present in explicit and implicit
elements.
$sel:type':ExpenseField', expenseField_type - The implied label of a detected element. Present alongside
LabelDetection for explicit elements.
$sel:pageNumber:ExpenseField', expenseField_pageNumber - The page number the value was detected on.
ExpenseType
data ExpenseType Source #
An object used to store information about the Type detected by Amazon Textract.
See: newExpenseType smart constructor.
Constructors
| ExpenseType' (Maybe Text) (Maybe Double) |
Instances
newExpenseType :: ExpenseType Source #
Create a value of ExpenseType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:ExpenseType', expenseType_text - The word or line of text detected by Amazon Textract.
$sel:confidence:ExpenseType', expenseType_confidence - The confidence of accuracy, as a percentage.
Geometry
Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
See: newGeometry smart constructor.
Constructors
| Geometry' (Maybe BoundingBox) (Maybe [Point]) |
Instances
| Eq Geometry Source # | |
| Read Geometry Source # | |
| Show Geometry Source # | |
| Generic Geometry Source # | |
| NFData Geometry Source # | |
Defined in Amazonka.Textract.Types.Geometry | |
| Hashable Geometry Source # | |
Defined in Amazonka.Textract.Types.Geometry | |
| FromJSON Geometry Source # | |
| type Rep Geometry Source # | |
Defined in Amazonka.Textract.Types.Geometry type Rep Geometry = D1 ('MetaData "Geometry" "Amazonka.Textract.Types.Geometry" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "Geometry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "boundingBox") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BoundingBox)) :*: S1 ('MetaSel ('Just "polygon") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Point])))) | |
newGeometry :: Geometry Source #
Create a value of Geometry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:boundingBox:Geometry', geometry_boundingBox - An axis-aligned coarse representation of the location of the recognized
item on the document page.
$sel:polygon:Geometry', geometry_polygon - Within the bounding box, a fine-grained polygon around the recognized
item.
HumanLoopActivationOutput
data HumanLoopActivationOutput Source #
Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did not trigger human review.
See: newHumanLoopActivationOutput smart constructor.
Instances
newHumanLoopActivationOutput :: HumanLoopActivationOutput Source #
Create a value of HumanLoopActivationOutput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:humanLoopActivationReasons:HumanLoopActivationOutput', humanLoopActivationOutput_humanLoopActivationReasons - Shows if and why human review was needed.
$sel:humanLoopArn:HumanLoopActivationOutput', humanLoopActivationOutput_humanLoopArn - The Amazon Resource Name (ARN) of the HumanLoop created.
$sel:humanLoopActivationConditionsEvaluationResults:HumanLoopActivationOutput', humanLoopActivationOutput_humanLoopActivationConditionsEvaluationResults - Shows the result of condition evaluations, including those conditions
which activated a human review.
HumanLoopConfig
data HumanLoopConfig Source #
Sets up the human review workflow the document will be sent to if one of the conditions is met. You can also set certain attributes of the image before review.
See: newHumanLoopConfig smart constructor.
Constructors
| HumanLoopConfig' (Maybe HumanLoopDataAttributes) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> HumanLoopConfig |
Create a value of HumanLoopConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataAttributes:HumanLoopConfig', humanLoopConfig_dataAttributes - Sets attributes of the input data.
$sel:humanLoopName:HumanLoopConfig', humanLoopConfig_humanLoopName - The name of the human workflow used for this image. This should be kept
unique within a region.
$sel:flowDefinitionArn:HumanLoopConfig', humanLoopConfig_flowDefinitionArn - The Amazon Resource Name (ARN) of the flow definition.
HumanLoopDataAttributes
data HumanLoopDataAttributes Source #
Allows you to set attributes of the image. Currently, you can declare an image as free of personally identifiable information and adult content.
See: newHumanLoopDataAttributes smart constructor.
Constructors
| HumanLoopDataAttributes' (Maybe [ContentClassifier]) |
Instances
newHumanLoopDataAttributes :: HumanLoopDataAttributes Source #
Create a value of HumanLoopDataAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentClassifiers:HumanLoopDataAttributes', humanLoopDataAttributes_contentClassifiers - Sets whether the input image is free of personally identifiable
information or adult content.
LineItemFields
data LineItemFields Source #
A structure that holds information about the different lines found in a document's tables.
See: newLineItemFields smart constructor.
Constructors
| LineItemFields' (Maybe [ExpenseField]) |
Instances
newLineItemFields :: LineItemFields Source #
Create a value of LineItemFields with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lineItemExpenseFields:LineItemFields', lineItemFields_lineItemExpenseFields - ExpenseFields used to show information from detected lines on a table.
LineItemGroup
data LineItemGroup Source #
A grouping of tables which contain LineItems, with each table identified
by the table's LineItemGroupIndex.
See: newLineItemGroup smart constructor.
Constructors
| LineItemGroup' (Maybe [LineItemFields]) (Maybe Natural) |
Instances
newLineItemGroup :: LineItemGroup Source #
Create a value of LineItemGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lineItems:LineItemGroup', lineItemGroup_lineItems - The breakdown of information on a particular line of a table.
$sel:lineItemGroupIndex:LineItemGroup', lineItemGroup_lineItemGroupIndex - The number used to identify a specific table in a document. The first
table encountered will have a LineItemGroupIndex of 1, the second 2,
etc.
NotificationChannel
data NotificationChannel Source #
The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation, such as StartDocumentTextDetection.
See: newNotificationChannel smart constructor.
Constructors
| NotificationChannel' Text Text |
Instances
newNotificationChannel Source #
Arguments
| :: Text | |
| -> Text | |
| -> NotificationChannel |
Create a value of NotificationChannel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sNSTopicArn:NotificationChannel', notificationChannel_sNSTopicArn - The Amazon SNS topic that Amazon Textract posts the completion status
to.
$sel:roleArn:NotificationChannel', notificationChannel_roleArn - The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract
publishing permissions to the Amazon SNS topic.
OutputConfig
data OutputConfig Source #
Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.
OutputConfig is an optional parameter which lets you adjust where your
output will be placed. By default, Amazon Textract will store the
results internally and can only be accessed by the Get API operations.
With OutputConfig enabled, you can set the name of the bucket the output
will be sent to and the file prefix of the results where you can
download your results. Additionally, you can set the KMSKeyID
parameter to a customer master key (CMK) to encrypt your output. Without
this parameter set Amazon Textract will encrypt server-side using the
AWS managed CMK for Amazon S3.
Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.
For more information on data privacy, see the Data Privacy FAQ.
See: newOutputConfig smart constructor.
Constructors
| OutputConfig' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> OutputConfig |
Create a value of OutputConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Prefix:OutputConfig', outputConfig_s3Prefix - The prefix of the object key that the output will be saved to. When not
enabled, the prefix will be “textract_output".
$sel:s3Bucket:OutputConfig', outputConfig_s3Bucket - The name of the bucket your output will go to.
Point
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point objects, Polygon, is returned by
DetectDocumentText. Polygon represents a fine-grained polygon around
detected text. For more information, see Geometry in the Amazon Textract
Developer Guide.
See: newPoint smart constructor.
Instances
| Eq Point Source # | |
| Read Point Source # | |
| Show Point Source # | |
| Generic Point Source # | |
| NFData Point Source # | |
Defined in Amazonka.Textract.Types.Point | |
| Hashable Point Source # | |
Defined in Amazonka.Textract.Types.Point | |
| FromJSON Point Source # | |
| type Rep Point Source # | |
Defined in Amazonka.Textract.Types.Point type Rep Point = D1 ('MetaData "Point" "Amazonka.Textract.Types.Point" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "Point'" 'PrefixI 'True) (S1 ('MetaSel ('Just "x") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "y") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) | |
Create a value of Point with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:x:Point', point_x - The value of the X coordinate for a point on a Polygon.
$sel:y:Point', point_y - The value of the Y coordinate for a point on a Polygon.
Relationship
data Relationship Source #
Information about how blocks are related to each other. A Block object
contains 0 or more Relation objects in a list, Relationships. For
more information, see Block.
The Type element provides the type of the relationship for all blocks
in the IDs array.
See: newRelationship smart constructor.
Constructors
| Relationship' (Maybe [Text]) (Maybe RelationshipType) |
Instances
newRelationship :: Relationship Source #
Create a value of Relationship with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ids:Relationship', relationship_ids - An array of IDs for related blocks. You can get the type of the
relationship from the Type element.
$sel:type':Relationship', relationship_type - The type of relationship that the blocks in the IDs array have with the
current block. The relationship can be VALUE or CHILD. A
relationship of type VALUE is a list that contains the ID of the VALUE
block that's associated with the KEY of a key-value pair. A
relationship of type CHILD is a list of IDs that identify WORD blocks in
the case of lines Cell blocks in the case of Tables, and WORD blocks in
the case of Selection Elements.
S3Object
The S3 bucket name and file name that identifies the document.
The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations.
For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket and file.
See: newS3Object smart constructor.
Instances
| Eq S3Object Source # | |
| Read S3Object Source # | |
| Show S3Object Source # | |
| Generic S3Object Source # | |
| NFData S3Object Source # | |
Defined in Amazonka.Textract.Types.S3Object | |
| Hashable S3Object Source # | |
Defined in Amazonka.Textract.Types.S3Object | |
| ToJSON S3Object Source # | |
Defined in Amazonka.Textract.Types.S3Object | |
| type Rep S3Object Source # | |
Defined in Amazonka.Textract.Types.S3Object type Rep S3Object = D1 ('MetaData "S3Object" "Amazonka.Textract.Types.S3Object" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "S3Object'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newS3Object :: S3Object Source #
Create a value of S3Object with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucket:S3Object', s3Object_bucket - The name of the S3 bucket. Note that the # character is not valid in the
file name.
$sel:name:S3Object', s3Object_name - The file name of the input document. Synchronous operations can use
image files that are in JPEG or PNG format. Asynchronous operations also
support PDF format files.
$sel:version:S3Object', s3Object_version - If the bucket has versioning enabled, you can specify the object
version.
Warning
A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or asynchronous document text detection (StartDocumentTextDetection).
See: newWarning smart constructor.
Instances
| Eq Warning Source # | |
| Read Warning Source # | |
| Show Warning Source # | |
| Generic Warning Source # | |
| NFData Warning Source # | |
Defined in Amazonka.Textract.Types.Warning | |
| Hashable Warning Source # | |
Defined in Amazonka.Textract.Types.Warning | |
| FromJSON Warning Source # | |
| type Rep Warning Source # | |
Defined in Amazonka.Textract.Types.Warning type Rep Warning = D1 ('MetaData "Warning" "Amazonka.Textract.Types.Warning" "libZSservicesZSamazonka-textractZSamazonka-textract" 'False) (C1 ('MetaCons "Warning'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Natural])) :*: S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newWarning :: Warning Source #
Create a value of Warning with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pages:Warning', warning_pages - A list of the pages that the warning applies to.
$sel:errorCode:Warning', warning_errorCode - The error code for the warning.