Extract text from an uploaded document through the
Amazon
Textract API.
You can automate the Intelligent Form Reader’s text detection and extraction step using this
invocable action.
Special Access Rules
This action is available in API version 58.0 and later for users with the
AWSTextract1000LimitAddOn or IntelligentDocumentReaderAddOn license.
Supported REST HTTP Methods
- URI
- /services/data/vXX.X/actions/standard/initiateTextExtraction
- Formats
- JSON, XML
- HTTP Methods
- POST
- Authentication
- Authorization: Bearer
token
Inputs
| contentDocumentId |
- Type
- string
- Description
- Required. The unique content document ID of the uploaded document to initiate text
extraction.
You can specify up to 20 content Document IDs.
|
| endPageIndex |
- Type
- integer
- Description
- Optional. The page number up to which the text must be extracted. The default value is
the last page number in the specified document.
|
| ocrService |
- Type
- picklist
- Description
- Optional. The name of the OCR service that extracts text from the document. Valid
values are:
-
AMAZON_TEXTRACT - Indicates AWS Document
service.
-
AMAZON_TEXTRACT_ANALYZE_ID - Indicates AWS
Analyze ID service.
|
| startPageIndex |
- Type
- integer
- Description
- Optional. The page number to start text extraction. By default, the starting page
number is 1.
You can extract text from up to 20 pages in a specified
document.
|
Outputs
| ocrDocumentScanResultDetails |
- Type
- string
- Description
- A comma-separated list containing an OcrDocumentScanResult ID and a page number for
each extracted page of the specified document.
|
Example
Sample Request
Sample Response