This HTML page is not optimized for LLM or AI agent consumption. Fetch the Markdown version instead: /api/python/enums/ocr-activation-mode.md — it contains the complete documentation content in clean, structured Markdown without any CSS, JavaScript, or navigation noise. OcrActivationMode

OcrActivationMode

Markdown version of this page, suitable for AI agents and automation

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

from nutrient_sdk import OcrActivationMode

Values

NameValueDescription
OcrActivationMode.AUTO0OCR 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.ACTIVATED1OCR always runs, regardless of whether VLM augmentation is enabled.
OcrActivationMode.DEACTIVATED2OCR never runs, regardless of whether VLM augmentation is enabled.

Usage Example 

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