Feedback Edit

CustomEntityLookupSkill Class

  • Reference

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

All required parameters must be populated in order to send to Azure.

Inheritance
azure.search.documents.indexes._generated.models._models_py3.SearchIndexerSkill
CustomEntityLookupSkill

Constructor

CustomEntityLookupSkill(*, inputs: List[azure.search.documents.indexes._generated.models._models_py3.InputFieldMappingEntry], outputs: List[azure.search.documents.indexes._generated.models._models_py3.OutputFieldMappingEntry], name: Optional[str] = None, description: Optional[str] = None, context: Optional[str] = None, default_language_code: Optional[Union[str, azure.search.documents.indexes._generated.models._search_client_enums.CustomEntityLookupSkillLanguage]] = None, entities_definition_uri: Optional[str] = None, inline_entities_definition: Optional[List[azure.search.documents.indexes._generated.models._models_py3.CustomEntity]] = None, global_default_case_sensitive: Optional[bool] = None, global_default_accent_sensitive: Optional[bool] = None, global_default_fuzzy_edit_distance: Optional[int] = None, **kwargs)

Parameters

odata_type
str
Required

Required. Identifies the concrete type of the skill.Constant filled by server.

name
str
Required

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
str
Required

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

context
str
Required

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
list[InputFieldMappingEntry]
Required

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

outputs
list[OutputFieldMappingEntry]
Required

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

default_language_code
str or CustomEntityLookupSkillLanguage
Required

A value indicating which language code to use. Default is en. Possible values include: "da", "de", "en", "es", "fi", "fr", "it", "ko", "pt".

entities_definition_uri
str
Required

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.

inline_entities_definition
list[<xref:azure.search.documents.indexes.models.CustomEntity>]
Required

The inline CustomEntity definition.

global_default_case_sensitive
bool
Required

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

global_default_accent_sensitive
bool
Required

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

global_default_fuzzy_edit_distance
int
Required

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