• Public
  • Public/Protected
  • All

Interface EntityRecognitionSkill

Package version

Text analytics entity recognition.


  • EntityRecognitionSkill



Optional categories

categories: EntityCategory[]

A list of entity categories that should be extracted.

Optional context

context: undefined | 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.

Optional defaultLanguageCode

defaultLanguageCode: EntityRecognitionSkillLanguage

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'

Optional description

description: undefined | string

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

Optional includeTypelessEntities

includeTypelessEntities: undefined | false | true

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.


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

Optional minimumPrecision

minimumPrecision: undefined | number

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.

Optional name

name: undefined | 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: "#Microsoft.Skills.Text.EntityRecognitionSkill"

Polymorphic Discriminator


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.

Generated using TypeDoc