SearchModelFactory.CustomEntityLookupSkill Method

Definition

Namespace:
Azure.Search.Documents.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Source:
SearchModelFactory.cs

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

public static Azure.Search.Documents.Indexes.Models.CustomEntityLookupSkill CustomEntityLookupSkill(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.CustomEntityLookupSkillLanguage? defaultLanguageCode = default, Uri entitiesDefinitionUri = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.CustomEntity> inlineEntitiesDefinition = default, bool? globalDefaultCaseSensitive = default, bool? globalDefaultAccentSensitive = default, int? globalDefaultFuzzyEditDistance = default);
static member CustomEntityLookupSkill : string * string * string * seq<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> * seq<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> * Nullable<Azure.Search.Documents.Indexes.Models.CustomEntityLookupSkillLanguage> * Uri * seq<Azure.Search.Documents.Indexes.Models.CustomEntity> * Nullable<bool> * Nullable<bool> * Nullable<int> -> Azure.Search.Documents.Indexes.Models.CustomEntityLookupSkill
Public Shared Function CustomEntityLookupSkill (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 CustomEntityLookupSkillLanguage) = Nothing, Optional entitiesDefinitionUri As Uri = Nothing, Optional inlineEntitiesDefinition As IEnumerable(Of CustomEntity) = Nothing, Optional globalDefaultCaseSensitive As Nullable(Of Boolean) = Nothing, Optional globalDefaultAccentSensitive As Nullable(Of Boolean) = Nothing, Optional globalDefaultFuzzyEditDistance As Nullable(Of Integer) = Nothing) As CustomEntityLookupSkill

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<CustomEntityLookupSkillLanguage>

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

entitiesDefinitionUri
Uri

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.

inlineEntitiesDefinition
IEnumerable<CustomEntity>

The inline CustomEntity definition.

globalDefaultCaseSensitive
Nullable<Boolean>

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

globalDefaultAccentSensitive
Nullable<Boolean>

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

globalDefaultFuzzyEditDistance
Nullable<Int32>

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

Returns

CustomEntityLookupSkill

A new CustomEntityLookupSkill instance for mocking.

Applies to