Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Operations
- Types
- AnalyzeIDDetections
- Block
- BoundingBox
- DetectedSignature
- Document
- DocumentGroup
- DocumentLocation
- DocumentMetadata
- ExpenseCurrency
- ExpenseDetection
- ExpenseDocument
- ExpenseField
- ExpenseGroupProperty
- ExpenseType
- Extraction
- Geometry
- HumanLoopActivationOutput
- HumanLoopConfig
- HumanLoopDataAttributes
- IdentityDocument
- IdentityDocumentField
- LendingDetection
- LendingDocument
- LendingField
- LendingResult
- LendingSummary
- LineItemFields
- LineItemGroup
- NormalizedValue
- NotificationChannel
- OutputConfig
- PageClassification
- Point
- Prediction
- QueriesConfig
- Query
- Relationship
- S3Object
- SignatureDetection
- SplitDocument
- UndetectedSignature
- Warning
Synopsis
- analyzeDocument_humanLoopConfig :: Lens' AnalyzeDocument (Maybe HumanLoopConfig)
- analyzeDocument_queriesConfig :: Lens' AnalyzeDocument (Maybe QueriesConfig)
- analyzeDocument_document :: Lens' AnalyzeDocument Document
- analyzeDocument_featureTypes :: Lens' AnalyzeDocument [FeatureType]
- analyzeDocumentResponse_analyzeDocumentModelVersion :: Lens' AnalyzeDocumentResponse (Maybe Text)
- analyzeDocumentResponse_blocks :: Lens' AnalyzeDocumentResponse (Maybe [Block])
- analyzeDocumentResponse_documentMetadata :: Lens' AnalyzeDocumentResponse (Maybe DocumentMetadata)
- analyzeDocumentResponse_humanLoopActivationOutput :: Lens' AnalyzeDocumentResponse (Maybe HumanLoopActivationOutput)
- analyzeDocumentResponse_httpStatus :: Lens' AnalyzeDocumentResponse Int
- analyzeExpense_document :: Lens' AnalyzeExpense Document
- analyzeExpenseResponse_documentMetadata :: Lens' AnalyzeExpenseResponse (Maybe DocumentMetadata)
- analyzeExpenseResponse_expenseDocuments :: Lens' AnalyzeExpenseResponse (Maybe [ExpenseDocument])
- analyzeExpenseResponse_httpStatus :: Lens' AnalyzeExpenseResponse Int
- analyzeID_documentPages :: Lens' AnalyzeID (NonEmpty Document)
- analyzeIDResponse_analyzeIDModelVersion :: Lens' AnalyzeIDResponse (Maybe Text)
- analyzeIDResponse_documentMetadata :: Lens' AnalyzeIDResponse (Maybe DocumentMetadata)
- analyzeIDResponse_identityDocuments :: Lens' AnalyzeIDResponse (Maybe [IdentityDocument])
- analyzeIDResponse_httpStatus :: Lens' AnalyzeIDResponse Int
- detectDocumentText_document :: Lens' DetectDocumentText Document
- detectDocumentTextResponse_blocks :: Lens' DetectDocumentTextResponse (Maybe [Block])
- detectDocumentTextResponse_detectDocumentTextModelVersion :: Lens' DetectDocumentTextResponse (Maybe Text)
- detectDocumentTextResponse_documentMetadata :: Lens' DetectDocumentTextResponse (Maybe DocumentMetadata)
- detectDocumentTextResponse_httpStatus :: Lens' DetectDocumentTextResponse Int
- getDocumentAnalysis_maxResults :: Lens' GetDocumentAnalysis (Maybe Natural)
- getDocumentAnalysis_nextToken :: Lens' GetDocumentAnalysis (Maybe Text)
- getDocumentAnalysis_jobId :: Lens' GetDocumentAnalysis Text
- getDocumentAnalysisResponse_analyzeDocumentModelVersion :: Lens' GetDocumentAnalysisResponse (Maybe Text)
- getDocumentAnalysisResponse_blocks :: Lens' GetDocumentAnalysisResponse (Maybe [Block])
- getDocumentAnalysisResponse_documentMetadata :: Lens' GetDocumentAnalysisResponse (Maybe DocumentMetadata)
- getDocumentAnalysisResponse_jobStatus :: Lens' GetDocumentAnalysisResponse (Maybe JobStatus)
- getDocumentAnalysisResponse_nextToken :: Lens' GetDocumentAnalysisResponse (Maybe Text)
- getDocumentAnalysisResponse_statusMessage :: Lens' GetDocumentAnalysisResponse (Maybe Text)
- getDocumentAnalysisResponse_warnings :: Lens' GetDocumentAnalysisResponse (Maybe [Warning])
- getDocumentAnalysisResponse_httpStatus :: Lens' GetDocumentAnalysisResponse Int
- getDocumentTextDetection_maxResults :: Lens' GetDocumentTextDetection (Maybe Natural)
- getDocumentTextDetection_nextToken :: Lens' GetDocumentTextDetection (Maybe Text)
- getDocumentTextDetection_jobId :: Lens' GetDocumentTextDetection Text
- getDocumentTextDetectionResponse_blocks :: Lens' GetDocumentTextDetectionResponse (Maybe [Block])
- getDocumentTextDetectionResponse_detectDocumentTextModelVersion :: Lens' GetDocumentTextDetectionResponse (Maybe Text)
- getDocumentTextDetectionResponse_documentMetadata :: Lens' GetDocumentTextDetectionResponse (Maybe DocumentMetadata)
- getDocumentTextDetectionResponse_jobStatus :: Lens' GetDocumentTextDetectionResponse (Maybe JobStatus)
- getDocumentTextDetectionResponse_nextToken :: Lens' GetDocumentTextDetectionResponse (Maybe Text)
- getDocumentTextDetectionResponse_statusMessage :: Lens' GetDocumentTextDetectionResponse (Maybe Text)
- getDocumentTextDetectionResponse_warnings :: Lens' GetDocumentTextDetectionResponse (Maybe [Warning])
- getDocumentTextDetectionResponse_httpStatus :: Lens' GetDocumentTextDetectionResponse Int
- getExpenseAnalysis_maxResults :: Lens' GetExpenseAnalysis (Maybe Natural)
- getExpenseAnalysis_nextToken :: Lens' GetExpenseAnalysis (Maybe Text)
- getExpenseAnalysis_jobId :: Lens' GetExpenseAnalysis Text
- getExpenseAnalysisResponse_analyzeExpenseModelVersion :: Lens' GetExpenseAnalysisResponse (Maybe Text)
- getExpenseAnalysisResponse_documentMetadata :: Lens' GetExpenseAnalysisResponse (Maybe DocumentMetadata)
- getExpenseAnalysisResponse_expenseDocuments :: Lens' GetExpenseAnalysisResponse (Maybe [ExpenseDocument])
- getExpenseAnalysisResponse_jobStatus :: Lens' GetExpenseAnalysisResponse (Maybe JobStatus)
- getExpenseAnalysisResponse_nextToken :: Lens' GetExpenseAnalysisResponse (Maybe Text)
- getExpenseAnalysisResponse_statusMessage :: Lens' GetExpenseAnalysisResponse (Maybe Text)
- getExpenseAnalysisResponse_warnings :: Lens' GetExpenseAnalysisResponse (Maybe [Warning])
- getExpenseAnalysisResponse_httpStatus :: Lens' GetExpenseAnalysisResponse Int
- getLendingAnalysis_maxResults :: Lens' GetLendingAnalysis (Maybe Natural)
- getLendingAnalysis_nextToken :: Lens' GetLendingAnalysis (Maybe Text)
- getLendingAnalysis_jobId :: Lens' GetLendingAnalysis Text
- getLendingAnalysisResponse_analyzeLendingModelVersion :: Lens' GetLendingAnalysisResponse (Maybe Text)
- getLendingAnalysisResponse_documentMetadata :: Lens' GetLendingAnalysisResponse (Maybe DocumentMetadata)
- getLendingAnalysisResponse_jobStatus :: Lens' GetLendingAnalysisResponse (Maybe JobStatus)
- getLendingAnalysisResponse_nextToken :: Lens' GetLendingAnalysisResponse (Maybe Text)
- getLendingAnalysisResponse_results :: Lens' GetLendingAnalysisResponse (Maybe [LendingResult])
- getLendingAnalysisResponse_statusMessage :: Lens' GetLendingAnalysisResponse (Maybe Text)
- getLendingAnalysisResponse_warnings :: Lens' GetLendingAnalysisResponse (Maybe [Warning])
- getLendingAnalysisResponse_httpStatus :: Lens' GetLendingAnalysisResponse Int
- getLendingAnalysisSummary_jobId :: Lens' GetLendingAnalysisSummary Text
- getLendingAnalysisSummaryResponse_analyzeLendingModelVersion :: Lens' GetLendingAnalysisSummaryResponse (Maybe Text)
- getLendingAnalysisSummaryResponse_documentMetadata :: Lens' GetLendingAnalysisSummaryResponse (Maybe DocumentMetadata)
- getLendingAnalysisSummaryResponse_jobStatus :: Lens' GetLendingAnalysisSummaryResponse (Maybe JobStatus)
- getLendingAnalysisSummaryResponse_statusMessage :: Lens' GetLendingAnalysisSummaryResponse (Maybe Text)
- getLendingAnalysisSummaryResponse_summary :: Lens' GetLendingAnalysisSummaryResponse (Maybe LendingSummary)
- getLendingAnalysisSummaryResponse_warnings :: Lens' GetLendingAnalysisSummaryResponse (Maybe [Warning])
- getLendingAnalysisSummaryResponse_httpStatus :: Lens' GetLendingAnalysisSummaryResponse Int
- startDocumentAnalysis_clientRequestToken :: Lens' StartDocumentAnalysis (Maybe Text)
- startDocumentAnalysis_jobTag :: Lens' StartDocumentAnalysis (Maybe Text)
- startDocumentAnalysis_kmsKeyId :: Lens' StartDocumentAnalysis (Maybe Text)
- startDocumentAnalysis_notificationChannel :: Lens' StartDocumentAnalysis (Maybe NotificationChannel)
- startDocumentAnalysis_outputConfig :: Lens' StartDocumentAnalysis (Maybe OutputConfig)
- startDocumentAnalysis_queriesConfig :: Lens' StartDocumentAnalysis (Maybe QueriesConfig)
- startDocumentAnalysis_documentLocation :: Lens' StartDocumentAnalysis DocumentLocation
- startDocumentAnalysis_featureTypes :: Lens' StartDocumentAnalysis [FeatureType]
- startDocumentAnalysisResponse_jobId :: Lens' StartDocumentAnalysisResponse (Maybe Text)
- startDocumentAnalysisResponse_httpStatus :: Lens' StartDocumentAnalysisResponse Int
- startDocumentTextDetection_clientRequestToken :: Lens' StartDocumentTextDetection (Maybe Text)
- startDocumentTextDetection_jobTag :: Lens' StartDocumentTextDetection (Maybe Text)
- startDocumentTextDetection_kmsKeyId :: Lens' StartDocumentTextDetection (Maybe Text)
- startDocumentTextDetection_notificationChannel :: Lens' StartDocumentTextDetection (Maybe NotificationChannel)
- startDocumentTextDetection_outputConfig :: Lens' StartDocumentTextDetection (Maybe OutputConfig)
- startDocumentTextDetection_documentLocation :: Lens' StartDocumentTextDetection DocumentLocation
- startDocumentTextDetectionResponse_jobId :: Lens' StartDocumentTextDetectionResponse (Maybe Text)
- startDocumentTextDetectionResponse_httpStatus :: Lens' StartDocumentTextDetectionResponse Int
- startExpenseAnalysis_clientRequestToken :: Lens' StartExpenseAnalysis (Maybe Text)
- startExpenseAnalysis_jobTag :: Lens' StartExpenseAnalysis (Maybe Text)
- startExpenseAnalysis_kmsKeyId :: Lens' StartExpenseAnalysis (Maybe Text)
- startExpenseAnalysis_notificationChannel :: Lens' StartExpenseAnalysis (Maybe NotificationChannel)
- startExpenseAnalysis_outputConfig :: Lens' StartExpenseAnalysis (Maybe OutputConfig)
- startExpenseAnalysis_documentLocation :: Lens' StartExpenseAnalysis DocumentLocation
- startExpenseAnalysisResponse_jobId :: Lens' StartExpenseAnalysisResponse (Maybe Text)
- startExpenseAnalysisResponse_httpStatus :: Lens' StartExpenseAnalysisResponse Int
- startLendingAnalysis_clientRequestToken :: Lens' StartLendingAnalysis (Maybe Text)
- startLendingAnalysis_jobTag :: Lens' StartLendingAnalysis (Maybe Text)
- startLendingAnalysis_kmsKeyId :: Lens' StartLendingAnalysis (Maybe Text)
- startLendingAnalysis_notificationChannel :: Lens' StartLendingAnalysis (Maybe NotificationChannel)
- startLendingAnalysis_outputConfig :: Lens' StartLendingAnalysis (Maybe OutputConfig)
- startLendingAnalysis_documentLocation :: Lens' StartLendingAnalysis DocumentLocation
- startLendingAnalysisResponse_jobId :: Lens' StartLendingAnalysisResponse (Maybe Text)
- startLendingAnalysisResponse_httpStatus :: Lens' StartLendingAnalysisResponse Int
- analyzeIDDetections_confidence :: Lens' AnalyzeIDDetections (Maybe Double)
- analyzeIDDetections_normalizedValue :: Lens' AnalyzeIDDetections (Maybe NormalizedValue)
- analyzeIDDetections_text :: Lens' AnalyzeIDDetections Text
- block_blockType :: Lens' Block (Maybe BlockType)
- block_columnIndex :: Lens' Block (Maybe Natural)
- block_columnSpan :: Lens' Block (Maybe Natural)
- block_confidence :: Lens' Block (Maybe Double)
- block_entityTypes :: Lens' Block (Maybe [EntityType])
- block_geometry :: Lens' Block (Maybe Geometry)
- block_id :: Lens' Block (Maybe Text)
- block_page :: Lens' Block (Maybe Natural)
- block_query :: Lens' Block (Maybe Query)
- block_relationships :: Lens' Block (Maybe [Relationship])
- block_rowIndex :: Lens' Block (Maybe Natural)
- block_rowSpan :: Lens' Block (Maybe Natural)
- block_selectionStatus :: Lens' Block (Maybe SelectionStatus)
- block_text :: Lens' Block (Maybe Text)
- block_textType :: Lens' Block (Maybe TextType)
- boundingBox_height :: Lens' BoundingBox (Maybe Double)
- boundingBox_left :: Lens' BoundingBox (Maybe Double)
- boundingBox_top :: Lens' BoundingBox (Maybe Double)
- boundingBox_width :: Lens' BoundingBox (Maybe Double)
- detectedSignature_page :: Lens' DetectedSignature (Maybe Natural)
- document_bytes :: Lens' Document (Maybe ByteString)
- document_s3Object :: Lens' Document (Maybe S3Object)
- documentGroup_detectedSignatures :: Lens' DocumentGroup (Maybe [DetectedSignature])
- documentGroup_splitDocuments :: Lens' DocumentGroup (Maybe [SplitDocument])
- documentGroup_type :: Lens' DocumentGroup (Maybe Text)
- documentGroup_undetectedSignatures :: Lens' DocumentGroup (Maybe [UndetectedSignature])
- documentLocation_s3Object :: Lens' DocumentLocation (Maybe S3Object)
- documentMetadata_pages :: Lens' DocumentMetadata (Maybe Natural)
- expenseCurrency_code :: Lens' ExpenseCurrency (Maybe Text)
- expenseCurrency_confidence :: Lens' ExpenseCurrency (Maybe Double)
- expenseDetection_confidence :: Lens' ExpenseDetection (Maybe Double)
- expenseDetection_geometry :: Lens' ExpenseDetection (Maybe Geometry)
- expenseDetection_text :: Lens' ExpenseDetection (Maybe Text)
- expenseDocument_blocks :: Lens' ExpenseDocument (Maybe [Block])
- expenseDocument_expenseIndex :: Lens' ExpenseDocument (Maybe Natural)
- expenseDocument_lineItemGroups :: Lens' ExpenseDocument (Maybe [LineItemGroup])
- expenseDocument_summaryFields :: Lens' ExpenseDocument (Maybe [ExpenseField])
- expenseField_currency :: Lens' ExpenseField (Maybe ExpenseCurrency)
- expenseField_groupProperties :: Lens' ExpenseField (Maybe [ExpenseGroupProperty])
- expenseField_labelDetection :: Lens' ExpenseField (Maybe ExpenseDetection)
- expenseField_pageNumber :: Lens' ExpenseField (Maybe Natural)
- expenseField_type :: Lens' ExpenseField (Maybe ExpenseType)
- expenseField_valueDetection :: Lens' ExpenseField (Maybe ExpenseDetection)
- expenseGroupProperty_id :: Lens' ExpenseGroupProperty (Maybe Text)
- expenseGroupProperty_types :: Lens' ExpenseGroupProperty (Maybe [Text])
- expenseType_confidence :: Lens' ExpenseType (Maybe Double)
- expenseType_text :: Lens' ExpenseType (Maybe Text)
- extraction_expenseDocument :: Lens' Extraction (Maybe ExpenseDocument)
- extraction_identityDocument :: Lens' Extraction (Maybe IdentityDocument)
- extraction_lendingDocument :: Lens' Extraction (Maybe LendingDocument)
- geometry_boundingBox :: Lens' Geometry (Maybe BoundingBox)
- geometry_polygon :: Lens' Geometry (Maybe [Point])
- humanLoopActivationOutput_humanLoopActivationConditionsEvaluationResults :: Lens' HumanLoopActivationOutput (Maybe Text)
- humanLoopActivationOutput_humanLoopActivationReasons :: Lens' HumanLoopActivationOutput (Maybe (NonEmpty Text))
- humanLoopActivationOutput_humanLoopArn :: Lens' HumanLoopActivationOutput (Maybe Text)
- humanLoopConfig_dataAttributes :: Lens' HumanLoopConfig (Maybe HumanLoopDataAttributes)
- humanLoopConfig_humanLoopName :: Lens' HumanLoopConfig Text
- humanLoopConfig_flowDefinitionArn :: Lens' HumanLoopConfig Text
- humanLoopDataAttributes_contentClassifiers :: Lens' HumanLoopDataAttributes (Maybe [ContentClassifier])
- identityDocument_blocks :: Lens' IdentityDocument (Maybe [Block])
- identityDocument_documentIndex :: Lens' IdentityDocument (Maybe Natural)
- identityDocument_identityDocumentFields :: Lens' IdentityDocument (Maybe [IdentityDocumentField])
- identityDocumentField_type :: Lens' IdentityDocumentField (Maybe AnalyzeIDDetections)
- identityDocumentField_valueDetection :: Lens' IdentityDocumentField (Maybe AnalyzeIDDetections)
- lendingDetection_confidence :: Lens' LendingDetection (Maybe Double)
- lendingDetection_geometry :: Lens' LendingDetection (Maybe Geometry)
- lendingDetection_selectionStatus :: Lens' LendingDetection (Maybe SelectionStatus)
- lendingDetection_text :: Lens' LendingDetection (Maybe Text)
- lendingDocument_lendingFields :: Lens' LendingDocument (Maybe [LendingField])
- lendingDocument_signatureDetections :: Lens' LendingDocument (Maybe [SignatureDetection])
- lendingField_keyDetection :: Lens' LendingField (Maybe LendingDetection)
- lendingField_type :: Lens' LendingField (Maybe Text)
- lendingField_valueDetections :: Lens' LendingField (Maybe [LendingDetection])
- lendingResult_extractions :: Lens' LendingResult (Maybe [Extraction])
- lendingResult_page :: Lens' LendingResult (Maybe Natural)
- lendingResult_pageClassification :: Lens' LendingResult (Maybe PageClassification)
- lendingSummary_documentGroups :: Lens' LendingSummary (Maybe [DocumentGroup])
- lendingSummary_undetectedDocumentTypes :: Lens' LendingSummary (Maybe [Text])
- lineItemFields_lineItemExpenseFields :: Lens' LineItemFields (Maybe [ExpenseField])
- lineItemGroup_lineItemGroupIndex :: Lens' LineItemGroup (Maybe Natural)
- lineItemGroup_lineItems :: Lens' LineItemGroup (Maybe [LineItemFields])
- normalizedValue_value :: Lens' NormalizedValue (Maybe Text)
- normalizedValue_valueType :: Lens' NormalizedValue (Maybe ValueType)
- notificationChannel_sNSTopicArn :: Lens' NotificationChannel Text
- notificationChannel_roleArn :: Lens' NotificationChannel Text
- outputConfig_s3Prefix :: Lens' OutputConfig (Maybe Text)
- outputConfig_s3Bucket :: Lens' OutputConfig Text
- pageClassification_pageType :: Lens' PageClassification [Prediction]
- pageClassification_pageNumber :: Lens' PageClassification [Prediction]
- point_x :: Lens' Point (Maybe Double)
- point_y :: Lens' Point (Maybe Double)
- prediction_confidence :: Lens' Prediction (Maybe Double)
- prediction_value :: Lens' Prediction (Maybe Text)
- queriesConfig_queries :: Lens' QueriesConfig (NonEmpty Query)
- query_alias :: Lens' Query (Maybe Text)
- query_pages :: Lens' Query (Maybe (NonEmpty Text))
- query_text :: Lens' Query Text
- relationship_ids :: Lens' Relationship (Maybe [Text])
- relationship_type :: Lens' Relationship (Maybe RelationshipType)
- s3Object_bucket :: Lens' S3Object (Maybe Text)
- s3Object_name :: Lens' S3Object (Maybe Text)
- s3Object_version :: Lens' S3Object (Maybe Text)
- signatureDetection_confidence :: Lens' SignatureDetection (Maybe Double)
- signatureDetection_geometry :: Lens' SignatureDetection (Maybe Geometry)
- splitDocument_index :: Lens' SplitDocument (Maybe Natural)
- splitDocument_pages :: Lens' SplitDocument (Maybe [Natural])
- undetectedSignature_page :: Lens' UndetectedSignature (Maybe Natural)
- warning_errorCode :: Lens' Warning (Maybe Text)
- warning_pages :: Lens' Warning (Maybe [Natural])
Operations
AnalyzeDocument
analyzeDocument_humanLoopConfig :: Lens' AnalyzeDocument (Maybe HumanLoopConfig) Source #
Sets the configuration for the human in the loop workflow for analyzing documents.
analyzeDocument_queriesConfig :: Lens' AnalyzeDocument (Maybe QueriesConfig) Source #
Contains Queries and the alias for those Queries, as determined by the input.
analyzeDocument_document :: Lens' AnalyzeDocument Document Source #
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.
analyzeDocument_featureTypes :: Lens' AnalyzeDocument [FeatureType] Source #
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. To perform both forms and
table analysis, add TABLES and FORMS to FeatureTypes
. To detect
signatures within form data and table data, add SIGNATURES to either
TABLES or FORMS. All lines and words detected in the document are
included in the response (including text that isn't related to the
value of FeatureTypes
).
analyzeDocumentResponse_analyzeDocumentModelVersion :: Lens' AnalyzeDocumentResponse (Maybe Text) Source #
The version of the model used to analyze the document.
analyzeDocumentResponse_blocks :: Lens' AnalyzeDocumentResponse (Maybe [Block]) Source #
The items that are detected and analyzed by AnalyzeDocument
.
analyzeDocumentResponse_documentMetadata :: Lens' AnalyzeDocumentResponse (Maybe DocumentMetadata) Source #
Metadata about the analyzed document. An example is the number of pages.
analyzeDocumentResponse_humanLoopActivationOutput :: Lens' AnalyzeDocumentResponse (Maybe HumanLoopActivationOutput) Source #
Shows the results of the human in the loop evaluation.
analyzeDocumentResponse_httpStatus :: Lens' AnalyzeDocumentResponse Int Source #
The response's http status code.
AnalyzeExpense
analyzeExpense_document :: Lens' AnalyzeExpense Document Source #
Undocumented member.
analyzeExpenseResponse_documentMetadata :: Lens' AnalyzeExpenseResponse (Maybe DocumentMetadata) Source #
Undocumented member.
analyzeExpenseResponse_expenseDocuments :: Lens' AnalyzeExpenseResponse (Maybe [ExpenseDocument]) Source #
The expenses detected by Amazon Textract.
analyzeExpenseResponse_httpStatus :: Lens' AnalyzeExpenseResponse Int Source #
The response's http status code.
AnalyzeID
analyzeID_documentPages :: Lens' AnalyzeID (NonEmpty Document) Source #
The document being passed to AnalyzeID.
analyzeIDResponse_analyzeIDModelVersion :: Lens' AnalyzeIDResponse (Maybe Text) Source #
The version of the AnalyzeIdentity API being used to process documents.
analyzeIDResponse_documentMetadata :: Lens' AnalyzeIDResponse (Maybe DocumentMetadata) Source #
Undocumented member.
analyzeIDResponse_identityDocuments :: Lens' AnalyzeIDResponse (Maybe [IdentityDocument]) Source #
The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document.
analyzeIDResponse_httpStatus :: Lens' AnalyzeIDResponse Int Source #
The response's http status code.
DetectDocumentText
detectDocumentText_document :: Lens' DetectDocumentText Document Source #
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.
detectDocumentTextResponse_blocks :: Lens' DetectDocumentTextResponse (Maybe [Block]) Source #
An array of Block
objects that contain the text that's detected in
the document.
detectDocumentTextResponse_detectDocumentTextModelVersion :: Lens' DetectDocumentTextResponse (Maybe Text) Source #
detectDocumentTextResponse_documentMetadata :: Lens' DetectDocumentTextResponse (Maybe DocumentMetadata) Source #
Metadata about the document. It contains the number of pages that are detected in the document.
detectDocumentTextResponse_httpStatus :: Lens' DetectDocumentTextResponse Int Source #
The response's http status code.
GetDocumentAnalysis
getDocumentAnalysis_maxResults :: Lens' GetDocumentAnalysis (Maybe Natural) Source #
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.
getDocumentAnalysis_nextToken :: Lens' GetDocumentAnalysis (Maybe Text) Source #
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.
getDocumentAnalysis_jobId :: Lens' GetDocumentAnalysis Text Source #
A unique identifier for the text-detection job. The JobId
is returned
from StartDocumentAnalysis
. A JobId
value is only valid for 7 days.
getDocumentAnalysisResponse_analyzeDocumentModelVersion :: Lens' GetDocumentAnalysisResponse (Maybe Text) Source #
getDocumentAnalysisResponse_blocks :: Lens' GetDocumentAnalysisResponse (Maybe [Block]) Source #
The results of the text-analysis operation.
getDocumentAnalysisResponse_documentMetadata :: Lens' GetDocumentAnalysisResponse (Maybe DocumentMetadata) Source #
Information about a document that Amazon Textract processed.
DocumentMetadata
is returned in every page of paginated responses from
an Amazon Textract video operation.
getDocumentAnalysisResponse_jobStatus :: Lens' GetDocumentAnalysisResponse (Maybe JobStatus) Source #
The current status of the text detection job.
getDocumentAnalysisResponse_nextToken :: Lens' GetDocumentAnalysisResponse (Maybe Text) Source #
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.
getDocumentAnalysisResponse_statusMessage :: Lens' GetDocumentAnalysisResponse (Maybe Text) Source #
Returns if the detection job could not be completed. Contains explanation for what error occured.
getDocumentAnalysisResponse_warnings :: Lens' GetDocumentAnalysisResponse (Maybe [Warning]) Source #
A list of warnings that occurred during the document-analysis operation.
getDocumentAnalysisResponse_httpStatus :: Lens' GetDocumentAnalysisResponse Int Source #
The response's http status code.
GetDocumentTextDetection
getDocumentTextDetection_maxResults :: Lens' GetDocumentTextDetection (Maybe Natural) Source #
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.
getDocumentTextDetection_nextToken :: Lens' GetDocumentTextDetection (Maybe Text) Source #
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.
getDocumentTextDetection_jobId :: Lens' GetDocumentTextDetection Text Source #
A unique identifier for the text detection job. The JobId
is returned
from StartDocumentTextDetection
. A JobId
value is only valid for 7
days.
getDocumentTextDetectionResponse_blocks :: Lens' GetDocumentTextDetectionResponse (Maybe [Block]) Source #
The results of the text-detection operation.
getDocumentTextDetectionResponse_detectDocumentTextModelVersion :: Lens' GetDocumentTextDetectionResponse (Maybe Text) Source #
getDocumentTextDetectionResponse_documentMetadata :: Lens' GetDocumentTextDetectionResponse (Maybe DocumentMetadata) Source #
Information about a document that Amazon Textract processed.
DocumentMetadata
is returned in every page of paginated responses from
an Amazon Textract video operation.
getDocumentTextDetectionResponse_jobStatus :: Lens' GetDocumentTextDetectionResponse (Maybe JobStatus) Source #
The current status of the text detection job.
getDocumentTextDetectionResponse_nextToken :: Lens' GetDocumentTextDetectionResponse (Maybe Text) Source #
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.
getDocumentTextDetectionResponse_statusMessage :: Lens' GetDocumentTextDetectionResponse (Maybe Text) Source #
Returns if the detection job could not be completed. Contains explanation for what error occured.
getDocumentTextDetectionResponse_warnings :: Lens' GetDocumentTextDetectionResponse (Maybe [Warning]) Source #
A list of warnings that occurred during the text-detection operation for the document.
getDocumentTextDetectionResponse_httpStatus :: Lens' GetDocumentTextDetectionResponse Int Source #
The response's http status code.
GetExpenseAnalysis
getExpenseAnalysis_maxResults :: Lens' GetExpenseAnalysis (Maybe Natural) Source #
The maximum number of results to return per paginated call. The largest value you can specify is 20. If you specify a value greater than 20, a maximum of 20 results is returned. The default value is 20.
getExpenseAnalysis_nextToken :: Lens' GetExpenseAnalysis (Maybe Text) Source #
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.
getExpenseAnalysis_jobId :: Lens' GetExpenseAnalysis Text Source #
A unique identifier for the text detection job. The JobId
is returned
from StartExpenseAnalysis
. A JobId
value is only valid for 7 days.
getExpenseAnalysisResponse_analyzeExpenseModelVersion :: Lens' GetExpenseAnalysisResponse (Maybe Text) Source #
The current model version of AnalyzeExpense.
getExpenseAnalysisResponse_documentMetadata :: Lens' GetExpenseAnalysisResponse (Maybe DocumentMetadata) Source #
Information about a document that Amazon Textract processed.
DocumentMetadata
is returned in every page of paginated responses from
an Amazon Textract operation.
getExpenseAnalysisResponse_expenseDocuments :: Lens' GetExpenseAnalysisResponse (Maybe [ExpenseDocument]) Source #
The expenses detected by Amazon Textract.
getExpenseAnalysisResponse_jobStatus :: Lens' GetExpenseAnalysisResponse (Maybe JobStatus) Source #
The current status of the text detection job.
getExpenseAnalysisResponse_nextToken :: Lens' GetExpenseAnalysisResponse (Maybe Text) Source #
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.
getExpenseAnalysisResponse_statusMessage :: Lens' GetExpenseAnalysisResponse (Maybe Text) Source #
Returns if the detection job could not be completed. Contains explanation for what error occured.
getExpenseAnalysisResponse_warnings :: Lens' GetExpenseAnalysisResponse (Maybe [Warning]) Source #
A list of warnings that occurred during the text-detection operation for the document.
getExpenseAnalysisResponse_httpStatus :: Lens' GetExpenseAnalysisResponse Int Source #
The response's http status code.
GetLendingAnalysis
getLendingAnalysis_maxResults :: Lens' GetLendingAnalysis (Maybe Natural) Source #
The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.
getLendingAnalysis_nextToken :: Lens' GetLendingAnalysis (Maybe Text) Source #
If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.
getLendingAnalysis_jobId :: Lens' GetLendingAnalysis Text Source #
A unique identifier for the lending or text-detection job. The JobId
is returned from StartLendingAnalysis
. A JobId
value is only valid
for 7 days.
getLendingAnalysisResponse_analyzeLendingModelVersion :: Lens' GetLendingAnalysisResponse (Maybe Text) Source #
The current model version of the Analyze Lending API.
getLendingAnalysisResponse_documentMetadata :: Lens' GetLendingAnalysisResponse (Maybe DocumentMetadata) Source #
Undocumented member.
getLendingAnalysisResponse_jobStatus :: Lens' GetLendingAnalysisResponse (Maybe JobStatus) Source #
The current status of the lending analysis job.
getLendingAnalysisResponse_nextToken :: Lens' GetLendingAnalysisResponse (Maybe Text) Source #
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 lending results.
getLendingAnalysisResponse_results :: Lens' GetLendingAnalysisResponse (Maybe [LendingResult]) Source #
Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe.
getLendingAnalysisResponse_statusMessage :: Lens' GetLendingAnalysisResponse (Maybe Text) Source #
Returns if the lending analysis job could not be completed. Contains explanation for what error occurred.
getLendingAnalysisResponse_warnings :: Lens' GetLendingAnalysisResponse (Maybe [Warning]) Source #
A list of warnings that occurred during the lending analysis operation.
getLendingAnalysisResponse_httpStatus :: Lens' GetLendingAnalysisResponse Int Source #
The response's http status code.
GetLendingAnalysisSummary
getLendingAnalysisSummary_jobId :: Lens' GetLendingAnalysisSummary Text Source #
A unique identifier for the lending or text-detection job. The JobId
is returned from StartLendingAnalysis. A JobId
value is only valid for
7 days.
getLendingAnalysisSummaryResponse_analyzeLendingModelVersion :: Lens' GetLendingAnalysisSummaryResponse (Maybe Text) Source #
The current model version of the Analyze Lending API.
getLendingAnalysisSummaryResponse_documentMetadata :: Lens' GetLendingAnalysisSummaryResponse (Maybe DocumentMetadata) Source #
Undocumented member.
getLendingAnalysisSummaryResponse_jobStatus :: Lens' GetLendingAnalysisSummaryResponse (Maybe JobStatus) Source #
The current status of the lending analysis job.
getLendingAnalysisSummaryResponse_statusMessage :: Lens' GetLendingAnalysisSummaryResponse (Maybe Text) Source #
Returns if the lending analysis could not be completed. Contains explanation for what error occurred.
getLendingAnalysisSummaryResponse_summary :: Lens' GetLendingAnalysisSummaryResponse (Maybe LendingSummary) Source #
Contains summary information for documents grouped by type.
getLendingAnalysisSummaryResponse_warnings :: Lens' GetLendingAnalysisSummaryResponse (Maybe [Warning]) Source #
A list of warnings that occurred during the lending analysis operation.
getLendingAnalysisSummaryResponse_httpStatus :: Lens' GetLendingAnalysisSummaryResponse Int Source #
The response's http status code.
StartDocumentAnalysis
startDocumentAnalysis_clientRequestToken :: Lens' StartDocumentAnalysis (Maybe Text) Source #
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.
startDocumentAnalysis_jobTag :: Lens' StartDocumentAnalysis (Maybe Text) Source #
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).
startDocumentAnalysis_kmsKeyId :: Lens' StartDocumentAnalysis (Maybe Text) Source #
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.
startDocumentAnalysis_notificationChannel :: Lens' StartDocumentAnalysis (Maybe NotificationChannel) Source #
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
startDocumentAnalysis_outputConfig :: Lens' StartDocumentAnalysis (Maybe OutputConfig) Source #
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.
startDocumentAnalysis_queriesConfig :: Lens' StartDocumentAnalysis (Maybe QueriesConfig) Source #
Undocumented member.
startDocumentAnalysis_documentLocation :: Lens' StartDocumentAnalysis DocumentLocation Source #
The location of the document to be processed.
startDocumentAnalysis_featureTypes :: Lens' StartDocumentAnalysis [FeatureType] Source #
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
).
startDocumentAnalysisResponse_jobId :: Lens' StartDocumentAnalysisResponse (Maybe Text) Source #
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.
startDocumentAnalysisResponse_httpStatus :: Lens' StartDocumentAnalysisResponse Int Source #
The response's http status code.
StartDocumentTextDetection
startDocumentTextDetection_clientRequestToken :: Lens' StartDocumentTextDetection (Maybe Text) Source #
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.
startDocumentTextDetection_jobTag :: Lens' StartDocumentTextDetection (Maybe Text) Source #
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).
startDocumentTextDetection_kmsKeyId :: Lens' StartDocumentTextDetection (Maybe Text) Source #
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.
startDocumentTextDetection_notificationChannel :: Lens' StartDocumentTextDetection (Maybe NotificationChannel) Source #
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
startDocumentTextDetection_outputConfig :: Lens' StartDocumentTextDetection (Maybe OutputConfig) Source #
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.
startDocumentTextDetection_documentLocation :: Lens' StartDocumentTextDetection DocumentLocation Source #
The location of the document to be processed.
startDocumentTextDetectionResponse_jobId :: Lens' StartDocumentTextDetectionResponse (Maybe Text) Source #
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.
startDocumentTextDetectionResponse_httpStatus :: Lens' StartDocumentTextDetectionResponse Int Source #
The response's http status code.
StartExpenseAnalysis
startExpenseAnalysis_clientRequestToken :: Lens' StartExpenseAnalysis (Maybe Text) Source #
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
startExpenseAnalysis_jobTag :: Lens' StartExpenseAnalysis (Maybe Text) Source #
An identifier 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).
startExpenseAnalysis_kmsKeyId :: Lens' StartExpenseAnalysis (Maybe Text) Source #
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.
startExpenseAnalysis_notificationChannel :: Lens' StartExpenseAnalysis (Maybe NotificationChannel) Source #
The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
startExpenseAnalysis_outputConfig :: Lens' StartExpenseAnalysis (Maybe OutputConfig) Source #
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
GetExpenseAnalysis
operation.
startExpenseAnalysis_documentLocation :: Lens' StartExpenseAnalysis DocumentLocation Source #
The location of the document to be processed.
startExpenseAnalysisResponse_jobId :: Lens' StartExpenseAnalysisResponse (Maybe Text) Source #
A unique identifier for the text detection job. The JobId
is returned
from StartExpenseAnalysis
. A JobId
value is only valid for 7 days.
startExpenseAnalysisResponse_httpStatus :: Lens' StartExpenseAnalysisResponse Int Source #
The response's http status code.
StartLendingAnalysis
startLendingAnalysis_clientRequestToken :: Lens' StartLendingAnalysis (Maybe Text) Source #
The idempotent token that you use to identify the start request. If you
use the same token with multiple StartLendingAnalysis
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.
startLendingAnalysis_jobTag :: Lens' StartLendingAnalysis (Maybe Text) Source #
An identifier that you specify to be 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).
startLendingAnalysis_kmsKeyId :: Lens' StartLendingAnalysis (Maybe Text) Source #
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.
startLendingAnalysis_notificationChannel :: Lens' StartLendingAnalysis (Maybe NotificationChannel) Source #
Undocumented member.
startLendingAnalysis_outputConfig :: Lens' StartLendingAnalysis (Maybe OutputConfig) Source #
Undocumented member.
startLendingAnalysis_documentLocation :: Lens' StartLendingAnalysis DocumentLocation Source #
Undocumented member.
startLendingAnalysisResponse_jobId :: Lens' StartLendingAnalysisResponse (Maybe Text) Source #
A unique identifier for the lending or text-detection job. The JobId
is returned from StartLendingAnalysis
. A JobId
value is only valid
for 7 days.
startLendingAnalysisResponse_httpStatus :: Lens' StartLendingAnalysisResponse Int Source #
The response's http status code.
Types
AnalyzeIDDetections
analyzeIDDetections_confidence :: Lens' AnalyzeIDDetections (Maybe Double) Source #
The confidence score of the detected text.
analyzeIDDetections_normalizedValue :: Lens' AnalyzeIDDetections (Maybe NormalizedValue) Source #
Only returned for dates, returns the type of value detected and the date written in a more machine readable way.
analyzeIDDetections_text :: Lens' AnalyzeIDDetections Text Source #
Text of either the normalized field or value associated with it.
Block
block_blockType :: Lens' Block (Maybe BlockType) Source #
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
Block
objects 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
Block
objects that are detected on a document page. - KEY_VALUE_SET - Stores the KEY and VALUE
Block
objects for linked text that's detected on a document page. Use theEntityType
field to determine if a KEY_VALUE_SET object is a KEYBlock
object or a VALUEBlock
object. - 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
SelectionStatus
to determine the status of the selection element. - SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
- QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
- QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
block_columnIndex :: Lens' Block (Maybe Natural) Source #
The column in which a table cell appears. The first column position is
1. ColumnIndex
isn't returned by DetectDocumentText
and
GetDocumentTextDetection
.
block_columnSpan :: Lens' Block (Maybe Natural) Source #
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
.
block_confidence :: Lens' Block (Maybe Double) Source #
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.
block_entityTypes :: Lens' Block (Maybe [EntityType]) Source #
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
.
block_geometry :: Lens' Block (Maybe Geometry) Source #
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.
block_id :: Lens' Block (Maybe Text) Source #
The identifier for the recognized text. The identifier is only unique for a single operation.
block_page :: Lens' Block (Maybe Natural) Source #
The page on which a block was detected. Page
is returned by
synchronous and asynchronous operations. Page values greater than 1 are
only returned for multipage documents that are in PDF or TIFF format. A
scanned image (JPEG/PNG) provided to an asynchronous operation, even if
it contains multiple document pages, is considered a single-page
document. This means that for scanned images the value of Page
is
always 1. Synchronous operations operations will also return a Page
value of 1 because every input document is considered to be a
single-page document.
block_relationships :: Lens' Block (Maybe [Relationship]) Source #
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.
block_rowIndex :: Lens' Block (Maybe Natural) Source #
The row in which a table cell is located. The first row position is 1.
RowIndex
isn't returned by DetectDocumentText
and
GetDocumentTextDetection
.
block_rowSpan :: Lens' Block (Maybe Natural) Source #
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
.
block_selectionStatus :: Lens' Block (Maybe SelectionStatus) Source #
The selection status of a selection element, such as an option button or check box.
block_text :: Lens' Block (Maybe Text) Source #
The word or line of text that's recognized by Amazon Textract.
block_textType :: Lens' Block (Maybe TextType) Source #
The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
BoundingBox
boundingBox_height :: Lens' BoundingBox (Maybe Double) Source #
The height of the bounding box as a ratio of the overall document page height.
boundingBox_left :: Lens' BoundingBox (Maybe Double) Source #
The left coordinate of the bounding box as a ratio of overall document page width.
boundingBox_top :: Lens' BoundingBox (Maybe Double) Source #
The top coordinate of the bounding box as a ratio of overall document page height.
boundingBox_width :: Lens' BoundingBox (Maybe Double) Source #
The width of the bounding box as a ratio of the overall document page width.
DetectedSignature
detectedSignature_page :: Lens' DetectedSignature (Maybe Natural) Source #
The page a detected signature was found on.
Document
document_bytes :: Lens' Document (Maybe ByteString) Source #
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.
document_s3Object :: Lens' Document (Maybe S3Object) Source #
Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.
DocumentGroup
documentGroup_detectedSignatures :: Lens' DocumentGroup (Maybe [DetectedSignature]) Source #
A list of the detected signatures found in a document group.
documentGroup_splitDocuments :: Lens' DocumentGroup (Maybe [SplitDocument]) Source #
An array that contains information about the pages of a document, defined by logical boundary.
documentGroup_type :: Lens' DocumentGroup (Maybe Text) Source #
The type of document that Amazon Textract has detected. See LINK for a list of all types returned by Textract.
documentGroup_undetectedSignatures :: Lens' DocumentGroup (Maybe [UndetectedSignature]) Source #
A list of any expected signatures not found in a document group.
DocumentLocation
documentLocation_s3Object :: Lens' DocumentLocation (Maybe S3Object) Source #
The Amazon S3 bucket that contains the input document.
DocumentMetadata
documentMetadata_pages :: Lens' DocumentMetadata (Maybe Natural) Source #
The number of pages that are detected in the document.
ExpenseCurrency
expenseCurrency_code :: Lens' ExpenseCurrency (Maybe Text) Source #
Currency code for detected currency. the current supported codes are:
- USD
- EUR
- GBP
- CAD
- INR
- JPY
- CHF
- AUD
- CNY
- BZR
- SEK
- HKD
expenseCurrency_confidence :: Lens' ExpenseCurrency (Maybe Double) Source #
Percentage confideence in the detected currency.
ExpenseDetection
expenseDetection_confidence :: Lens' ExpenseDetection (Maybe Double) Source #
The confidence in detection, as a percentage
expenseDetection_geometry :: Lens' ExpenseDetection (Maybe Geometry) Source #
Undocumented member.
expenseDetection_text :: Lens' ExpenseDetection (Maybe Text) Source #
The word or line of text recognized by Amazon Textract
ExpenseDocument
expenseDocument_blocks :: Lens' ExpenseDocument (Maybe [Block]) Source #
This is a block object, the same as reported when DetectDocumentText is run on a document. It provides word level recognition of text.
expenseDocument_expenseIndex :: Lens' ExpenseDocument (Maybe Natural) Source #
Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.
expenseDocument_lineItemGroups :: Lens' ExpenseDocument (Maybe [LineItemGroup]) Source #
Information detected on each table of a document, seperated into
LineItems
.
expenseDocument_summaryFields :: Lens' ExpenseDocument (Maybe [ExpenseField]) Source #
Any information found outside of a table by Amazon Textract.
ExpenseField
expenseField_currency :: Lens' ExpenseField (Maybe ExpenseCurrency) Source #
Shows the kind of currency, both the code and confidence associated with any monatary value detected.
expenseField_groupProperties :: Lens' ExpenseField (Maybe [ExpenseGroupProperty]) Source #
Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.
expenseField_labelDetection :: Lens' ExpenseField (Maybe ExpenseDetection) Source #
The explicitly stated label of a detected element.
expenseField_pageNumber :: Lens' ExpenseField (Maybe Natural) Source #
The page number the value was detected on.
expenseField_type :: Lens' ExpenseField (Maybe ExpenseType) Source #
The implied label of a detected element. Present alongside LabelDetection for explicit elements.
expenseField_valueDetection :: Lens' ExpenseField (Maybe ExpenseDetection) Source #
The value of a detected element. Present in explicit and implicit elements.
ExpenseGroupProperty
expenseGroupProperty_id :: Lens' ExpenseGroupProperty (Maybe Text) Source #
Provides a group Id number, which will be the same for each in the group.
expenseGroupProperty_types :: Lens' ExpenseGroupProperty (Maybe [Text]) Source #
Informs you on whether the expense group is a name or an address.
ExpenseType
expenseType_confidence :: Lens' ExpenseType (Maybe Double) Source #
The confidence of accuracy, as a percentage.
expenseType_text :: Lens' ExpenseType (Maybe Text) Source #
The word or line of text detected by Amazon Textract.
Extraction
extraction_expenseDocument :: Lens' Extraction (Maybe ExpenseDocument) Source #
Undocumented member.
extraction_identityDocument :: Lens' Extraction (Maybe IdentityDocument) Source #
Undocumented member.
extraction_lendingDocument :: Lens' Extraction (Maybe LendingDocument) Source #
Holds the structured data returned by AnalyzeDocument for lending documents.
Geometry
geometry_boundingBox :: Lens' Geometry (Maybe BoundingBox) Source #
An axis-aligned coarse representation of the location of the recognized item on the document page.
geometry_polygon :: Lens' Geometry (Maybe [Point]) Source #
Within the bounding box, a fine-grained polygon around the recognized item.
HumanLoopActivationOutput
humanLoopActivationOutput_humanLoopActivationConditionsEvaluationResults :: Lens' HumanLoopActivationOutput (Maybe Text) Source #
Shows the result of condition evaluations, including those conditions which activated a human review.
humanLoopActivationOutput_humanLoopActivationReasons :: Lens' HumanLoopActivationOutput (Maybe (NonEmpty Text)) Source #
Shows if and why human review was needed.
humanLoopActivationOutput_humanLoopArn :: Lens' HumanLoopActivationOutput (Maybe Text) Source #
The Amazon Resource Name (ARN) of the HumanLoop created.
HumanLoopConfig
humanLoopConfig_dataAttributes :: Lens' HumanLoopConfig (Maybe HumanLoopDataAttributes) Source #
Sets attributes of the input data.
humanLoopConfig_humanLoopName :: Lens' HumanLoopConfig Text Source #
The name of the human workflow used for this image. This should be kept unique within a region.
humanLoopConfig_flowDefinitionArn :: Lens' HumanLoopConfig Text Source #
The Amazon Resource Name (ARN) of the flow definition.
HumanLoopDataAttributes
humanLoopDataAttributes_contentClassifiers :: Lens' HumanLoopDataAttributes (Maybe [ContentClassifier]) Source #
Sets whether the input image is free of personally identifiable information or adult content.
IdentityDocument
identityDocument_blocks :: Lens' IdentityDocument (Maybe [Block]) Source #
Individual word recognition, as returned by document detection.
identityDocument_documentIndex :: Lens' IdentityDocument (Maybe Natural) Source #
Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.
identityDocument_identityDocumentFields :: Lens' IdentityDocument (Maybe [IdentityDocumentField]) Source #
The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.
IdentityDocumentField
identityDocumentField_type :: Lens' IdentityDocumentField (Maybe AnalyzeIDDetections) Source #
Undocumented member.
identityDocumentField_valueDetection :: Lens' IdentityDocumentField (Maybe AnalyzeIDDetections) Source #
Undocumented member.
LendingDetection
lendingDetection_confidence :: Lens' LendingDetection (Maybe Double) Source #
The confidence level for the text of a detected value in a lending document.
lendingDetection_geometry :: Lens' LendingDetection (Maybe Geometry) Source #
Undocumented member.
lendingDetection_selectionStatus :: Lens' LendingDetection (Maybe SelectionStatus) Source #
The selection status of a selection element, such as an option button or check box.
lendingDetection_text :: Lens' LendingDetection (Maybe Text) Source #
The text extracted for a detected value in a lending document.
LendingDocument
lendingDocument_lendingFields :: Lens' LendingDocument (Maybe [LendingField]) Source #
An array of LendingField objects.
lendingDocument_signatureDetections :: Lens' LendingDocument (Maybe [SignatureDetection]) Source #
A list of signatures detected in a lending document.
LendingField
lendingField_keyDetection :: Lens' LendingField (Maybe LendingDetection) Source #
Undocumented member.
lendingField_type :: Lens' LendingField (Maybe Text) Source #
The type of the lending document.
lendingField_valueDetections :: Lens' LendingField (Maybe [LendingDetection]) Source #
An array of LendingDetection objects.
LendingResult
lendingResult_extractions :: Lens' LendingResult (Maybe [Extraction]) Source #
An array of Extraction to hold structured data. e.g. normalized key value pairs instead of raw OCR detections .
lendingResult_page :: Lens' LendingResult (Maybe Natural) Source #
The page number for a page, with regard to whole submission.
lendingResult_pageClassification :: Lens' LendingResult (Maybe PageClassification) Source #
The classifier result for a given page.
LendingSummary
lendingSummary_documentGroups :: Lens' LendingSummary (Maybe [DocumentGroup]) Source #
Contains an array of all DocumentGroup objects.
lendingSummary_undetectedDocumentTypes :: Lens' LendingSummary (Maybe [Text]) Source #
UndetectedDocumentTypes.
LineItemFields
lineItemFields_lineItemExpenseFields :: Lens' LineItemFields (Maybe [ExpenseField]) Source #
ExpenseFields used to show information from detected lines on a table.
LineItemGroup
lineItemGroup_lineItemGroupIndex :: Lens' LineItemGroup (Maybe Natural) Source #
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.
lineItemGroup_lineItems :: Lens' LineItemGroup (Maybe [LineItemFields]) Source #
The breakdown of information on a particular line of a table.
NormalizedValue
normalizedValue_value :: Lens' NormalizedValue (Maybe Text) Source #
The value of the date, written as Year-Month-DayTHour:Minute:Second.
normalizedValue_valueType :: Lens' NormalizedValue (Maybe ValueType) Source #
The normalized type of the value detected. In this case, DATE.
NotificationChannel
notificationChannel_sNSTopicArn :: Lens' NotificationChannel Text Source #
The Amazon SNS topic that Amazon Textract posts the completion status to.
notificationChannel_roleArn :: Lens' NotificationChannel Text Source #
The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
OutputConfig
outputConfig_s3Prefix :: Lens' OutputConfig (Maybe Text) Source #
The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".
outputConfig_s3Bucket :: Lens' OutputConfig Text Source #
The name of the bucket your output will go to.
PageClassification
pageClassification_pageType :: Lens' PageClassification [Prediction] Source #
The class, or document type, assigned to a detected Page object. The class, or document type, assigned to a detected Page object.
pageClassification_pageNumber :: Lens' PageClassification [Prediction] Source #
The page number the value was detected on, relative to Amazon Textract's starting position.
Point
point_x :: Lens' Point (Maybe Double) Source #
The value of the X coordinate for a point on a Polygon
.
point_y :: Lens' Point (Maybe Double) Source #
The value of the Y coordinate for a point on a Polygon
.
Prediction
prediction_confidence :: Lens' Prediction (Maybe Double) Source #
Amazon Textract's confidence in its predicted value.
prediction_value :: Lens' Prediction (Maybe Text) Source #
The predicted value of a detected object.
QueriesConfig
Query
query_pages :: Lens' Query (Maybe (NonEmpty Text)) Source #
Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.
- If a page is not specified, it is set to
["1"]
by default. - The following characters are allowed in the parameter's string:
0 1 2 3 4 5 6 7 8 9 - *
. No whitespace is allowed. - When using * to indicate all pages, it must be the only element in the list.
- You can use page intervals, such as
[“1-3”, “1-1”, “4-*”]
. Where*
indicates last page of document. - Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
query_text :: Lens' Query Text Source #
Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
Relationship
relationship_ids :: Lens' Relationship (Maybe [Text]) Source #
An array of IDs for related blocks. You can get the type of the
relationship from the Type
element.
relationship_type :: Lens' Relationship (Maybe RelationshipType) Source #
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
s3Object_bucket :: Lens' S3Object (Maybe Text) Source #
The name of the S3 bucket. Note that the # character is not valid in the file name.
s3Object_name :: Lens' S3Object (Maybe Text) Source #
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 and TIFF format files.
s3Object_version :: Lens' S3Object (Maybe Text) Source #
If the bucket has versioning enabled, you can specify the object version.
SignatureDetection
signatureDetection_confidence :: Lens' SignatureDetection (Maybe Double) Source #
The confidence, from 0 to 100, in the predicted values for a detected signature.
signatureDetection_geometry :: Lens' SignatureDetection (Maybe Geometry) Source #
Undocumented member.
SplitDocument
splitDocument_index :: Lens' SplitDocument (Maybe Natural) Source #
The index for a given document in a DocumentGroup of a specific Type.
splitDocument_pages :: Lens' SplitDocument (Maybe [Natural]) Source #
An array of page numbers for a for a given document, ordered by logical boundary.
UndetectedSignature
undetectedSignature_page :: Lens' UndetectedSignature (Maybe Natural) Source #
The page where a signature was expected but not found.