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.GetDocumentAnalysis

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.

You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentAnalysis. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

GetDocumentAnalysis returns an array of Block objects. The following types of information are returned:

Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, /Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina/ is the value.
Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.
Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of the StartDocumentAnalysis FeatureTypes input parameter).
Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.
Query Results. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

While processing a document with queries, look out for INVALID_REQUEST_PARAMETERS output. This indicates that either the per page query limit has been exceeded or that the operation is trying to query a page in the document which doesn’t exist.

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.

Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentAnalysis.

For more information, see Document Text Analysis.

Synopsis

Creating a Request

data GetDocumentAnalysis Source #

See: newGetDocumentAnalysis smart constructor.

Constructors

GetDocumentAnalysis'

Fields

maxResults :: Maybe Natural
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.
nextToken :: Maybe Text
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.
jobId :: Text
A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

Instances

Instances details

ToJSON GetDocumentAnalysis Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Methods toJSON :: GetDocumentAnalysis -> Value # toEncoding :: GetDocumentAnalysis -> Encoding # toJSONList :: [GetDocumentAnalysis] -> Value # toEncodingList :: [GetDocumentAnalysis] -> Encoding #
ToHeaders GetDocumentAnalysis Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Methods toHeaders :: GetDocumentAnalysis -> [Header] #
ToPath GetDocumentAnalysis Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Methods toPath :: GetDocumentAnalysis -> ByteString #
ToQuery GetDocumentAnalysis Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Methods toQuery :: GetDocumentAnalysis -> QueryString #
AWSRequest GetDocumentAnalysis Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Associated Types type AWSResponse GetDocumentAnalysis # Methods request :: (Service -> Service) -> GetDocumentAnalysis -> Request GetDocumentAnalysis # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDocumentAnalysis -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDocumentAnalysis))) #
Generic GetDocumentAnalysis Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Associated Types type Rep GetDocumentAnalysis :: Type -> Type # Methods from :: GetDocumentAnalysis -> Rep GetDocumentAnalysis x # to :: Rep GetDocumentAnalysis x -> GetDocumentAnalysis #
Read GetDocumentAnalysis Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Methods readsPrec :: Int -> ReadS GetDocumentAnalysis # readList :: ReadS [GetDocumentAnalysis] # readPrec :: ReadPrec GetDocumentAnalysis # readListPrec :: ReadPrec [GetDocumentAnalysis] #
Show GetDocumentAnalysis Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Methods showsPrec :: Int -> GetDocumentAnalysis -> ShowS # show :: GetDocumentAnalysis -> String # showList :: [GetDocumentAnalysis] -> ShowS #
NFData GetDocumentAnalysis Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Methods rnf :: GetDocumentAnalysis -> () #
Eq GetDocumentAnalysis Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Methods (==) :: GetDocumentAnalysis -> GetDocumentAnalysis -> Bool # (/=) :: GetDocumentAnalysis -> GetDocumentAnalysis -> Bool #
Hashable GetDocumentAnalysis Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Methods hashWithSalt :: Int -> GetDocumentAnalysis -> Int # hash :: GetDocumentAnalysis -> Int #
type AWSResponse GetDocumentAnalysis Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis type AWSResponse GetDocumentAnalysis = GetDocumentAnalysisResponse
type Rep GetDocumentAnalysis Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis type Rep GetDocumentAnalysis = D1 ('MetaData "GetDocumentAnalysis" "Amazonka.Textract.GetDocumentAnalysis" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "GetDocumentAnalysis'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetDocumentAnalysis Source #

Arguments

:: Text	`$sel:jobId:GetDocumentAnalysis'`
-> 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.

Request Lenses

getDocumentAnalysis_maxResults :: Lens' GetDocumentAnalysis (Maybe Natural) Source #

The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

getDocumentAnalysis_nextToken :: Lens' GetDocumentAnalysis (Maybe Text) Source #

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

getDocumentAnalysis_jobId :: Lens' GetDocumentAnalysis Text Source #

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

Destructuring the Response

data GetDocumentAnalysisResponse Source #

See: newGetDocumentAnalysisResponse smart constructor.

Constructors

GetDocumentAnalysisResponse'

Fields

analyzeDocumentModelVersion :: Maybe Text
blocks :: Maybe [Block]
The results of the text-analysis operation.
documentMetadata :: Maybe DocumentMetadata
Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.
jobStatus :: Maybe JobStatus
The current status of the text detection job.
nextToken :: Maybe Text
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.
statusMessage :: Maybe Text
Returns if the detection job could not be completed. Contains explanation for what error occured.
warnings :: Maybe [Warning]
A list of warnings that occurred during the document-analysis operation.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetDocumentAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Associated Types type Rep GetDocumentAnalysisResponse :: Type -> Type # Methods from :: GetDocumentAnalysisResponse -> Rep GetDocumentAnalysisResponse x # to :: Rep GetDocumentAnalysisResponse x -> GetDocumentAnalysisResponse #
Read GetDocumentAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Methods readsPrec :: Int -> ReadS GetDocumentAnalysisResponse # readList :: ReadS [GetDocumentAnalysisResponse] # readPrec :: ReadPrec GetDocumentAnalysisResponse # readListPrec :: ReadPrec [GetDocumentAnalysisResponse] #
Show GetDocumentAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Methods showsPrec :: Int -> GetDocumentAnalysisResponse -> ShowS # show :: GetDocumentAnalysisResponse -> String # showList :: [GetDocumentAnalysisResponse] -> ShowS #
NFData GetDocumentAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Methods rnf :: GetDocumentAnalysisResponse -> () #
Eq GetDocumentAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis Methods (==) :: GetDocumentAnalysisResponse -> GetDocumentAnalysisResponse -> Bool # (/=) :: GetDocumentAnalysisResponse -> GetDocumentAnalysisResponse -> Bool #
type Rep GetDocumentAnalysisResponse Source #
Instance details Defined in Amazonka.Textract.GetDocumentAnalysis type Rep GetDocumentAnalysisResponse = D1 ('MetaData "GetDocumentAnalysisResponse" "Amazonka.Textract.GetDocumentAnalysis" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "GetDocumentAnalysisResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "analyzeDocumentModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "blocks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Block]))) :: (S1 ('MetaSel ('Just "documentMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentMetadata)) :: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Warning])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetDocumentAnalysisResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDocumentAnalysisResponse'`
-> GetDocumentAnalysisResponse

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.

Response Lenses

getDocumentAnalysisResponse_analyzeDocumentModelVersion :: Lens' GetDocumentAnalysisResponse (Maybe Text) Source #

getDocumentAnalysisResponse_blocks :: Lens' GetDocumentAnalysisResponse (Maybe [Block]) Source #

The results of the text-analysis operation.

getDocumentAnalysisResponse_documentMetadata :: Lens' GetDocumentAnalysisResponse (Maybe DocumentMetadata) Source #

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

getDocumentAnalysisResponse_jobStatus :: Lens' GetDocumentAnalysisResponse (Maybe JobStatus) Source #

The current status of the text detection job.

getDocumentAnalysisResponse_nextToken :: Lens' GetDocumentAnalysisResponse (Maybe Text) Source #

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.

getDocumentAnalysisResponse_statusMessage :: Lens' GetDocumentAnalysisResponse (Maybe Text) Source #

Returns if the detection job could not be completed. Contains explanation for what error occured.

getDocumentAnalysisResponse_warnings :: Lens' GetDocumentAnalysisResponse (Maybe [Warning]) Source #

A list of warnings that occurred during the document-analysis operation.

getDocumentAnalysisResponse_httpStatus :: Lens' GetDocumentAnalysisResponse Int Source #

The response's http status code.