ABBYY Cloud
ABBYY Cloud package provides cloud-based OCR and document processing capabilities. Process images, documents, barcodes, business cards, receipts, and more using ABBYY's cloud API.
Prerequisites
Before using ABBYY Cloud nodes, you need to:
- Sign up for an ABBYY Cloud OCR SDK account at ABBYY Cloud OCR
- Obtain your Application ID and Password from the ABBYY Cloud console
- Configure credentials in the
credentials.yamlfile:
applicationId: your-application-id
password: your-password
Available Nodes
Image Processing
- Process Image - Extract text from images with OCR in various output formats
- Process Text - Advanced text field recognition with custom settings
- Submit Image - Submit additional images to existing tasks
Document Processing
- Process Document - Full document OCR with advanced options and multiple export formats
- Process Field - Extract specific fields from submitted document images
Specialized Recognition
- Process Barcode - Detect and decode barcodes from images
- Process Business Card - Extract contact information from business cards
- Process Receipt - Extract transaction data from receipt images
- Process MRZ - Read Machine Readable Zones from passports and ID cards
- Process Checkmark - Detect and recognize checkmarks in forms
Task Management
- Get Task Status - Check the status of a processing task
- Wait Task - Wait for a task to complete with polling
- Delete Task - Delete a completed or pending task
Common Workflow Patterns
Simple Image OCR
- Use Process Image to upload and process an image
- Use Wait Task to wait for processing to complete
- Access the results from the task output
- Use Delete Task to clean up
Multi-Page Document Processing
- Use Process Image to submit the first page
- Use Submit Image to add additional pages to the task
- Use Process Document to process all pages together
- Use Wait Task to wait for completion
- Use Delete Task to clean up
Form Processing with Fields
- Use Process Text to recognize specific text fields
- Use Process Checkmark to detect checked boxes
- Use Process Barcode for barcode fields
- Combine results for complete form data extraction
Supported Languages
ABBYY Cloud supports over 200 recognition languages including:
- English, Spanish, French, German, Italian, Portuguese
- Chinese (Simplified & Traditional), Japanese, Korean
- Russian, Arabic, Hebrew, Thai, Vietnamese
- And many more...
Export Formats
Documents can be exported in various formats:
- Text: txt, txtUnstructured
- Documents: rtf, docx, xlsx, pptx
- PDF: pdfSearchable, pdfTextAndImages, pdfa
- Structured: xml, xmlForCorrectedImage, alto
Best Practices
- Image Quality: Use high-resolution, well-lit images for best OCR accuracy
- Language Selection: Always specify the correct language for optimal results
- Task Cleanup: Delete tasks after processing to manage your cloud quota
- Error Handling: Enable "Continue On Error" for robust automation workflows
- Polling Strategy: Adjust poll time based on document complexity and size
Error Handling
All nodes return specific error codes:
Robomotion.ABBYYCloud.ErrImagePath- Invalid or missing image file pathRobomotion.ABBYYCloud.ErrImageData- Cannot read image file dataRobomotion.ABBYYCloud.ErrTaskID- Invalid or missing task IDRobomotion.ABBYYCloud.ErrOption- Invalid option parametersCore.ABBYYCloud.ErrTimeout- Task processing timeoutCore.ABBYYCloud.ErrRequest- API request failed
Delete Task
Robomotion.ABBYYCloud.DeleteTask
Get Task Status
Robomotion.ABBYYCloud.TaskStatus
Process Barcode
Robomotion.ABBYYCloud.ProcessBarcode
Process Business Card
Robomotion.ABBYYCloud.ProcessBusinessCard
Process Checkmark
Robomotion.ABBYYCloud.ProcessCheckmark
Process Document
Robomotion.ABBYYCloud.ProcessDocument
Process Field
Robomotion.ABBYYCloud.ProcessField
Process Image
Robomotion.ABBYYCloud.ProcessImage
Process MRZ
Robomotion.ABBYYCloud.ProcessMRZ
Process Receipt
Robomotion.ABBYYCloud.ProcessReceipt
Process Text
Robomotion.ABBYYCloud.ProcessText
Submit Image
Robomotion.ABBYYCloud.SubmitImage
Wait Task
Robomotion.ABBYYCloud.WaitTask