| 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 |
Amazonka.Textract
Contents
- Service Configuration
- Errors
- AccessDeniedException
- BadDocumentException
- DocumentTooLargeException
- HumanLoopQuotaExceededException
- IdempotentParameterMismatchException
- InternalServerError
- InvalidJobIdException
- InvalidKMSKeyException
- InvalidParameterException
- InvalidS3ObjectException
- LimitExceededException
- ProvisionedThroughputExceededException
- ThrottlingException
- UnsupportedDocumentException
- Waiters
- Operations
- Types
- BlockType
- ContentClassifier
- EntityType
- FeatureType
- JobStatus
- RelationshipType
- SelectionStatus
- TextType
- ValueType
- 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
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
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _BadDocumentException :: AsError a => Fold a ServiceError
- _DocumentTooLargeException :: AsError a => Fold a ServiceError
- _HumanLoopQuotaExceededException :: AsError a => Fold a ServiceError
- _IdempotentParameterMismatchException :: AsError a => Fold a ServiceError
- _InternalServerError :: AsError a => Fold a ServiceError
- _InvalidJobIdException :: AsError a => Fold a ServiceError
- _InvalidKMSKeyException :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _InvalidS3ObjectException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ProvisionedThroughputExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _UnsupportedDocumentException :: AsError a => Fold a ServiceError
- data AnalyzeDocument = AnalyzeDocument' (Maybe HumanLoopConfig) (Maybe QueriesConfig) Document [FeatureType]
- newAnalyzeDocument :: Document -> AnalyzeDocument
- data AnalyzeDocumentResponse = AnalyzeDocumentResponse' (Maybe Text) (Maybe [Block]) (Maybe DocumentMetadata) (Maybe HumanLoopActivationOutput) Int
- newAnalyzeDocumentResponse :: Int -> AnalyzeDocumentResponse
- data AnalyzeExpense = AnalyzeExpense' Document
- newAnalyzeExpense :: Document -> AnalyzeExpense
- data AnalyzeExpenseResponse = AnalyzeExpenseResponse' (Maybe DocumentMetadata) (Maybe [ExpenseDocument]) Int
- newAnalyzeExpenseResponse :: Int -> AnalyzeExpenseResponse
- data AnalyzeID = AnalyzeID' (NonEmpty Document)
- newAnalyzeID :: NonEmpty Document -> AnalyzeID
- data AnalyzeIDResponse = AnalyzeIDResponse' (Maybe Text) (Maybe DocumentMetadata) (Maybe [IdentityDocument]) Int
- newAnalyzeIDResponse :: Int -> AnalyzeIDResponse
- data DetectDocumentText = DetectDocumentText' Document
- newDetectDocumentText :: Document -> DetectDocumentText
- data DetectDocumentTextResponse = DetectDocumentTextResponse' (Maybe [Block]) (Maybe Text) (Maybe DocumentMetadata) Int
- newDetectDocumentTextResponse :: Int -> DetectDocumentTextResponse
- data GetDocumentAnalysis = GetDocumentAnalysis' (Maybe Natural) (Maybe Text) Text
- newGetDocumentAnalysis :: Text -> GetDocumentAnalysis
- data GetDocumentAnalysisResponse = GetDocumentAnalysisResponse' (Maybe Text) (Maybe [Block]) (Maybe DocumentMetadata) (Maybe JobStatus) (Maybe Text) (Maybe Text) (Maybe [Warning]) Int
- newGetDocumentAnalysisResponse :: Int -> GetDocumentAnalysisResponse
- data GetDocumentTextDetection = GetDocumentTextDetection' (Maybe Natural) (Maybe Text) Text
- newGetDocumentTextDetection :: Text -> GetDocumentTextDetection
- data GetDocumentTextDetectionResponse = GetDocumentTextDetectionResponse' (Maybe [Block]) (Maybe Text) (Maybe DocumentMetadata) (Maybe JobStatus) (Maybe Text) (Maybe Text) (Maybe [Warning]) Int
- newGetDocumentTextDetectionResponse :: Int -> GetDocumentTextDetectionResponse
- data GetExpenseAnalysis = GetExpenseAnalysis' (Maybe Natural) (Maybe Text) Text
- newGetExpenseAnalysis :: Text -> GetExpenseAnalysis
- data GetExpenseAnalysisResponse = GetExpenseAnalysisResponse' (Maybe Text) (Maybe DocumentMetadata) (Maybe [ExpenseDocument]) (Maybe JobStatus) (Maybe Text) (Maybe Text) (Maybe [Warning]) Int
- newGetExpenseAnalysisResponse :: Int -> GetExpenseAnalysisResponse
- data GetLendingAnalysis = GetLendingAnalysis' (Maybe Natural) (Maybe Text) Text
- newGetLendingAnalysis :: Text -> GetLendingAnalysis
- data GetLendingAnalysisResponse = GetLendingAnalysisResponse' (Maybe Text) (Maybe DocumentMetadata) (Maybe JobStatus) (Maybe Text) (Maybe [LendingResult]) (Maybe Text) (Maybe [Warning]) Int
- newGetLendingAnalysisResponse :: Int -> GetLendingAnalysisResponse
- data GetLendingAnalysisSummary = GetLendingAnalysisSummary' Text
- newGetLendingAnalysisSummary :: Text -> GetLendingAnalysisSummary
- data GetLendingAnalysisSummaryResponse = GetLendingAnalysisSummaryResponse' (Maybe Text) (Maybe DocumentMetadata) (Maybe JobStatus) (Maybe Text) (Maybe LendingSummary) (Maybe [Warning]) Int
- newGetLendingAnalysisSummaryResponse :: Int -> GetLendingAnalysisSummaryResponse
- data StartDocumentAnalysis = StartDocumentAnalysis' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe NotificationChannel) (Maybe OutputConfig) (Maybe QueriesConfig) DocumentLocation [FeatureType]
- newStartDocumentAnalysis :: DocumentLocation -> StartDocumentAnalysis
- data StartDocumentAnalysisResponse = StartDocumentAnalysisResponse' (Maybe Text) Int
- newStartDocumentAnalysisResponse :: Int -> StartDocumentAnalysisResponse
- data StartDocumentTextDetection = StartDocumentTextDetection' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe NotificationChannel) (Maybe OutputConfig) DocumentLocation
- newStartDocumentTextDetection :: DocumentLocation -> StartDocumentTextDetection
- data StartDocumentTextDetectionResponse = StartDocumentTextDetectionResponse' (Maybe Text) Int
- newStartDocumentTextDetectionResponse :: Int -> StartDocumentTextDetectionResponse
- data StartExpenseAnalysis = StartExpenseAnalysis' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe NotificationChannel) (Maybe OutputConfig) DocumentLocation
- newStartExpenseAnalysis :: DocumentLocation -> StartExpenseAnalysis
- data StartExpenseAnalysisResponse = StartExpenseAnalysisResponse' (Maybe Text) Int
- newStartExpenseAnalysisResponse :: Int -> StartExpenseAnalysisResponse
- data StartLendingAnalysis = StartLendingAnalysis' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe NotificationChannel) (Maybe OutputConfig) DocumentLocation
- newStartLendingAnalysis :: DocumentLocation -> StartLendingAnalysis
- data StartLendingAnalysisResponse = StartLendingAnalysisResponse' (Maybe Text) Int
- newStartLendingAnalysisResponse :: Int -> StartLendingAnalysisResponse
- newtype BlockType where
- BlockType' { }
- pattern BlockType_CELL :: BlockType
- pattern BlockType_KEY_VALUE_SET :: BlockType
- pattern BlockType_LINE :: BlockType
- pattern BlockType_MERGED_CELL :: BlockType
- pattern BlockType_PAGE :: BlockType
- pattern BlockType_QUERY :: BlockType
- pattern BlockType_QUERY_RESULT :: BlockType
- pattern BlockType_SELECTION_ELEMENT :: BlockType
- pattern BlockType_SIGNATURE :: BlockType
- pattern BlockType_TABLE :: BlockType
- pattern BlockType_TITLE :: BlockType
- pattern BlockType_WORD :: BlockType
- newtype ContentClassifier where
- newtype EntityType where
- EntityType' { }
- pattern EntityType_COLUMN_HEADER :: EntityType
- pattern EntityType_KEY :: EntityType
- pattern EntityType_VALUE :: EntityType
- newtype FeatureType where
- FeatureType' { }
- pattern FeatureType_FORMS :: FeatureType
- pattern FeatureType_QUERIES :: FeatureType
- pattern FeatureType_SIGNATURES :: 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_ANSWER :: RelationshipType
- pattern RelationshipType_CHILD :: RelationshipType
- pattern RelationshipType_COMPLEX_FEATURES :: RelationshipType
- pattern RelationshipType_MERGED_CELL :: RelationshipType
- pattern RelationshipType_TITLE :: 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' {
- newtype ValueType where
- ValueType' { }
- pattern ValueType_DATE :: ValueType
- data AnalyzeIDDetections = AnalyzeIDDetections' (Maybe Double) (Maybe NormalizedValue) Text
- newAnalyzeIDDetections :: Text -> AnalyzeIDDetections
- data Block = Block' (Maybe BlockType) (Maybe Natural) (Maybe Natural) (Maybe Double) (Maybe [EntityType]) (Maybe Geometry) (Maybe Text) (Maybe Natural) (Maybe Query) (Maybe [Relationship]) (Maybe Natural) (Maybe Natural) (Maybe SelectionStatus) (Maybe Text) (Maybe TextType)
- newBlock :: Block
- data BoundingBox = BoundingBox' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double)
- newBoundingBox :: BoundingBox
- data DetectedSignature = DetectedSignature' (Maybe Natural)
- newDetectedSignature :: DetectedSignature
- data Document = Document' (Maybe Base64) (Maybe S3Object)
- newDocument :: Document
- data DocumentGroup = DocumentGroup' (Maybe [DetectedSignature]) (Maybe [SplitDocument]) (Maybe Text) (Maybe [UndetectedSignature])
- newDocumentGroup :: DocumentGroup
- data DocumentLocation = DocumentLocation' (Maybe S3Object)
- newDocumentLocation :: DocumentLocation
- data DocumentMetadata = DocumentMetadata' (Maybe Natural)
- newDocumentMetadata :: DocumentMetadata
- data ExpenseCurrency = ExpenseCurrency' (Maybe Text) (Maybe Double)
- newExpenseCurrency :: ExpenseCurrency
- data ExpenseDetection = ExpenseDetection' (Maybe Double) (Maybe Geometry) (Maybe Text)
- newExpenseDetection :: ExpenseDetection
- data ExpenseDocument = ExpenseDocument' (Maybe [Block]) (Maybe Natural) (Maybe [LineItemGroup]) (Maybe [ExpenseField])
- newExpenseDocument :: ExpenseDocument
- data ExpenseField = ExpenseField' (Maybe ExpenseCurrency) (Maybe [ExpenseGroupProperty]) (Maybe ExpenseDetection) (Maybe Natural) (Maybe ExpenseType) (Maybe ExpenseDetection)
- newExpenseField :: ExpenseField
- data ExpenseGroupProperty = ExpenseGroupProperty' (Maybe Text) (Maybe [Text])
- newExpenseGroupProperty :: ExpenseGroupProperty
- data ExpenseType = ExpenseType' (Maybe Double) (Maybe Text)
- newExpenseType :: ExpenseType
- data Extraction = Extraction' (Maybe ExpenseDocument) (Maybe IdentityDocument) (Maybe LendingDocument)
- newExtraction :: Extraction
- data Geometry = Geometry' (Maybe BoundingBox) (Maybe [Point])
- newGeometry :: Geometry
- data HumanLoopActivationOutput = HumanLoopActivationOutput' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text)
- newHumanLoopActivationOutput :: HumanLoopActivationOutput
- data HumanLoopConfig = HumanLoopConfig' (Maybe HumanLoopDataAttributes) Text Text
- newHumanLoopConfig :: Text -> Text -> HumanLoopConfig
- data HumanLoopDataAttributes = HumanLoopDataAttributes' (Maybe [ContentClassifier])
- newHumanLoopDataAttributes :: HumanLoopDataAttributes
- data IdentityDocument = IdentityDocument' (Maybe [Block]) (Maybe Natural) (Maybe [IdentityDocumentField])
- newIdentityDocument :: IdentityDocument
- data IdentityDocumentField = IdentityDocumentField' (Maybe AnalyzeIDDetections) (Maybe AnalyzeIDDetections)
- newIdentityDocumentField :: IdentityDocumentField
- data LendingDetection = LendingDetection' (Maybe Double) (Maybe Geometry) (Maybe SelectionStatus) (Maybe Text)
- newLendingDetection :: LendingDetection
- data LendingDocument = LendingDocument' (Maybe [LendingField]) (Maybe [SignatureDetection])
- newLendingDocument :: LendingDocument
- data LendingField = LendingField' (Maybe LendingDetection) (Maybe Text) (Maybe [LendingDetection])
- newLendingField :: LendingField
- data LendingResult = LendingResult' (Maybe [Extraction]) (Maybe Natural) (Maybe PageClassification)
- newLendingResult :: LendingResult
- data LendingSummary = LendingSummary' (Maybe [DocumentGroup]) (Maybe [Text])
- newLendingSummary :: LendingSummary
- data LineItemFields = LineItemFields' (Maybe [ExpenseField])
- newLineItemFields :: LineItemFields
- data LineItemGroup = LineItemGroup' (Maybe Natural) (Maybe [LineItemFields])
- newLineItemGroup :: LineItemGroup
- data NormalizedValue = NormalizedValue' (Maybe Text) (Maybe ValueType)
- newNormalizedValue :: NormalizedValue
- data NotificationChannel = NotificationChannel' Text Text
- newNotificationChannel :: Text -> Text -> NotificationChannel
- data OutputConfig = OutputConfig' (Maybe Text) Text
- newOutputConfig :: Text -> OutputConfig
- data PageClassification = PageClassification' [Prediction] [Prediction]
- newPageClassification :: PageClassification
- data Point = Point' (Maybe Double) (Maybe Double)
- newPoint :: Point
- data Prediction = Prediction' (Maybe Double) (Maybe Text)
- newPrediction :: Prediction
- data QueriesConfig = QueriesConfig' (NonEmpty Query)
- newQueriesConfig :: NonEmpty Query -> QueriesConfig
- data Query = Query' (Maybe Text) (Maybe (NonEmpty Text)) Text
- newQuery :: Text -> Query
- data Relationship = Relationship' (Maybe [Text]) (Maybe RelationshipType)
- newRelationship :: Relationship
- data S3Object = S3Object' (Maybe Text) (Maybe Text) (Maybe Text)
- newS3Object :: S3Object
- data SignatureDetection = SignatureDetection' (Maybe Double) (Maybe Geometry)
- newSignatureDetection :: SignatureDetection
- data SplitDocument = SplitDocument' (Maybe Natural) (Maybe [Natural])
- newSplitDocument :: SplitDocument
- data UndetectedSignature = UndetectedSignature' (Maybe Natural)
- newUndetectedSignature :: UndetectedSignature
- data Warning = Warning' (Maybe Text) (Maybe [Natural])
- 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.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold 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 => Fold a ServiceError Source #
Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
DocumentTooLargeException
_DocumentTooLargeException :: AsError a => Fold 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.
HumanLoopQuotaExceededException
_HumanLoopQuotaExceededException :: AsError a => Fold a ServiceError Source #
Indicates you have exceeded the maximum number of active human in the loop workflows available
IdempotentParameterMismatchException
_IdempotentParameterMismatchException :: AsError a => Fold 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.
InternalServerError
_InternalServerError :: AsError a => Fold a ServiceError Source #
Amazon Textract experienced a service issue. Try your call again.
InvalidJobIdException
_InvalidJobIdException :: AsError a => Fold a ServiceError Source #
An invalid job identifier was passed to an asynchronous analysis operation.
InvalidKMSKeyException
_InvalidKMSKeyException :: AsError a => Fold a ServiceError Source #
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
InvalidParameterException
_InvalidParameterException :: AsError a => Fold 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.
InvalidS3ObjectException
_InvalidS3ObjectException :: AsError a => Fold 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
LimitExceededException
_LimitExceededException :: AsError a => Fold 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.
ProvisionedThroughputExceededException
_ProvisionedThroughputExceededException :: AsError a => Fold a ServiceError Source #
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
Amazon Textract is temporarily unable to process the request. Try your call again.
UnsupportedDocumentException
_UnsupportedDocumentException :: AsError a => Fold a ServiceError Source #
The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.
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.
AnalyzeDocument
data AnalyzeDocument Source #
See: newAnalyzeDocument smart constructor.
Constructors
| AnalyzeDocument' (Maybe HumanLoopConfig) (Maybe QueriesConfig) 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:queriesConfig:AnalyzeDocument', analyzeDocument_queriesConfig - Contains Queries and the alias for those Queries, as determined by the
input.
$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, 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.
$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. 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).
data AnalyzeDocumentResponse Source #
See: newAnalyzeDocumentResponse smart constructor.
Constructors
| AnalyzeDocumentResponse' (Maybe Text) (Maybe [Block]) (Maybe DocumentMetadata) (Maybe HumanLoopActivationOutput) 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:analyzeDocumentModelVersion:AnalyzeDocumentResponse', analyzeDocumentResponse_analyzeDocumentModelVersion - The version of the model used to analyze the document.
AnalyzeDocumentResponse, analyzeDocumentResponse_blocks - The items that are detected and analyzed by AnalyzeDocument.
$sel:documentMetadata:AnalyzeDocumentResponse', analyzeDocumentResponse_documentMetadata - Metadata about the analyzed document. An example is the number of pages.
$sel:humanLoopActivationOutput:AnalyzeDocumentResponse', analyzeDocumentResponse_humanLoopActivationOutput - Shows the results of the human in the loop evaluation.
$sel:httpStatus:AnalyzeDocumentResponse', analyzeDocumentResponse_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.
AnalyzeID
See: newAnalyzeID smart constructor.
Constructors
| AnalyzeID' (NonEmpty Document) |
Instances
Create a value of AnalyzeID 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:documentPages:AnalyzeID', analyzeID_documentPages - The document being passed to AnalyzeID.
data AnalyzeIDResponse Source #
See: newAnalyzeIDResponse smart constructor.
Constructors
| AnalyzeIDResponse' (Maybe Text) (Maybe DocumentMetadata) (Maybe [IdentityDocument]) Int |
Instances
Arguments
| :: Int | |
| -> AnalyzeIDResponse |
Create a value of AnalyzeIDResponse 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:analyzeIDModelVersion:AnalyzeIDResponse', analyzeIDResponse_analyzeIDModelVersion - The version of the AnalyzeIdentity API being used to process documents.
$sel:documentMetadata:AnalyzeIDResponse', analyzeIDResponse_documentMetadata - Undocumented member.
$sel:identityDocuments:AnalyzeIDResponse', analyzeIDResponse_identityDocuments - The list of documents processed by AnalyzeID. Includes a number denoting
their place in the list and the response structure for the document.
$sel:httpStatus:AnalyzeIDResponse', analyzeIDResponse_httpStatus - The response's http status code.
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 [Block]) (Maybe Text) (Maybe DocumentMetadata) 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:
DetectDocumentTextResponse, detectDocumentTextResponse_blocks - An array of Block objects that contain the text that's detected in
the document.
$sel:detectDocumentTextModelVersion:DetectDocumentTextResponse', detectDocumentTextResponse_detectDocumentTextModelVersion -
$sel:documentMetadata:DetectDocumentTextResponse', detectDocumentTextResponse_documentMetadata - Metadata about the document. It contains the number of pages that are
detected in the document.
$sel:httpStatus:DetectDocumentTextResponse', detectDocumentTextResponse_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: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.
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: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 Text) (Maybe [Block]) (Maybe DocumentMetadata) (Maybe JobStatus) (Maybe Text) (Maybe Text) (Maybe [Warning]) 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:analyzeDocumentModelVersion:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_analyzeDocumentModelVersion -
GetDocumentAnalysisResponse, getDocumentAnalysisResponse_blocks - The results of the text-analysis operation.
$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:jobStatus:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_jobStatus - The current status of the text detection job.
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:warnings:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_warnings - A list of warnings that occurred during the document-analysis operation.
$sel:httpStatus:GetDocumentAnalysisResponse', getDocumentAnalysisResponse_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: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.
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: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 [Block]) (Maybe Text) (Maybe DocumentMetadata) (Maybe JobStatus) (Maybe Text) (Maybe Text) (Maybe [Warning]) 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:
GetDocumentTextDetectionResponse, getDocumentTextDetectionResponse_blocks - The results of the text-detection operation.
$sel:detectDocumentTextModelVersion:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_detectDocumentTextModelVersion -
$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:jobStatus:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_jobStatus - The current status of the text detection job.
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:warnings:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_warnings - A list of warnings that occurred during the text-detection operation for
the document.
$sel:httpStatus:GetDocumentTextDetectionResponse', getDocumentTextDetectionResponse_httpStatus - The response's http status code.
GetExpenseAnalysis
data GetExpenseAnalysis Source #
See: newGetExpenseAnalysis smart constructor.
Instances
newGetExpenseAnalysis Source #
Arguments
| :: Text | |
| -> GetExpenseAnalysis |
Create a value of GetExpenseAnalysis 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:maxResults:GetExpenseAnalysis', getExpenseAnalysis_maxResults - 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, getExpenseAnalysis_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:jobId:GetExpenseAnalysis', getExpenseAnalysis_jobId - A unique identifier for the text detection job. The JobId is returned
from StartExpenseAnalysis. A JobId value is only valid for 7 days.
data GetExpenseAnalysisResponse Source #
See: newGetExpenseAnalysisResponse smart constructor.
Constructors
| GetExpenseAnalysisResponse' (Maybe Text) (Maybe DocumentMetadata) (Maybe [ExpenseDocument]) (Maybe JobStatus) (Maybe Text) (Maybe Text) (Maybe [Warning]) Int |
Instances
newGetExpenseAnalysisResponse Source #
Create a value of GetExpenseAnalysisResponse 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:analyzeExpenseModelVersion:GetExpenseAnalysisResponse', getExpenseAnalysisResponse_analyzeExpenseModelVersion - The current model version of AnalyzeExpense.
$sel:documentMetadata:GetExpenseAnalysisResponse', getExpenseAnalysisResponse_documentMetadata - Information about a document that Amazon Textract processed.
DocumentMetadata is returned in every page of paginated responses from
an Amazon Textract operation.
$sel:expenseDocuments:GetExpenseAnalysisResponse', getExpenseAnalysisResponse_expenseDocuments - The expenses detected by Amazon Textract.
$sel:jobStatus:GetExpenseAnalysisResponse', getExpenseAnalysisResponse_jobStatus - The current status of the text detection job.
GetExpenseAnalysis, getExpenseAnalysisResponse_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:GetExpenseAnalysisResponse', getExpenseAnalysisResponse_statusMessage - Returns if the detection job could not be completed. Contains
explanation for what error occured.
$sel:warnings:GetExpenseAnalysisResponse', getExpenseAnalysisResponse_warnings - A list of warnings that occurred during the text-detection operation for
the document.
$sel:httpStatus:GetExpenseAnalysisResponse', getExpenseAnalysisResponse_httpStatus - The response's http status code.
GetLendingAnalysis
data GetLendingAnalysis Source #
See: newGetLendingAnalysis smart constructor.
Instances
newGetLendingAnalysis Source #
Arguments
| :: Text | |
| -> GetLendingAnalysis |
Create a value of GetLendingAnalysis 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:maxResults:GetLendingAnalysis', getLendingAnalysis_maxResults - 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, getLendingAnalysis_nextToken - 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.
$sel:jobId:GetLendingAnalysis', getLendingAnalysis_jobId - 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.
data GetLendingAnalysisResponse Source #
See: newGetLendingAnalysisResponse smart constructor.
Constructors
| GetLendingAnalysisResponse' (Maybe Text) (Maybe DocumentMetadata) (Maybe JobStatus) (Maybe Text) (Maybe [LendingResult]) (Maybe Text) (Maybe [Warning]) Int |
Instances
newGetLendingAnalysisResponse Source #
Create a value of GetLendingAnalysisResponse 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:analyzeLendingModelVersion:GetLendingAnalysisResponse', getLendingAnalysisResponse_analyzeLendingModelVersion - The current model version of the Analyze Lending API.
$sel:documentMetadata:GetLendingAnalysisResponse', getLendingAnalysisResponse_documentMetadata - Undocumented member.
$sel:jobStatus:GetLendingAnalysisResponse', getLendingAnalysisResponse_jobStatus - The current status of the lending analysis job.
GetLendingAnalysis, getLendingAnalysisResponse_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
lending results.
$sel:results:GetLendingAnalysisResponse', getLendingAnalysisResponse_results - Holds the information returned by one of AmazonTextract's document
analysis operations for the pinstripe.
$sel:statusMessage:GetLendingAnalysisResponse', getLendingAnalysisResponse_statusMessage - Returns if the lending analysis job could not be completed. Contains
explanation for what error occurred.
$sel:warnings:GetLendingAnalysisResponse', getLendingAnalysisResponse_warnings - A list of warnings that occurred during the lending analysis operation.
$sel:httpStatus:GetLendingAnalysisResponse', getLendingAnalysisResponse_httpStatus - The response's http status code.
GetLendingAnalysisSummary
data GetLendingAnalysisSummary Source #
See: newGetLendingAnalysisSummary smart constructor.
Constructors
| GetLendingAnalysisSummary' Text |
Instances
newGetLendingAnalysisSummary Source #
Create a value of GetLendingAnalysisSummary 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:GetLendingAnalysisSummary', getLendingAnalysisSummary_jobId - 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.
data GetLendingAnalysisSummaryResponse Source #
See: newGetLendingAnalysisSummaryResponse smart constructor.
Constructors
| GetLendingAnalysisSummaryResponse' (Maybe Text) (Maybe DocumentMetadata) (Maybe JobStatus) (Maybe Text) (Maybe LendingSummary) (Maybe [Warning]) Int |
Instances
newGetLendingAnalysisSummaryResponse Source #
Arguments
| :: Int | |
| -> GetLendingAnalysisSummaryResponse |
Create a value of GetLendingAnalysisSummaryResponse 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:analyzeLendingModelVersion:GetLendingAnalysisSummaryResponse', getLendingAnalysisSummaryResponse_analyzeLendingModelVersion - The current model version of the Analyze Lending API.
$sel:documentMetadata:GetLendingAnalysisSummaryResponse', getLendingAnalysisSummaryResponse_documentMetadata - Undocumented member.
$sel:jobStatus:GetLendingAnalysisSummaryResponse', getLendingAnalysisSummaryResponse_jobStatus - The current status of the lending analysis job.
$sel:statusMessage:GetLendingAnalysisSummaryResponse', getLendingAnalysisSummaryResponse_statusMessage - Returns if the lending analysis could not be completed. Contains
explanation for what error occurred.
$sel:summary:GetLendingAnalysisSummaryResponse', getLendingAnalysisSummaryResponse_summary - Contains summary information for documents grouped by type.
$sel:warnings:GetLendingAnalysisSummaryResponse', getLendingAnalysisSummaryResponse_warnings - A list of warnings that occurred during the lending analysis operation.
$sel:httpStatus:GetLendingAnalysisSummaryResponse', getLendingAnalysisSummaryResponse_httpStatus - The response's http status code.
StartDocumentAnalysis
data StartDocumentAnalysis Source #
See: newStartDocumentAnalysis smart constructor.
Constructors
| StartDocumentAnalysis' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe NotificationChannel) (Maybe OutputConfig) (Maybe QueriesConfig) 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: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: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: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:notificationChannel:StartDocumentAnalysis', startDocumentAnalysis_notificationChannel - The Amazon SNS topic ARN that you want Amazon Textract to publish the
completion status of the operation to.
$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:queriesConfig:StartDocumentAnalysis', startDocumentAnalysis_queriesConfig - Undocumented member.
$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.
StartDocumentTextDetection
data StartDocumentTextDetection Source #
See: newStartDocumentTextDetection smart constructor.
Constructors
| StartDocumentTextDetection' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe NotificationChannel) (Maybe OutputConfig) 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: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: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: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:notificationChannel:StartDocumentTextDetection', startDocumentTextDetection_notificationChannel - The Amazon SNS topic ARN that you want Amazon Textract to publish the
completion status of the operation to.
$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: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.
StartExpenseAnalysis
data StartExpenseAnalysis Source #
See: newStartExpenseAnalysis smart constructor.
Constructors
| StartExpenseAnalysis' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe NotificationChannel) (Maybe OutputConfig) DocumentLocation |
Instances
newStartExpenseAnalysis Source #
Create a value of StartExpenseAnalysis 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:clientRequestToken:StartExpenseAnalysis', startExpenseAnalysis_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:jobTag:StartExpenseAnalysis', startExpenseAnalysis_jobTag - 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).
$sel:kmsKeyId:StartExpenseAnalysis', startExpenseAnalysis_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:notificationChannel:StartExpenseAnalysis', startExpenseAnalysis_notificationChannel - The Amazon SNS topic ARN that you want Amazon Textract to publish the
completion status of the operation to.
$sel:outputConfig:StartExpenseAnalysis', startExpenseAnalysis_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
GetExpenseAnalysis operation.
$sel:documentLocation:StartExpenseAnalysis', startExpenseAnalysis_documentLocation - The location of the document to be processed.
data StartExpenseAnalysisResponse Source #
See: newStartExpenseAnalysisResponse smart constructor.
Constructors
| StartExpenseAnalysisResponse' (Maybe Text) Int |
Instances
newStartExpenseAnalysisResponse Source #
Create a value of StartExpenseAnalysisResponse 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:StartExpenseAnalysisResponse', startExpenseAnalysisResponse_jobId - A unique identifier for the text detection job. The JobId is returned
from StartExpenseAnalysis. A JobId value is only valid for 7 days.
$sel:httpStatus:StartExpenseAnalysisResponse', startExpenseAnalysisResponse_httpStatus - The response's http status code.
StartLendingAnalysis
data StartLendingAnalysis Source #
See: newStartLendingAnalysis smart constructor.
Constructors
| StartLendingAnalysis' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe NotificationChannel) (Maybe OutputConfig) DocumentLocation |
Instances
newStartLendingAnalysis Source #
Create a value of StartLendingAnalysis 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:clientRequestToken:StartLendingAnalysis', startLendingAnalysis_clientRequestToken - 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.
$sel:jobTag:StartLendingAnalysis', startLendingAnalysis_jobTag - 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).
$sel:kmsKeyId:StartLendingAnalysis', startLendingAnalysis_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:notificationChannel:StartLendingAnalysis', startLendingAnalysis_notificationChannel - Undocumented member.
$sel:outputConfig:StartLendingAnalysis', startLendingAnalysis_outputConfig - Undocumented member.
$sel:documentLocation:StartLendingAnalysis', startLendingAnalysis_documentLocation - Undocumented member.
data StartLendingAnalysisResponse Source #
See: newStartLendingAnalysisResponse smart constructor.
Constructors
| StartLendingAnalysisResponse' (Maybe Text) Int |
Instances
newStartLendingAnalysisResponse Source #
Create a value of StartLendingAnalysisResponse 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:StartLendingAnalysisResponse', startLendingAnalysisResponse_jobId - 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.
$sel:httpStatus:StartLendingAnalysisResponse', startLendingAnalysisResponse_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_MERGED_CELL :: BlockType | |
| pattern BlockType_PAGE :: BlockType | |
| pattern BlockType_QUERY :: BlockType | |
| pattern BlockType_QUERY_RESULT :: BlockType | |
| pattern BlockType_SELECTION_ELEMENT :: BlockType | |
| pattern BlockType_SIGNATURE :: BlockType | |
| pattern BlockType_TABLE :: BlockType | |
| pattern BlockType_TITLE :: 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_COLUMN_HEADER :: EntityType | |
| pattern EntityType_KEY :: EntityType | |
| pattern EntityType_VALUE :: EntityType |
Instances
FeatureType
newtype FeatureType Source #
Constructors
| FeatureType' | |
Fields | |
Bundled Patterns
| pattern FeatureType_FORMS :: FeatureType | |
| pattern FeatureType_QUERIES :: FeatureType | |
| pattern FeatureType_SIGNATURES :: 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_ANSWER :: RelationshipType | |
| pattern RelationshipType_CHILD :: RelationshipType | |
| pattern RelationshipType_COMPLEX_FEATURES :: RelationshipType | |
| pattern RelationshipType_MERGED_CELL :: RelationshipType | |
| pattern RelationshipType_TITLE :: 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
ValueType
Constructors
| ValueType' | |
Fields | |
Bundled Patterns
| pattern ValueType_DATE :: ValueType |
Instances
AnalyzeIDDetections
data AnalyzeIDDetections Source #
Used to contain the information detected by an AnalyzeID operation.
See: newAnalyzeIDDetections smart constructor.
Constructors
| AnalyzeIDDetections' (Maybe Double) (Maybe NormalizedValue) Text |
Instances
newAnalyzeIDDetections Source #
Arguments
| :: Text | |
| -> AnalyzeIDDetections |
Create a value of AnalyzeIDDetections 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:confidence:AnalyzeIDDetections', analyzeIDDetections_confidence - The confidence score of the detected text.
$sel:normalizedValue:AnalyzeIDDetections', analyzeIDDetections_normalizedValue - Only returned for dates, returns the type of value detected and the date
written in a more machine readable way.
$sel:text:AnalyzeIDDetections', analyzeIDDetections_text - Text of either the normalized field or value associated with it.
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 BlockType) (Maybe Natural) (Maybe Natural) (Maybe Double) (Maybe [EntityType]) (Maybe Geometry) (Maybe Text) (Maybe Natural) (Maybe Query) (Maybe [Relationship]) (Maybe Natural) (Maybe Natural) (Maybe SelectionStatus) (Maybe Text) (Maybe TextType) |
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: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. - 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.
$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: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: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: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: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:id:Block', block_id - The identifier for the recognized text. The identifier is only unique
for a single operation.
$sel:page:Block', block_page - 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.
$sel:query:Block', block_query -
$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: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: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.
Block, block_text - The word or line of text that's recognized by Amazon Textract.
$sel:textType:Block', block_textType - The kind of text that Amazon Textract has detected. Can check for
handwritten text and printed text.
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:top:BoundingBox', boundingBox_top - The top coordinate of the bounding box as a ratio of overall document
page height.
$sel:width:BoundingBox', boundingBox_width - The width of the bounding box as a ratio of the overall document page
width.
DetectedSignature
data DetectedSignature Source #
A structure that holds information regarding a detected signature on a page.
See: newDetectedSignature smart constructor.
Constructors
| DetectedSignature' (Maybe Natural) |
Instances
newDetectedSignature :: DetectedSignature Source #
Create a value of DetectedSignature 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:page:DetectedSignature', detectedSignature_page - The page a detected signature was found on.
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
| ToJSON Document Source # | |
Defined in Amazonka.Textract.Types.Document | |
| Generic Document Source # | |
| Read Document Source # | |
| Show Document Source # | |
| NFData Document Source # | |
Defined in Amazonka.Textract.Types.Document | |
| Eq Document Source # | |
| Hashable 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" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "Document'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :*: S1 ('MetaSel ('Just "s3Object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Object)))) | |
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: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.
$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.
DocumentGroup
data DocumentGroup Source #
Summary information about documents grouped by the same document type.
See: newDocumentGroup smart constructor.
Constructors
| DocumentGroup' (Maybe [DetectedSignature]) (Maybe [SplitDocument]) (Maybe Text) (Maybe [UndetectedSignature]) |
Instances
newDocumentGroup :: DocumentGroup Source #
Create a value of DocumentGroup 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:detectedSignatures:DocumentGroup', documentGroup_detectedSignatures - A list of the detected signatures found in a document group.
$sel:splitDocuments:DocumentGroup', documentGroup_splitDocuments - An array that contains information about the pages of a document,
defined by logical boundary.
$sel:type':DocumentGroup', documentGroup_type - The type of document that Amazon Textract has detected. See LINK for a
list of all types returned by Textract.
$sel:undetectedSignatures:DocumentGroup', documentGroup_undetectedSignatures - A list of any expected signatures not found in a document group.
DocumentLocation
data DocumentLocation Source #
The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations.
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.
ExpenseCurrency
data ExpenseCurrency Source #
Returns the kind of currency detected.
See: newExpenseCurrency smart constructor.
Constructors
| ExpenseCurrency' (Maybe Text) (Maybe Double) |
Instances
newExpenseCurrency :: ExpenseCurrency Source #
Create a value of ExpenseCurrency 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:code:ExpenseCurrency', expenseCurrency_code - Currency code for detected currency. the current supported codes are:
- USD
- EUR
- GBP
- CAD
- INR
- JPY
- CHF
- AUD
- CNY
- BZR
- SEK
- HKD
$sel:confidence:ExpenseCurrency', expenseCurrency_confidence - Percentage confideence in the detected currency.
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:confidence:ExpenseDetection', expenseDetection_confidence - The confidence in detection, as a percentage
$sel:geometry:ExpenseDetection', expenseDetection_geometry - Undocumented member.
$sel:text:ExpenseDetection', expenseDetection_text - The word or line of text recognized by Amazon Textract
ExpenseDocument
data ExpenseDocument Source #
The structure holding all the information returned by AnalyzeExpense
See: newExpenseDocument smart constructor.
Constructors
| ExpenseDocument' (Maybe [Block]) (Maybe Natural) (Maybe [LineItemGroup]) (Maybe [ExpenseField]) |
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:blocks:ExpenseDocument', expenseDocument_blocks - This is a block object, the same as reported when DetectDocumentText is
run on a document. It provides word level recognition of text.
$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.
$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.
ExpenseField
data ExpenseField Source #
Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection
See: newExpenseField smart constructor.
Constructors
| ExpenseField' (Maybe ExpenseCurrency) (Maybe [ExpenseGroupProperty]) (Maybe ExpenseDetection) (Maybe Natural) (Maybe ExpenseType) (Maybe ExpenseDetection) |
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:currency:ExpenseField', expenseField_currency - Shows the kind of currency, both the code and confidence associated with
any monatary value detected.
$sel:groupProperties:ExpenseField', expenseField_groupProperties - 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.
$sel:labelDetection:ExpenseField', expenseField_labelDetection - The explicitly stated label of a detected element.
$sel:pageNumber:ExpenseField', expenseField_pageNumber - The page number the value was detected on.
$sel:type':ExpenseField', expenseField_type - The implied label of a detected element. Present alongside
LabelDetection for explicit elements.
$sel:valueDetection:ExpenseField', expenseField_valueDetection - The value of a detected element. Present in explicit and implicit
elements.
ExpenseGroupProperty
data ExpenseGroupProperty Source #
Shows the group that a certain key belongs to. This helps differentiate between names and addresses for different organizations, that can be hard to determine via JSON response.
See: newExpenseGroupProperty smart constructor.
Constructors
| ExpenseGroupProperty' (Maybe Text) (Maybe [Text]) |
Instances
newExpenseGroupProperty :: ExpenseGroupProperty Source #
Create a value of ExpenseGroupProperty 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:id:ExpenseGroupProperty', expenseGroupProperty_id - Provides a group Id number, which will be the same for each in the
group.
$sel:types:ExpenseGroupProperty', expenseGroupProperty_types - Informs you on whether the expense group is a name or an address.
ExpenseType
data ExpenseType Source #
An object used to store information about the Type detected by Amazon Textract.
See: newExpenseType smart constructor.
Constructors
| ExpenseType' (Maybe Double) (Maybe Text) |
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:confidence:ExpenseType', expenseType_confidence - The confidence of accuracy, as a percentage.
$sel:text:ExpenseType', expenseType_text - The word or line of text detected by Amazon Textract.
Extraction
data Extraction Source #
Contains information extracted by an analysis operation after using StartLendingAnalysis.
See: newExtraction smart constructor.
Constructors
| Extraction' (Maybe ExpenseDocument) (Maybe IdentityDocument) (Maybe LendingDocument) |
Instances
newExtraction :: Extraction Source #
Create a value of Extraction 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:expenseDocument:Extraction', extraction_expenseDocument - Undocumented member.
$sel:identityDocument:Extraction', extraction_identityDocument - Undocumented member.
$sel:lendingDocument:Extraction', extraction_lendingDocument - Holds the structured data returned by AnalyzeDocument for lending
documents.
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
| FromJSON Geometry Source # | |
| Generic Geometry Source # | |
| Read Geometry Source # | |
| Show Geometry Source # | |
| NFData Geometry Source # | |
Defined in Amazonka.Textract.Types.Geometry | |
| Eq Geometry Source # | |
| Hashable Geometry Source # | |
Defined in Amazonka.Textract.Types.Geometry | |
| type Rep Geometry Source # | |
Defined in Amazonka.Textract.Types.Geometry type Rep Geometry = D1 ('MetaData "Geometry" "Amazonka.Textract.Types.Geometry" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" '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:humanLoopActivationConditionsEvaluationResults:HumanLoopActivationOutput', humanLoopActivationOutput_humanLoopActivationConditionsEvaluationResults - Shows the result of condition evaluations, including those conditions
which activated a human review.
$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.
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.
IdentityDocument
data IdentityDocument Source #
The structure that lists each document processed in an AnalyzeID operation.
See: newIdentityDocument smart constructor.
Constructors
| IdentityDocument' (Maybe [Block]) (Maybe Natural) (Maybe [IdentityDocumentField]) |
Instances
newIdentityDocument :: IdentityDocument Source #
Create a value of IdentityDocument 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:blocks:IdentityDocument', identityDocument_blocks - Individual word recognition, as returned by document detection.
$sel:documentIndex:IdentityDocument', identityDocument_documentIndex - Denotes the placement of a document in the IdentityDocument list. The
first document is marked 1, the second 2 and so on.
$sel:identityDocumentFields:IdentityDocument', identityDocument_identityDocumentFields - The structure used to record information extracted from identity
documents. Contains both normalized field and value of the extracted
text.
IdentityDocumentField
data IdentityDocumentField Source #
Structure containing both the normalized type of the extracted information and the text associated with it. These are extracted as Type and Value respectively.
See: newIdentityDocumentField smart constructor.
Constructors
| IdentityDocumentField' (Maybe AnalyzeIDDetections) (Maybe AnalyzeIDDetections) |
Instances
newIdentityDocumentField :: IdentityDocumentField Source #
Create a value of IdentityDocumentField 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:type':IdentityDocumentField', identityDocumentField_type - Undocumented member.
$sel:valueDetection:IdentityDocumentField', identityDocumentField_valueDetection - Undocumented member.
LendingDetection
data LendingDetection Source #
The results extracted for a lending document.
See: newLendingDetection smart constructor.
Constructors
| LendingDetection' (Maybe Double) (Maybe Geometry) (Maybe SelectionStatus) (Maybe Text) |
Instances
newLendingDetection :: LendingDetection Source #
Create a value of LendingDetection 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:confidence:LendingDetection', lendingDetection_confidence - The confidence level for the text of a detected value in a lending
document.
$sel:geometry:LendingDetection', lendingDetection_geometry - Undocumented member.
$sel:selectionStatus:LendingDetection', lendingDetection_selectionStatus - The selection status of a selection element, such as an option button or
check box.
$sel:text:LendingDetection', lendingDetection_text - The text extracted for a detected value in a lending document.
LendingDocument
data LendingDocument Source #
Holds the structured data returned by AnalyzeDocument for lending documents.
See: newLendingDocument smart constructor.
Constructors
| LendingDocument' (Maybe [LendingField]) (Maybe [SignatureDetection]) |
Instances
newLendingDocument :: LendingDocument Source #
Create a value of LendingDocument 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:lendingFields:LendingDocument', lendingDocument_lendingFields - An array of LendingField objects.
$sel:signatureDetections:LendingDocument', lendingDocument_signatureDetections - A list of signatures detected in a lending document.
LendingField
data LendingField Source #
Holds the normalized key-value pairs returned by AnalyzeDocument, including the document type, detected text, and geometry.
See: newLendingField smart constructor.
Constructors
| LendingField' (Maybe LendingDetection) (Maybe Text) (Maybe [LendingDetection]) |
Instances
newLendingField :: LendingField Source #
Create a value of LendingField 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:keyDetection:LendingField', lendingField_keyDetection - Undocumented member.
$sel:type':LendingField', lendingField_type - The type of the lending document.
$sel:valueDetections:LendingField', lendingField_valueDetections - An array of LendingDetection objects.
LendingResult
data LendingResult Source #
Contains the detections for each page analyzed through the Analyze Lending API.
See: newLendingResult smart constructor.
Constructors
| LendingResult' (Maybe [Extraction]) (Maybe Natural) (Maybe PageClassification) |
Instances
newLendingResult :: LendingResult Source #
Create a value of LendingResult 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:extractions:LendingResult', lendingResult_extractions - An array of Extraction to hold structured data. e.g. normalized key
value pairs instead of raw OCR detections .
$sel:page:LendingResult', lendingResult_page - The page number for a page, with regard to whole submission.
$sel:pageClassification:LendingResult', lendingResult_pageClassification - The classifier result for a given page.
LendingSummary
data LendingSummary Source #
Contains information regarding DocumentGroups and UndetectedDocumentTypes.
See: newLendingSummary smart constructor.
Constructors
| LendingSummary' (Maybe [DocumentGroup]) (Maybe [Text]) |
Instances
newLendingSummary :: LendingSummary Source #
Create a value of LendingSummary 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:documentGroups:LendingSummary', lendingSummary_documentGroups - Contains an array of all DocumentGroup objects.
$sel:undetectedDocumentTypes:LendingSummary', lendingSummary_undetectedDocumentTypes - UndetectedDocumentTypes.
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 Natural) (Maybe [LineItemFields]) |
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: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.
$sel:lineItems:LineItemGroup', lineItemGroup_lineItems - The breakdown of information on a particular line of a table.
NormalizedValue
data NormalizedValue Source #
Contains information relating to dates in a document, including the type of value, and the value.
See: newNormalizedValue smart constructor.
Constructors
| NormalizedValue' (Maybe Text) (Maybe ValueType) |
Instances
newNormalizedValue :: NormalizedValue Source #
Create a value of NormalizedValue 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:value:NormalizedValue', normalizedValue_value - The value of the date, written as Year-Month-DayTHour:Minute:Second.
$sel:valueType:NormalizedValue', normalizedValue_valueType - The normalized type of the value detected. In this case, DATE.
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.
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 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.
PageClassification
data PageClassification Source #
The class assigned to a Page object detected in an input document. Contains information regarding the predicted type/class of a document's page and the page number that the Page object was detected on.
See: newPageClassification smart constructor.
Constructors
| PageClassification' [Prediction] [Prediction] |
Instances
newPageClassification :: PageClassification Source #
Create a value of PageClassification 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:pageType:PageClassification', pageClassification_pageType - The class, or document type, assigned to a detected Page object. The
class, or document type, assigned to a detected Page object.
$sel:pageNumber:PageClassification', pageClassification_pageNumber - The page number the value was detected on, relative to Amazon
Textract's starting position.
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
| FromJSON Point Source # | |
| Generic Point Source # | |
| Read Point Source # | |
| Show Point Source # | |
| NFData Point Source # | |
Defined in Amazonka.Textract.Types.Point | |
| Eq Point Source # | |
| Hashable Point Source # | |
Defined in Amazonka.Textract.Types.Point | |
| type Rep Point Source # | |
Defined in Amazonka.Textract.Types.Point type Rep Point = D1 ('MetaData "Point" "Amazonka.Textract.Types.Point" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" '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.
Prediction
data Prediction Source #
Contains information regarding predicted values returned by Amazon Textract operations, including the predicted value and the confidence in the predicted value.
See: newPrediction smart constructor.
Constructors
| Prediction' (Maybe Double) (Maybe Text) |
Instances
newPrediction :: Prediction Source #
Create a value of Prediction 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:confidence:Prediction', prediction_confidence - Amazon Textract's confidence in its predicted value.
$sel:value:Prediction', prediction_value - The predicted value of a detected object.
QueriesConfig
data QueriesConfig Source #
See: newQueriesConfig smart constructor.
Constructors
| QueriesConfig' (NonEmpty Query) |
Instances
Arguments
| :: NonEmpty Query | |
| -> QueriesConfig |
Create a value of QueriesConfig 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:
Query
Each query contains the question you want to ask in the Text and the alias you want to associate.
See: newQuery smart constructor.
Instances
| FromJSON Query Source # | |
| ToJSON Query Source # | |
Defined in Amazonka.Textract.Types.Query | |
| Generic Query Source # | |
| Read Query Source # | |
| Show Query Source # | |
| NFData Query Source # | |
Defined in Amazonka.Textract.Types.Query | |
| Eq Query Source # | |
| Hashable Query Source # | |
Defined in Amazonka.Textract.Types.Query | |
| type Rep Query Source # | |
Defined in Amazonka.Textract.Types.Query type Rep Query = D1 ('MetaData "Query" "Amazonka.Textract.Types.Query" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "Query'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of Query 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:alias:Query', query_alias - Alias attached to the query, for ease of location.
$sel:pages:Query', query_pages - 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.
$sel:text:Query', query_text - Question that Amazon Textract will apply to the document. An example
would be "What is the customer's SSN?"
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
| ToJSON S3Object Source # | |
Defined in Amazonka.Textract.Types.S3Object | |
| Generic S3Object Source # | |
| Read S3Object Source # | |
| Show S3Object Source # | |
| NFData S3Object Source # | |
Defined in Amazonka.Textract.Types.S3Object | |
| Eq S3Object Source # | |
| Hashable 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" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" '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 and TIFF format files.
$sel:version:S3Object', s3Object_version - If the bucket has versioning enabled, you can specify the object
version.
SignatureDetection
data SignatureDetection Source #
Information regarding a detected signature on a page.
See: newSignatureDetection smart constructor.
Constructors
| SignatureDetection' (Maybe Double) (Maybe Geometry) |
Instances
newSignatureDetection :: SignatureDetection Source #
Create a value of SignatureDetection 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:confidence:SignatureDetection', signatureDetection_confidence - The confidence, from 0 to 100, in the predicted values for a detected
signature.
$sel:geometry:SignatureDetection', signatureDetection_geometry - Undocumented member.
SplitDocument
data SplitDocument Source #
Contains information about the pages of a document, defined by logical boundary.
See: newSplitDocument smart constructor.
Constructors
| SplitDocument' (Maybe Natural) (Maybe [Natural]) |
Instances
newSplitDocument :: SplitDocument Source #
Create a value of SplitDocument 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:index:SplitDocument', splitDocument_index - The index for a given document in a DocumentGroup of a specific Type.
$sel:pages:SplitDocument', splitDocument_pages - An array of page numbers for a for a given document, ordered by logical
boundary.
UndetectedSignature
data UndetectedSignature Source #
A structure containing information about an undetected signature on a page where it was expected but not found.
See: newUndetectedSignature smart constructor.
Constructors
| UndetectedSignature' (Maybe Natural) |
Instances
newUndetectedSignature :: UndetectedSignature Source #
Create a value of UndetectedSignature 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:page:UndetectedSignature', undetectedSignature_page - The page where a signature was expected but not found.
Warning
A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or asynchronous document text detection (StartDocumentTextDetection).
See: newWarning smart constructor.
Instances
| FromJSON Warning Source # | |
| Generic Warning Source # | |
| Read Warning Source # | |
| Show Warning Source # | |
| NFData Warning Source # | |
Defined in Amazonka.Textract.Types.Warning | |
| Eq Warning Source # | |
| Hashable Warning Source # | |
Defined in Amazonka.Textract.Types.Warning | |
| type Rep Warning Source # | |
Defined in Amazonka.Textract.Types.Warning type Rep Warning = D1 ('MetaData "Warning" "Amazonka.Textract.Types.Warning" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "Warning'" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Natural])))) | |
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:errorCode:Warning', warning_errorCode - The error code for the warning.
$sel:pages:Warning', warning_pages - A list of the pages that the warning applies to.