Package version:

Interface OcrSkill

A skill that extracts text from image files.

interface OcrSkill {
    context?: string;
    defaultLanguageCode?:
        | "da"
        | "de"
        | "en"
        | "es"
        | "fi"
        | "fr"
        | "it"
        | "ko"
        | "pt"
        | "ar"
        | "cs"
        | "zh-Hans"
        | "zh-Hant"
        | "nl"
        | "el"
        | "hu"
        | "ja"
        | "no"
        | "pl"
        | "ru"
        | "sv"
        | "tr"
        | "az"
        | "bg"
        | "bs"
        | "ca"
        | "cy"
        | "et"
        | "eu"
        | "ga"
        | "gl"
        | "hi"
        | "hr"
        | "id"
        | "lt"
        | "ms"
        | "nb"
        | "prs"
        | "ro"
        | "sk"
        | "sl"
        | "sr-Cyrl"
        | "sr-Latn"
        | "af"
        | "sq"
        | "anp"
        | "ast"
        | "awa"
        | "bfy"
        | "be"
        | "be-cyrl"
        | "be-latn"
        | "bho"
        | "bi"
        | "brx"
        | "bra"
        | "br"
        | "bns"
        | "bua"
        | "ceb"
        | "rab"
        | "ch"
        | "hne"
        | "kw"
        | "co"
        | "crh"
        | "dhi"
        | "doi"
        | "myv"
        | "fo"
        | "fj"
        | "fil"
        | "fur"
        | "gag"
        | "gil"
        | "gon"
        | "kl"
        | "gvr"
        | "ht"
        | "hlb"
        | "hni"
        | "bgc"
        | "haw"
        | "mww"
        | "hoc"
        | "is"
        | "smn"
        | "ia"
        | "iu"
        | "Jns"
        | "jv"
        | "kea"
        | "kac"
        | "xnr"
        | "krc"
        | "kaa-cyrl"
        | "kaa"
        | "csb"
        | "kk-cyrl"
        | "kk-latn"
        | "klr"
        | "kha"
        | "quc"
        | "kfq"
        | "kpy"
        | "kos"
        | "kum"
        | "ku-arab"
        | "ku-latn"
        | "kru"
        | "ky"
        | "lkt"
        | "la"
        | "dsb"
        | "smj"
        | "lb"
        | "bfz"
        | "mt"
        | "kmj"
        | "gv"
        | "mi"
        | "mr"
        | "mn"
        | "cnr-cyrl"
        | "cnr-latn"
        | "nap"
        | "ne"
        | "niu"
        | "nog"
        | "sme"
        | "oc"
        | "os"
        | "ps"
        | "fa"
        | "pa"
        | "ksh"
        | "rm"
        | "sck"
        | "sm"
        | "sa"
        | "sat"
        | "sco"
        | "gd"
        | "sr"
        | "xsr"
        | "srx"
        | "sms"
        | "so"
        | "sma"
        | "sw"
        | "tg"
        | "tt"
        | "tet"
        | "thf"
        | "to"
        | "tk"
        | "tyv"
        | "hsb"
        | "ur"
        | "ug"
        | "uz-arab"
        | "uz-cyrl"
        | "uz"
        | "vo"
        | "wae"
        | "fy"
        | "yua"
        | "za"
        | "zu"
        | "unk";
    description?: string;
    inputs: InputFieldMappingEntry[];
    lineEnding?: string;
    name?: string;
    odatatype: "#Microsoft.Skills.Vision.OcrSkill";
    outputs: OutputFieldMappingEntry[];
    shouldDetectOrientation?: boolean;
}

Hierarchy (view full)

Properties

context? defaultLanguageCode? description? inputs lineEnding? name? odatatype outputs shouldDetectOrientation?

Properties

Optionalcontext

context?: 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.

OptionaldefaultLanguageCode

defaultLanguageCode?:
    | "da"
    | "de"
    | "en"
    | "es"
    | "fi"
    | "fr"
    | "it"
    | "ko"
    | "pt"
    | "ar"
    | "cs"
    | "zh-Hans"
    | "zh-Hant"
    | "nl"
    | "el"
    | "hu"
    | "ja"
    | "no"
    | "pl"
    | "ru"
    | "sv"
    | "tr"
    | "az"
    | "bg"
    | "bs"
    | "ca"
    | "cy"
    | "et"
    | "eu"
    | "ga"
    | "gl"
    | "hi"
    | "hr"
    | "id"
    | "lt"
    | "ms"
    | "nb"
    | "prs"
    | "ro"
    | "sk"
    | "sl"
    | "sr-Cyrl"
    | "sr-Latn"
    | "af"
    | "sq"
    | "anp"
    | "ast"
    | "awa"
    | "bfy"
    | "be"
    | "be-cyrl"
    | "be-latn"
    | "bho"
    | "bi"
    | "brx"
    | "bra"
    | "br"
    | "bns"
    | "bua"
    | "ceb"
    | "rab"
    | "ch"
    | "hne"
    | "kw"
    | "co"
    | "crh"
    | "dhi"
    | "doi"
    | "myv"
    | "fo"
    | "fj"
    | "fil"
    | "fur"
    | "gag"
    | "gil"
    | "gon"
    | "kl"
    | "gvr"
    | "ht"
    | "hlb"
    | "hni"
    | "bgc"
    | "haw"
    | "mww"
    | "hoc"
    | "is"
    | "smn"
    | "ia"
    | "iu"
    | "Jns"
    | "jv"
    | "kea"
    | "kac"
    | "xnr"
    | "krc"
    | "kaa-cyrl"
    | "kaa"
    | "csb"
    | "kk-cyrl"
    | "kk-latn"
    | "klr"
    | "kha"
    | "quc"
    | "kfq"
    | "kpy"
    | "kos"
    | "kum"
    | "ku-arab"
    | "ku-latn"
    | "kru"
    | "ky"
    | "lkt"
    | "la"
    | "dsb"
    | "smj"
    | "lb"
    | "bfz"
    | "mt"
    | "kmj"
    | "gv"
    | "mi"
    | "mr"
    | "mn"
    | "cnr-cyrl"
    | "cnr-latn"
    | "nap"
    | "ne"
    | "niu"
    | "nog"
    | "sme"
    | "oc"
    | "os"
    | "ps"
    | "fa"
    | "pa"
    | "ksh"
    | "rm"
    | "sck"
    | "sm"
    | "sa"
    | "sat"
    | "sco"
    | "gd"
    | "sr"
    | "xsr"
    | "srx"
    | "sms"
    | "so"
    | "sma"
    | "sw"
    | "tg"
    | "tt"
    | "tet"
    | "thf"
    | "to"
    | "tk"
    | "tyv"
    | "hsb"
    | "ur"
    | "ug"
    | "uz-arab"
    | "uz-cyrl"
    | "uz"
    | "vo"
    | "wae"
    | "fy"
    | "yua"
    | "za"
    | "zu"
    | "unk"

A value indicating which language code to use. Default is en.

Optionaldescription

description?: string

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

inputs

inputs: InputFieldMappingEntry[]

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

OptionallineEnding

lineEnding?: string

Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is "space".

Optionalname

name?: 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

odatatype

Polymorphic discriminator, which specifies the different types this object can be

outputs

outputs: OutputFieldMappingEntry[]

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.

OptionalshouldDetectOrientation

shouldDetectOrientation?: boolean

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

Settings

Member Visibility