# OCR Engine (Engine `ocr`)

This engine provides jobs for text recognition.

* [ocr.DoDocOCR](ocr.md#ocr.DoDocOCR)
* [ocr.DoOCR](ocr.md#ocr.DoOCR)

<a id="ocr.DoDocOCR"></a>

## ocr.DoDocOCR

This job performs text recognition for the specified enaio® document and returns the recognized text as a text file.

### Input Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `Flags` | INT | Yes | Currently not supported — pass `0`. |
| `Type` | INT | Yes | `1` = multi-column texts (e.g., newspaper clippings) recognition; `0` = standard. |
| `DocID` | INT | Yes | ID of the document |
| `OutputUnicode` | INT | Yes | `1` = returned file is delivered as Unicode. |

### Output Files

| Name | Description |
|---|---|
| File list | Name and path of the text file with the recognized text |

### Return Value

(INT): 0 = Job successful, otherwise error code.

<a id="ocr.DoOCR"></a>

## ocr.DoOCR

This job performs text recognition for the passed file and returns the recognized text as a text file.

### Input Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `Flags` | INT | Yes | Currently not supported — pass `0`. |
| `Type` | INT | Yes | `1` = multi-column texts (e.g., newspaper clippings) recognition; `0` = standard. |
| `OutputUnicode` | INT | Yes | `1` = returned file is delivered as Unicode. |

### Input Files

| Name | Description |
|---|---|
| File list | Name and path of the file for which text recognition should be performed |

### Output Files

| Name | Description |
|---|---|
| File list | Name and path of the text file with the recognized text |

### Return Value

(INT): 0 = Job successful, otherwise error code.