Package version:

Interface BaseSearchIndexerSkill

Base type for skills.

interface BaseSearchIndexerSkill {
    context?: string;
    description?: string;
    inputs: InputFieldMappingEntry[];
    name?: string;
    odatatype:
        | "#Microsoft.Skills.Util.ConditionalSkill"
        | "#Microsoft.Skills.Util.DocumentExtractionSkill"
        | "#Microsoft.Skills.Text.V3.EntityLinkingSkill"
        | "#Microsoft.Skills.Text.V3.EntityRecognitionSkill"
        | "#Microsoft.Skills.Text.LanguageDetectionSkill"
        | "#Microsoft.Skills.Text.MergeSkill"
        | "#Microsoft.Skills.Text.KeyPhraseExtractionSkill"
        | "#Microsoft.Skills.Vision.OcrSkill"
        | "#Microsoft.Skills.Vision.ImageAnalysisSkill"
        | "#Microsoft.Skills.Util.ShaperSkill"
        | "#Microsoft.Skills.Text.EntityRecognitionSkill"
        | "#Microsoft.Skills.Text.SentimentSkill"
        | "#Microsoft.Skills.Text.V3.SentimentSkill"
        | "#Microsoft.Skills.Text.PIIDetectionSkill"
        | "#Microsoft.Skills.Text.SplitSkill"
        | "#Microsoft.Skills.Text.CustomEntityLookupSkill"
        | "#Microsoft.Skills.Text.TranslationSkill"
        | "#Microsoft.Skills.Custom.WebApiSkill"
        | "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill";
    outputs: OutputFieldMappingEntry[];
}

Hierarchy (view full)

Properties

context? description? inputs name? odatatype outputs

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.

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.

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:
    | "#Microsoft.Skills.Util.ConditionalSkill"
    | "#Microsoft.Skills.Util.DocumentExtractionSkill"
    | "#Microsoft.Skills.Text.V3.EntityLinkingSkill"
    | "#Microsoft.Skills.Text.V3.EntityRecognitionSkill"
    | "#Microsoft.Skills.Text.LanguageDetectionSkill"
    | "#Microsoft.Skills.Text.MergeSkill"
    | "#Microsoft.Skills.Text.KeyPhraseExtractionSkill"
    | "#Microsoft.Skills.Vision.OcrSkill"
    | "#Microsoft.Skills.Vision.ImageAnalysisSkill"
    | "#Microsoft.Skills.Util.ShaperSkill"
    | "#Microsoft.Skills.Text.EntityRecognitionSkill"
    | "#Microsoft.Skills.Text.SentimentSkill"
    | "#Microsoft.Skills.Text.V3.SentimentSkill"
    | "#Microsoft.Skills.Text.PIIDetectionSkill"
    | "#Microsoft.Skills.Text.SplitSkill"
    | "#Microsoft.Skills.Text.CustomEntityLookupSkill"
    | "#Microsoft.Skills.Text.TranslationSkill"
    | "#Microsoft.Skills.Custom.WebApiSkill"
    | "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill"

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.

Settings

Member Visibility