Package version:

Interface KeyPhraseExtractionSkill

A skill that uses text analytics for key phrase extraction.

interface KeyPhraseExtractionSkill {
    context?: string;
    defaultLanguageCode?:
        | "da"
        | "de"
        | "en"
        | "es"
        | "fi"
        | "fr"
        | "it"
        | "ko"
        | "nl"
        | "ja"
        | "no"
        | "pl"
        | "pt-PT"
        | "pt-BR"
        | "ru"
        | "sv";
    description?: string;
    inputs: InputFieldMappingEntry[];
    maxKeyPhraseCount?: number;
    modelVersion?: string;
    name?: string;
    odatatype: "#Microsoft.Skills.Text.KeyPhraseExtractionSkill";
    outputs: OutputFieldMappingEntry[];
}

Hierarchy (view full)

Properties

context? defaultLanguageCode? description? inputs maxKeyPhraseCount? modelVersion? name? odatatype outputs

Properties

Optionalcontext

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

OptionaldefaultLanguageCode

defaultLanguageCode?:
    | "da"
    | "de"
    | "en"
    | "es"
    | "fi"
    | "fr"
    | "it"
    | "ko"
    | "nl"
    | "ja"
    | "no"
    | "pl"
    | "pt-PT"
    | "pt-BR"
    | "ru"
    | "sv"

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

Optionaldescription

description?: string

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

inputs

inputs: InputFieldMappingEntry[]

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

OptionalmaxKeyPhraseCount

maxKeyPhraseCount?: number

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

OptionalmodelVersion

modelVersion?: string

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.

Optionalname

name?: 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

odatatype

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

outputs

outputs: OutputFieldMappingEntry[]

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.

Settings

Member Visibility