Nuix · Schema

OcrTemplateDetails

Schema for OcrTemplateDetails in Nuix REST API

ForensicseDiscoveryInvestigationsComplianceData ProcessingLegal TechnologyIntelligence

Properties

Name	Type	Description
id	string	The id of the template.
name	string	The name of the template.
description	string	The template description.
appendText	boolean	Gets whether to append text to item.
updateText	boolean	Gets whether to update item text.
updatePdf	boolean	Gets whether to update PDF.
pageRotation	string	Gets the page rotation of the printed image.
textRotations	array	Gets the text page rotations.
multiProcessingMode	string	Gets the multi-processing mode.
languages	array	Gets the languages.
deskew	boolean	Gets whether to deskew.
autoPageRotationEnabled	boolean	Gets whether to use auto page rotation.
customPageRotationEnabled	boolean	Gets whether to use custom page rotation.
noPageRotationEnabled	boolean	Gets whether to OCR without rotating.
clockwisePageRotationEnabled	boolean	Gets whether to run OCR with clockwise rotation.
counterClockwisePageRotationEnabled	boolean	Gets whether to run OCR with counter-clockwise rotation.
oneEightyPageRotationEnabled	boolean	Gets whether to run OCR with upside-down rotation.
ocrProcessingProfile	string	Gets the OCR processing profile provided by Abbyy.
timeout	integer	Gets the timeout duration.
printedImageRotation	string	Gets the printed image rotation.
useNative	boolean	Gets whether to use native item for OCR.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nuix/refs/heads/main/json-schema/nuix-rest-ocrtemplatedetails.json",
  "title": "OcrTemplateDetails",
  "description": "Schema for OcrTemplateDetails in Nuix REST API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The id of the template."
    },
    "name": {
      "type": "string",
      "description": "The name of the template."
    },
    "description": {
      "type": "string",
      "description": "The template description."
    },
    "appendText": {
      "type": "boolean",
      "description": "Gets whether to append text to item."
    },
    "updateText": {
      "type": "boolean",
      "description": "Gets whether to update item text."
    },
    "updatePdf": {
      "type": "boolean",
      "description": "Gets whether to update PDF."
    },
    "pageRotation": {
      "type": "string",
      "description": "Gets the page rotation of the printed image.",
      "deprecated": true
    },
    "textRotations": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Gets the text page rotations."
    },
    "multiProcessingMode": {
      "type": "string",
      "description": "Gets the multi-processing mode."
    },
    "languages": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Gets the languages."
    },
    "deskew": {
      "type": "boolean",
      "description": "Gets whether to deskew."
    },
    "autoPageRotationEnabled": {
      "type": "boolean",
      "description": "Gets whether to use auto page rotation."
    },
    "customPageRotationEnabled": {
      "type": "boolean",
      "description": "Gets whether to use custom page rotation."
    },
    "noPageRotationEnabled": {
      "type": "boolean",
      "description": "Gets whether to OCR without rotating."
    },
    "clockwisePageRotationEnabled": {
      "type": "boolean",
      "description": "Gets whether to run OCR with clockwise rotation."
    },
    "counterClockwisePageRotationEnabled": {
      "type": "boolean",
      "description": "Gets whether to run OCR with counter-clockwise rotation."
    },
    "oneEightyPageRotationEnabled": {
      "type": "boolean",
      "description": "Gets whether to run OCR with upside-down rotation."
    },
    "ocrProcessingProfile": {
      "type": "string",
      "description": "Gets the OCR processing profile provided by Abbyy."
    },
    "timeout": {
      "type": "integer",
      "description": "Gets the timeout duration."
    },
    "printedImageRotation": {
      "type": "string",
      "description": "Gets the printed image rotation."
    },
    "useNative": {
      "type": "boolean",
      "description": "Gets whether to use native item for OCR."
    }
  }
}