SearchModelFactory.KeyPhraseExtractionSkill Method

Definition

A skill that uses text analytics for key phrase extraction.

public static Azure.Search.Documents.Indexes.Models.KeyPhraseExtractionSkill KeyPhraseExtractionSkill(string name = default, string description = default, string context = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> inputs = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> outputs = default, Azure.Search.Documents.Indexes.Models.KeyPhraseExtractionSkillLanguage? defaultLanguageCode = default, int? maxKeyPhraseCount = default, string modelVersion = default);
static member KeyPhraseExtractionSkill : string * string * string * seq<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> * seq<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> * Nullable<Azure.Search.Documents.Indexes.Models.KeyPhraseExtractionSkillLanguage> * Nullable<int> * string -> Azure.Search.Documents.Indexes.Models.KeyPhraseExtractionSkill
Public Shared Function KeyPhraseExtractionSkill (Optional name As String = Nothing, Optional description As String = Nothing, Optional context As String = Nothing, Optional inputs As IEnumerable(Of InputFieldMappingEntry) = Nothing, Optional outputs As IEnumerable(Of OutputFieldMappingEntry) = Nothing, Optional defaultLanguageCode As Nullable(Of KeyPhraseExtractionSkillLanguage) = Nothing, Optional maxKeyPhraseCount As Nullable(Of Integer) = Nothing, Optional modelVersion As String = Nothing) As KeyPhraseExtractionSkill

Parameters

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

description
String

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

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.

inputs
IEnumerable<InputFieldMappingEntry>

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

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

defaultLanguageCode
Nullable<KeyPhraseExtractionSkillLanguage>

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

maxKeyPhraseCount
Nullable<Int32>

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

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.

Returns

A new KeyPhraseExtractionSkill instance for mocking.

Applies to