Package version:

Interface CustomEntityLookupSkill

A skill looks for text from a custom, user-defined list of words and phrases.

interface CustomEntityLookupSkill {
    context?: string;
    defaultLanguageCode?:
        | "da"
        | "de"
        | "en"
        | "es"
        | "fi"
        | "fr"
        | "it"
        | "ko"
        | "pt";
    description?: string;
    entitiesDefinitionUri?: string;
    globalDefaultAccentSensitive?: boolean;
    globalDefaultCaseSensitive?: boolean;
    globalDefaultFuzzyEditDistance?: number;
    inlineEntitiesDefinition?: CustomEntity[];
    inputs: InputFieldMappingEntry[];
    name?: string;
    odatatype: "#Microsoft.Skills.Text.CustomEntityLookupSkill";
    outputs: OutputFieldMappingEntry[];
}

Hierarchy (view full)

Properties

context? defaultLanguageCode? description? entitiesDefinitionUri? globalDefaultAccentSensitive? globalDefaultCaseSensitive? globalDefaultFuzzyEditDistance? inlineEntitiesDefinition? 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.

OptionaldefaultLanguageCode

defaultLanguageCode?:
    | "da"
    | "de"
    | "en"
    | "es"
    | "fi"
    | "fr"
    | "it"
    | "ko"
    | "pt"

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.

OptionalentitiesDefinitionUri

entitiesDefinitionUri?: string

Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS.

OptionalglobalDefaultAccentSensitive

globalDefaultAccentSensitive?: boolean

A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value.

OptionalglobalDefaultCaseSensitive

globalDefaultCaseSensitive?: boolean

A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value.

OptionalglobalDefaultFuzzyEditDistance

globalDefaultFuzzyEditDistance?: number

A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value.

OptionalinlineEntitiesDefinition

inlineEntitiesDefinition?: CustomEntity[]

The inline CustomEntity definition.

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

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