CustomEntityLookupSkill interface

  • Reference
Package:
@azure/search-documents

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

Extends
BaseSearchIndexerSkill

Properties

defaultLanguageCode

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

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.
globalDefaultAccentSensitive

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

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

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

The inline CustomEntity definition.
odatatype

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

Inherited Properties

context

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

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

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

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

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.

Property Details

defaultLanguageCode

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

defaultLanguageCode?: CustomEntityLookupSkillLanguage

Property Value

CustomEntityLookupSkillLanguage

entitiesDefinitionUri

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.

entitiesDefinitionUri?: string

Property Value

string

globalDefaultAccentSensitive

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

globalDefaultAccentSensitive?: boolean

Property Value

boolean

globalDefaultCaseSensitive

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

globalDefaultCaseSensitive?: boolean

Property Value

boolean

globalDefaultFuzzyEditDistance

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

globalDefaultFuzzyEditDistance?: number

Property Value

number

inlineEntitiesDefinition

The inline CustomEntity definition.

inlineEntitiesDefinition?: CustomEntity[]

Property Value

CustomEntity[]

odatatype

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

odatatype: "#Microsoft.Skills.Text.CustomEntityLookupSkill"

Property Value

"#Microsoft.Skills.Text.CustomEntityLookupSkill"

Inherited Property Details

context

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.

context?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.context

description

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

description?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.description

inputs

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

inputs: InputFieldMappingEntry[]

Property Value

InputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.inputs

name

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

name?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.name

outputs

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.

outputs: OutputFieldMappingEntry[]

Property Value

OutputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.outputs