• Public
  • Public/Protected
  • All

Interface KeyPhraseExtractionSkill

Package version

A skill that uses text analytics for key phrase extraction.


  • KeyPhraseExtractionSkill



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

A value indicating which language code to use. Default is en. Possible values include: 'da', 'nl', 'en', 'fi', 'fr', 'de', 'it', 'ja', 'ko', 'no', 'pl', 'pt-PT', 'pt-BR', 'ru', 'es', 'sv'

Optional description

description: undefined | string

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


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

Optional maxKeyPhraseCount

maxKeyPhraseCount: undefined | number

A number indicating how many key phrases to return. If absent, all identified key phrases will be returned.

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.KeyPhraseExtractionSkill"

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