KeyPhraseExtractionSkill interface

  • Reference
Package:
@azure/search-documents

A skill that uses text analytics for key phrase extraction.

Extends
BaseSearchIndexerSkill

Properties

defaultLanguageCode

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

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

The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary.
odatatype

Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

context

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

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

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

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 #.
outputs

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.

Property Details

defaultLanguageCode

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

defaultLanguageCode?: KeyPhraseExtractionSkillLanguage

Property Value

KeyPhraseExtractionSkillLanguage

maxKeyPhraseCount

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

maxKeyPhraseCount?: number

Property Value

number

modelVersion

The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary.

modelVersion?: string

Property Value

string

odatatype

Polymorphic discriminator, which specifies the different types this object can be

odatatype: "#Microsoft.Skills.Text.KeyPhraseExtractionSkill"

Property Value

"#Microsoft.Skills.Text.KeyPhraseExtractionSkill"

Inherited Property Details

context

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.

context?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.context

description

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

description?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.description

inputs

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

inputs: InputFieldMappingEntry[]

Property Value

InputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.inputs

name

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

name?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.name

outputs

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.

outputs: OutputFieldMappingEntry[]

Property Value

OutputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.outputs