General Text OCR
Command description
Recognizes printed or handwritten text in image files, desktop elements, and web elements.
The result includes the coordinates of each recognized text region.
For example, you can send the text and coordinate data recognized from an invoice to an AI model for further analysis.
Command Input Parameters
| input parameters | Input parameter type | Description |
|---|---|---|
| Image Type | enum | General Text, Handwritten Text |
| Image Source | enum | Local File, Desktop Element, Web Element |
| Image Path | str | Full path to the local image; required when Image Source is Local File |
| Desktop Element | WinElement or str (captured element UID, not element name, not ms-rpa-id) | Desktop element to analyze; required when Image Source is Desktop Element. Select a captured element or one returned by Get Desktop Element, Get Related Desktop Elements, or Get Similar Desktop Elements. |
| Webpage Object | WebPage | Webpage containing the element; required when Image Source is Web Element |
| Web Element | WebElement or str (captured element UID, not element name, not ms-rpa-id) | Web element to analyze; required when Image Source is Web Element. Select a captured element or one returned by Get Web Element, Get Similar Web Elements, or Get Related Web Elements. |
Command Output Parameters
| Output parameters | Output parameter type | Description |
|---|---|---|
| Recognition Result | list[TextOCR] | List of recognized text regions; each item is a TextOCR object |
Type definition reference
Example
Output recognition results