SearchIndexerSkill | @azure/search-documents

Base type for skills. Contains the possible cases for Skill.

Hierarchy

SearchIndexerSkill

Index

Properties

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 description

description: undefined | 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.

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

odatatype: "#Microsoft.Skills.Util.ConditionalSkill" | "#Microsoft.Skills.Text.KeyPhraseExtractionSkill" | "#Microsoft.Skills.Vision.OcrSkill" | "#Microsoft.Skills.Vision.ImageAnalysisSkill" | "#Microsoft.Skills.Text.LanguageDetectionSkill" | "#Microsoft.Skills.Util.ShaperSkill" | "#Microsoft.Skills.Text.MergeSkill" | "#Microsoft.Skills.Text.EntityRecognitionSkill" | "#Microsoft.Skills.Text.SentimentSkill" | "#Microsoft.Skills.Text.V3.SentimentSkill" | "#Microsoft.Skills.Text.V3.EntityLinkingSkill" | "#Microsoft.Skills.Text.V3.EntityRecognitionSkill" | "#Microsoft.Skills.Text.PIIDetectionSkill" | "#Microsoft.Skills.Text.SplitSkill" | "#Microsoft.Skills.Text.CustomEntityLookupSkill" | "#Microsoft.Skills.Text.TranslationSkill" | "#Microsoft.Skills.Util.DocumentExtractionSkill" | "#Microsoft.Skills.Custom.WebApiSkill"

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.