SearchModelFactory.SentimentSkill Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Using the Text Analytics API, evaluates unstructured text and for each record, provides sentiment labels (such as "negative", "neutral" and "positive") based on the highest confidence score found by the service at a sentence and document-level.
public static Azure.Search.Documents.Indexes.Models.SentimentSkill SentimentSkill(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.SentimentSkillLanguage? defaultLanguageCode = default, bool? includeOpinionMining = default, string modelVersion = default);static member SentimentSkill : string * string * string * seq<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> * seq<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> * Nullable<Azure.Search.Documents.Indexes.Models.SentimentSkillLanguage> * Nullable<bool> * string -> Azure.Search.Documents.Indexes.Models.SentimentSkillPublic Shared Function SentimentSkill (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 SentimentSkillLanguage) = Nothing, Optional includeOpinionMining As Nullable(Of Boolean) = Nothing, Optional modelVersion As String = Nothing) As SentimentSkillParameters
- 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<SentimentSkillLanguage>
A value indicating which language code to use. Default is en.
If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text. Default is false.
- 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 SentimentSkill instance for mocking.
