• Public
  • Public/Protected
  • All

Interface OcrSkill

Package version

A skill that extracts text from image files.


  • OcrSkill



Optional context

context: undefined | string

Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.

Optional defaultLanguageCode

defaultLanguageCode: OcrSkillLanguage

A value indicating which language code to use. Default is en. Possible values include: 'zh-Hans', 'zh-Hant', 'cs', 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu', 'it', 'ja', 'ko', 'nb', 'pl', 'pt', 'ru', 'es', 'sv', 'tr', 'ar', 'ro', 'sr-Cyrl', 'sr-Latn', 'sk'

Optional description

description: undefined | string

The description of the skill which describes the inputs, outputs, and usage of the skill.


Inputs of the skills could be a column in the source data set, or the output of an upstream skill.

Optional name

name: undefined | string

The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.


odatatype: "#Microsoft.Skills.Vision.OcrSkill"

Polymorphic Discriminator


The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.

Optional shouldDetectOrientation

shouldDetectOrientation: undefined | false | true

A value indicating to turn orientation detection on or not. Default is false. Default value: false.

Optional textExtractionAlgorithm

textExtractionAlgorithm: TextExtractionAlgorithm

A value indicating which algorithm to use for extracting text. Default is printed. Possible values include: 'printed', 'handwritten'

Generated using TypeDoc