---
title: "OcrActivationMode"
canonical_url: "https://www.nutrient.io/api/python/enums/ocr-activation-mode/"
md_url: "https://www.nutrient.io/api/python/enums/ocr-activation-mode.md"
last_updated: "2026-06-12T15:43:20.744Z"
description: "Controls whether OCR resource loading and OCR-based word detection run inside the ICR image pipeline."
---

Controls whether OCR resource loading and OCR-based word detection run inside the ICR image pipeline.

```python

from nutrient_sdk import OcrActivationMode

```

## Values

| Name                            | Value | Description                                                                                                                                                                                                     |
| ------------------------------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `OcrActivationMode.AUTO`        | `0`   | OCR follows the pipeline: it runs when VLM augmentation is disabled (the ICR pipeline relies on OCR for text) and is skipped when VLM augmentation is enabled (the VLM supplies the text). This is the default. |
| `OcrActivationMode.ACTIVATED`   | `1`   | OCR always runs, regardless of whether VLM augmentation is enabled.                                                                                                                                             |
| `OcrActivationMode.DEACTIVATED` | `2`   | OCR never runs, regardless of whether VLM augmentation is enabled.                                                                                                                                              |

## Usage Example

```python

from nutrient_sdk import OcrActivationMode

# Access enum values

value = OcrActivationMode.AUTO
print(f"Value: {value}")  # Output: Value: OcrActivationMode.AUTO

print(f"Integer value: {value.value}")  # Output: Integer value: 0

```

---

## Related pages

- [Access enum values](/api/python/enums/description-level.md)
- [Access enum values](/api/python/enums/document-format.md)
- [Access enum values](/api/python/enums/document-bookmark-source.md)
- [Access enum values](/api/python/enums/document-type.md)
- [Access enum values](/api/python/enums/html-layout-type.md)
- [Access enum values](/api/python/enums/image-export-format.md)
- [Access enum values](/api/python/enums/document-markup-mode.md)
- [Access enum values](/api/python/enums/implicit-conversion.md)
- [Access enum values](/api/python/enums/image-export-mode.md)
- [Access enum values](/api/python/enums/image-setting-mode.md)
- [Access enum values](/api/python/enums/json-export-content.md)
- [Access enum values](/api/python/enums/instant-json-render-theme.md)
- [Access enum values](/api/python/enums/json-export-format.md)
- [Access enum values](/api/python/enums/pdf-border-style.md)
- [All public classes import directly from the top-level package:](/api/python/enums.md)
- [Access enum values](/api/python/enums/open-settings-mode.md)
- [Access enum values](/api/python/enums/pdf-line-ending-style.md)
- [Access enum values](/api/python/enums/page-cache-mode.md)
- [Access enum values](/api/python/enums/pdf-conformance.md)
- [Access enum values](/api/python/enums/pdf-compression.md)
- [Access enum values](/api/python/enums/pdf-page-sizes.md)
- [Access enum values](/api/python/enums/pdf-form-field-type.md)
- [Access enum values](/api/python/enums/pdf-rubber-stamp-icon.md)
- [Access enum values](/api/python/enums/pdf-save-preferences.md)
- [Access enum values](/api/python/enums/pdf-settings-mode.md)
- [Access enum values](/api/python/enums/rendering-layout-mode.md)
- [Access enum values](/api/python/enums/tiff-compression.md)
- [Access enum values](/api/python/enums/text-direction.md)
- [Access enum values](/api/python/enums/vision-features.md)
- [Access enum values](/api/python/enums/unit-mode.md)
- [Access enum values](/api/python/enums/signature-hash-algorithm.md)
- [Access enum values](/api/python/enums/vision-engine.md)
- [Access enum values](/api/python/enums/word-refining-method.md)
- [Access enum values](/api/python/enums/vision-output-format.md)
- [Access enum values](/api/python/enums/vlm-classification-strategy.md)
- [Access enum values](/api/python/enums/vlm-provider.md)