Feedback Edit

EntityRecognitionSkill Class

  • Reference

Text analytics entity recognition.

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

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

Constructor

EntityRecognitionSkill(*, 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, categories: Optional[List[Union[str, azure.search.documents.indexes._generated.models._search_client_enums.EntityCategory]]] = None, default_language_code: Optional[Union[str, azure.search.documents.indexes._generated.models._search_client_enums.EntityRecognitionSkillLanguage]] = None, include_typeless_entities: Optional[bool] = None, minimum_precision: Optional[float] = 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.

categories
list[str or EntityCategory]
Required

A list of entity categories that should be extracted.

default_language_code
str or EntityRecognitionSkillLanguage
Required

A value indicating which language code to use. Default is en. Possible values include: "ar", "cs", "zh-Hans", "zh-Hant", "da", "nl", "en", "fi", "fr", "de", "el", "hu", "it", "ja", "ko", "no", "pl", "pt-PT", "pt-BR", "ru", "es", "sv", "tr".

include_typeless_entities
bool
Required

Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced.

minimum_precision
float
Required

A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included.