| | 1 | | // <auto-generated> |
| | 2 | | // Copyright (c) Microsoft Corporation. All rights reserved. |
| | 3 | | // Licensed under the MIT License. See License.txt in the project root for |
| | 4 | | // license information. |
| | 5 | | // |
| | 6 | | // Code generated by Microsoft (R) AutoRest Code Generator. |
| | 7 | | // Changes may cause incorrect behavior and will be lost if the code is |
| | 8 | | // regenerated. |
| | 9 | | // </auto-generated> |
| | 10 | |
|
| | 11 | | namespace Microsoft.Azure.Search.Models |
| | 12 | | { |
| | 13 | | using Newtonsoft.Json; |
| | 14 | | using System.Collections; |
| | 15 | | using System.Collections.Generic; |
| | 16 | | using System.Linq; |
| | 17 | |
|
| | 18 | | /// <summary> |
| | 19 | | /// Text analytics entity recognition. |
| | 20 | | /// <see |
| | 21 | | /// href="https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-recognition" |
| | 22 | | /// /> |
| | 23 | | /// </summary> |
| | 24 | | [Newtonsoft.Json.JsonObject("#Microsoft.Skills.Text.EntityRecognitionSkill")] |
| | 25 | | public partial class EntityRecognitionSkill : Skill |
| | 26 | | { |
| | 27 | | /// <summary> |
| | 28 | | /// Initializes a new instance of the EntityRecognitionSkill class. |
| | 29 | | /// </summary> |
| 8 | 30 | | public EntityRecognitionSkill() |
| | 31 | | { |
| | 32 | | CustomInit(); |
| 8 | 33 | | } |
| | 34 | |
|
| | 35 | | /// <summary> |
| | 36 | | /// Initializes a new instance of the EntityRecognitionSkill class. |
| | 37 | | /// </summary> |
| | 38 | | /// <param name="inputs">Inputs of the skills could be a column in the |
| | 39 | | /// source data set, or the output of an upstream skill.</param> |
| | 40 | | /// <param name="outputs">The output of a skill is either a field in a |
| | 41 | | /// search index, or a value that can be consumed as an input by |
| | 42 | | /// another skill.</param> |
| | 43 | | /// <param name="name">The name of the skill which uniquely identifies |
| | 44 | | /// it within the skillset. A skill with no name defined will be given |
| | 45 | | /// a default name of its 1-based index in the skills array, prefixed |
| | 46 | | /// with the character '#'.</param> |
| | 47 | | /// <param name="description">The description of the skill which |
| | 48 | | /// describes the inputs, outputs, and usage of the skill.</param> |
| | 49 | | /// <param name="context">Represents the level at which operations take |
| | 50 | | /// place, such as the document root or document content (for example, |
| | 51 | | /// /document or /document/content). The default is /document.</param> |
| | 52 | | /// <param name="categories">A list of entity categories that should be |
| | 53 | | /// extracted.</param> |
| | 54 | | /// <param name="defaultLanguageCode">A value indicating which language |
| | 55 | | /// code to use. Default is en. Possible values include: 'de', 'en', |
| | 56 | | /// 'es', 'fr', 'it'</param> |
| | 57 | | /// <param name="includeTypelessEntities">Determines whether or not to |
| | 58 | | /// include entities which are well known but don't conform to a |
| | 59 | | /// pre-defined type. If this configuration is not set (default), set |
| | 60 | | /// to null or set to false, entities which don't conform to one of the |
| | 61 | | /// pre-defined types will not be surfaced.</param> |
| | 62 | | /// <param name="minimumPrecision">A value between 0 and 1 that be used |
| | 63 | | /// to only include entities whose confidence score is greater than the |
| | 64 | | /// value specified. If not set (default), or if explicitly set to |
| | 65 | | /// null, all entities will be included.</param> |
| | 66 | | public EntityRecognitionSkill(IList<InputFieldMappingEntry> inputs, IList<OutputFieldMappingEntry> outputs, stri |
| 8 | 67 | | : base(inputs, outputs, name, description, context) |
| | 68 | | { |
| 8 | 69 | | Categories = categories; |
| 8 | 70 | | DefaultLanguageCode = defaultLanguageCode; |
| 8 | 71 | | IncludeTypelessEntities = includeTypelessEntities; |
| 8 | 72 | | MinimumPrecision = minimumPrecision; |
| | 73 | | CustomInit(); |
| 8 | 74 | | } |
| | 75 | |
|
| | 76 | | /// <summary> |
| | 77 | | /// An initialization method that performs custom operations like setting defaults |
| | 78 | | /// </summary> |
| | 79 | | partial void CustomInit(); |
| | 80 | |
|
| | 81 | | /// <summary> |
| | 82 | | /// Gets or sets a list of entity categories that should be extracted. |
| | 83 | | /// </summary> |
| | 84 | | [JsonProperty(PropertyName = "categories")] |
| 42 | 85 | | public IList<EntityCategory> Categories { get; set; } |
| | 86 | |
|
| | 87 | | /// <summary> |
| | 88 | | /// Gets or sets a value indicating which language code to use. Default |
| | 89 | | /// is en. Possible values include: 'de', 'en', 'es', 'fr', 'it' |
| | 90 | | /// </summary> |
| | 91 | | [JsonProperty(PropertyName = "defaultLanguageCode")] |
| 42 | 92 | | public EntityRecognitionSkillLanguage? DefaultLanguageCode { get; set; } |
| | 93 | |
|
| | 94 | | /// <summary> |
| | 95 | | /// Gets or sets determines whether or not to include entities which |
| | 96 | | /// are well known but don't conform to a pre-defined type. If this |
| | 97 | | /// configuration is not set (default), set to null or set to false, |
| | 98 | | /// entities which don't conform to one of the pre-defined types will |
| | 99 | | /// not be surfaced. |
| | 100 | | /// </summary> |
| | 101 | | [JsonProperty(PropertyName = "includeTypelessEntities")] |
| 36 | 102 | | public bool? IncludeTypelessEntities { get; set; } |
| | 103 | |
|
| | 104 | | /// <summary> |
| | 105 | | /// Gets or sets a value between 0 and 1 that be used to only include |
| | 106 | | /// entities whose confidence score is greater than the value |
| | 107 | | /// specified. If not set (default), or if explicitly set to null, all |
| | 108 | | /// entities will be included. |
| | 109 | | /// </summary> |
| | 110 | | [JsonProperty(PropertyName = "minimumPrecision")] |
| 42 | 111 | | public double? MinimumPrecision { get; set; } |
| | 112 | |
|
| | 113 | | /// <summary> |
| | 114 | | /// Validate the object. |
| | 115 | | /// </summary> |
| | 116 | | /// <exception cref="Rest.ValidationException"> |
| | 117 | | /// Thrown if validation fails |
| | 118 | | /// </exception> |
| | 119 | | public override void Validate() |
| | 120 | | { |
| 8 | 121 | | base.Validate(); |
| 8 | 122 | | } |
| | 123 | | } |
| | 124 | | } |