SearchModelFactory.OcrSkill Method

Definition

A skill that extracts text from image files.

public static Azure.Search.Documents.Indexes.Models.OcrSkill OcrSkill(string name = default, string description = default, string context = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> inputs = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> outputs = default, Azure.Search.Documents.Indexes.Models.OcrSkillLanguage? defaultLanguageCode = default, bool? shouldDetectOrientation = default, Azure.Search.Documents.Indexes.Models.OcrLineEnding? lineEnding = default);
static member OcrSkill : string * string * string * seq<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> * seq<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> * Nullable<Azure.Search.Documents.Indexes.Models.OcrSkillLanguage> * Nullable<bool> * Nullable<Azure.Search.Documents.Indexes.Models.OcrLineEnding> -> Azure.Search.Documents.Indexes.Models.OcrSkill
Public Shared Function OcrSkill (Optional name As String = Nothing, Optional description As String = Nothing, Optional context As String = Nothing, Optional inputs As IEnumerable(Of InputFieldMappingEntry) = Nothing, Optional outputs As IEnumerable(Of OutputFieldMappingEntry) = Nothing, Optional defaultLanguageCode As Nullable(Of OcrSkillLanguage) = Nothing, Optional shouldDetectOrientation As Nullable(Of Boolean) = Nothing, Optional lineEnding As Nullable(Of OcrLineEnding) = Nothing) As OcrSkill

Parameters

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 '#'.

description
String

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

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.

inputs
IEnumerable<InputFieldMappingEntry>

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

outputs
IEnumerable<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.

defaultLanguageCode
Nullable<OcrSkillLanguage>

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

shouldDetectOrientation
Nullable<Boolean>

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

lineEnding
Nullable<OcrLineEnding>

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

Returns

A new OcrSkill instance for mocking.

Applies to