PiiDetectionSkill.java

  1. // Copyright (c) Microsoft Corporation. All rights reserved.
  2. // Licensed under the MIT License.
  3. //
  4. // Code generated by Microsoft (R) AutoRest Code Generator.
  5. // Changes may cause incorrect behavior and will be lost if the code is
  6. // regenerated.

  8. package com.azure.search.documents.indexes.models;

  10. import com.azure.core.annotation.Fluent;
  11. import com.fasterxml.jackson.annotation.JsonCreator;
  12. import com.fasterxml.jackson.annotation.JsonProperty;
  13. import com.fasterxml.jackson.annotation.JsonTypeId;
  14. import com.fasterxml.jackson.annotation.JsonTypeInfo;
  15. import com.fasterxml.jackson.annotation.JsonTypeName;
  16. import java.util.List;

  18. /**
  19.  * Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking
  20.  * it.
  21.  */
  22. @JsonTypeInfo(
  23.         use = JsonTypeInfo.Id.NAME,
  24.         include = JsonTypeInfo.As.EXISTING_PROPERTY,
  25.         property = "@odata.type",
  26.         visible = true)
  27. @JsonTypeName("#Microsoft.Skills.Text.PIIDetectionSkill")
  28. @Fluent
  29. public final class PiiDetectionSkill extends SearchIndexerSkill {
  30.     /*
  31.      * Identifies the concrete type of the skill.
  32.      */
  33.     @JsonTypeId
  34.     @JsonProperty(value = "@odata.type", required = true)
  35.     private String odataType = "#Microsoft.Skills.Text.PIIDetectionSkill";

  37.     /*
  38.      * A value indicating which language code to use. Default is en.
  39.      */
  40.     @JsonProperty(value = "defaultLanguageCode")
  41.     private String defaultLanguageCode;

  43.     /*
  44.      * A value between 0 and 1 that be used to only include entities whose
  45.      * confidence score is greater than the value specified. If not set
  46.      * (default), or if explicitly set to null, all entities will be included.
  47.      */
  48.     @JsonProperty(value = "minimumPrecision")
  49.     private Double minimumPrecision;

  51.     /*
  52.      * A parameter that provides various ways to mask the personal information
  53.      * detected in the input text. Default is 'none'.
  54.      */
  55.     @JsonProperty(value = "maskingMode")
  56.     private PiiDetectionSkillMaskingMode maskingMode;

  58.     /*
  59.      * The character used to mask the text if the maskingMode parameter is set
  60.      * to replace. Default is '*'.
  61.      */
  62.     @JsonProperty(value = "maskingCharacter")
  63.     private String maskingCharacter;

  65.     /*
  66.      * The version of the model to use when calling the Text Analytics service.
  67.      * It will default to the latest available when not specified. We recommend
  68.      * you do not specify this value unless absolutely necessary.
  69.      */
  70.     @JsonProperty(value = "modelVersion")
  71.     private String modelVersion;

  73.     /*
  74.      * A list of PII entity categories that should be extracted and masked.
  75.      */
  76.     @JsonProperty(value = "piiCategories")
  77.     private List<String> piiCategories;

  79.     /*
  80.      * If specified, will set the PII domain to include only a subset of the
  81.      * entity categories. Possible values include: 'phi', 'none'. Default is
  82.      * 'none'.
  83.      */
  84.     @JsonProperty(value = "domain")
  85.     private String domain;

  87.     /**
  88.      * Creates an instance of PiiDetectionSkill class.
  89.      *
  90.      * @param inputs the inputs value to set.
  91.      * @param outputs the outputs value to set.
  92.      */
  93.     @JsonCreator
  94.     public PiiDetectionSkill(
  95.             @JsonProperty(value = "inputs", required = true) List<InputFieldMappingEntry> inputs,
  96.             @JsonProperty(value = "outputs", required = true) List<OutputFieldMappingEntry> outputs) {
  97.         super(inputs, outputs);
  98.     }

  100.     /**
  101.      * Get the defaultLanguageCode property: A value indicating which language code to use. Default is en.
  102.      *
  103.      * @return the defaultLanguageCode value.
  104.      */
  105.     public String getDefaultLanguageCode() {
  106.         return this.defaultLanguageCode;
  107.     }

  109.     /**
  110.      * Set the defaultLanguageCode property: A value indicating which language code to use. Default is en.
  111.      *
  112.      * @param defaultLanguageCode the defaultLanguageCode value to set.
  113.      * @return the PiiDetectionSkill object itself.
  114.      */
  115.     public PiiDetectionSkill setDefaultLanguageCode(String defaultLanguageCode) {
  116.         this.defaultLanguageCode = defaultLanguageCode;
  117.         return this;
  118.     }

  120.     /**
  121.      * Get the minimumPrecision property: A value between 0 and 1 that be used to only include entities whose confidence
  122.      * score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will
  123.      * be included.
  124.      *
  125.      * @return the minimumPrecision value.
  126.      */
  127.     public Double getMinimumPrecision() {
  128.         return this.minimumPrecision;
  129.     }

  131.     /**
  132.      * Set the minimumPrecision property: A value between 0 and 1 that be used to only include entities whose confidence
  133.      * score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will
  134.      * be included.
  135.      *
  136.      * @param minimumPrecision the minimumPrecision value to set.
  137.      * @return the PiiDetectionSkill object itself.
  138.      */
  139.     public PiiDetectionSkill setMinimumPrecision(Double minimumPrecision) {
  140.         this.minimumPrecision = minimumPrecision;
  141.         return this;
  142.     }

  144.     /**
  145.      * Get the maskingMode property: A parameter that provides various ways to mask the personal information detected in
  146.      * the input text. Default is 'none'.
  147.      *
  148.      * @return the maskingMode value.
  149.      */
  150.     public PiiDetectionSkillMaskingMode getMaskingMode() {
  151.         return this.maskingMode;
  152.     }

  154.     /**
  155.      * Set the maskingMode property: A parameter that provides various ways to mask the personal information detected in
  156.      * the input text. Default is 'none'.
  157.      *
  158.      * @param maskingMode the maskingMode value to set.
  159.      * @return the PiiDetectionSkill object itself.
  160.      */
  161.     public PiiDetectionSkill setMaskingMode(PiiDetectionSkillMaskingMode maskingMode) {
  162.         this.maskingMode = maskingMode;
  163.         return this;
  164.     }

  166.     /**
  167.      * Get the maskingCharacter property: The character used to mask the text if the maskingMode parameter is set to
  168.      * replace. Default is '*'.
  169.      *
  170.      * @return the maskingCharacter value.
  171.      */
  172.     public String getMaskingCharacter() {
  173.         return this.maskingCharacter;
  174.     }

  176.     /**
  177.      * Set the maskingCharacter property: The character used to mask the text if the maskingMode parameter is set to
  178.      * replace. Default is '*'.
  179.      *
  180.      * @param maskingCharacter the maskingCharacter value to set.
  181.      * @return the PiiDetectionSkill object itself.
  182.      */
  183.     public PiiDetectionSkill setMaskingCharacter(String maskingCharacter) {
  184.         this.maskingCharacter = maskingCharacter;
  185.         return this;
  186.     }

  188.     /**
  189.      * Get the modelVersion property: The version of the model to use when calling the Text Analytics service. It will
  190.      * default to the latest available when not specified. We recommend you do not specify this value unless absolutely
  191.      * necessary.
  192.      *
  193.      * @return the modelVersion value.
  194.      */
  195.     public String getModelVersion() {
  196.         return this.modelVersion;
  197.     }

  199.     /**
  200.      * Set the modelVersion property: The version of the model to use when calling the Text Analytics service. It will
  201.      * default to the latest available when not specified. We recommend you do not specify this value unless absolutely
  202.      * necessary.
  203.      *
  204.      * @param modelVersion the modelVersion value to set.
  205.      * @return the PiiDetectionSkill object itself.
  206.      */
  207.     public PiiDetectionSkill setModelVersion(String modelVersion) {
  208.         this.modelVersion = modelVersion;
  209.         return this;
  210.     }

  212.     /**
  213.      * Get the piiCategories property: A list of PII entity categories that should be extracted and masked.
  214.      *
  215.      * @return the piiCategories value.
  216.      */
  217.     public List<String> getPiiCategories() {
  218.         return this.piiCategories;
  219.     }

  221.     /**
  222.      * Set the piiCategories property: A list of PII entity categories that should be extracted and masked.
  223.      *
  224.      * @param piiCategories the piiCategories value to set.
  225.      * @return the PiiDetectionSkill object itself.
  226.      */
  227.     public PiiDetectionSkill setPiiCategories(List<String> piiCategories) {
  228.         this.piiCategories = piiCategories;
  229.         return this;
  230.     }

  232.     /**
  233.      * Get the domain property: If specified, will set the PII domain to include only a subset of the entity categories.
  234.      * Possible values include: 'phi', 'none'. Default is 'none'.
  235.      *
  236.      * @return the domain value.
  237.      */
  238.     public String getDomain() {
  239.         return this.domain;
  240.     }

  242.     /**
  243.      * Set the domain property: If specified, will set the PII domain to include only a subset of the entity categories.
  244.      * Possible values include: 'phi', 'none'. Default is 'none'.
  245.      *
  246.      * @param domain the domain value to set.
  247.      * @return the PiiDetectionSkill object itself.
  248.      */
  249.     public PiiDetectionSkill setDomain(String domain) {
  250.         this.domain = domain;
  251.         return this;
  252.     }
  253. }
Created with JaCoCo 0.8.7.202105040129