Package com.azure.search.documents.indexes.models

Class LanguageDetectionSkill

java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexerSkill
com.azure.search.documents.indexes.models.LanguageDetectionSkill
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchIndexerSkill>
public final class LanguageDetectionSkill extends SearchIndexerSkill
A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis.

  • Constructor Details

    • LanguageDetectionSkill

      public LanguageDetectionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)
      Creates an instance of LanguageDetectionSkill class.
      Parameters:
      inputs - the inputs value to set.
      outputs - the outputs value to set.

  • Method Details

    • getOdataType

      public String getOdataType()
      Get the odataType property: A URI fragment specifying the type of skill.
      Overrides:
      getOdataType in class SearchIndexerSkill
      Returns:
      the odataType value.

    • getDefaultCountryHint

      public String getDefaultCountryHint()
      Get the defaultCountryHint property: A country code to use as a hint to the language detection model if it cannot disambiguate the language.
      Returns:
      the defaultCountryHint value.

    • setDefaultCountryHint

      public LanguageDetectionSkill setDefaultCountryHint(String defaultCountryHint)
      Set the defaultCountryHint property: A country code to use as a hint to the language detection model if it cannot disambiguate the language.
      Parameters:
      defaultCountryHint - the defaultCountryHint value to set.
      Returns:
      the LanguageDetectionSkill object itself.

    • getModelVersion

      public String getModelVersion()
      Get the modelVersion property: 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:
      the modelVersion value.

    • setModelVersion

      public LanguageDetectionSkill setModelVersion(String modelVersion)
      Set the modelVersion property: 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.
      Parameters:
      modelVersion - the modelVersion value to set.
      Returns:
      the LanguageDetectionSkill object itself.

    • setName

      public LanguageDetectionSkill setName(String name)
      Set the name property: 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 '#'.
      Overrides:
      setName in class SearchIndexerSkill
      Parameters:
      name - the name value to set.
      Returns:
      the SearchIndexerSkill object itself.

    • setDescription

      public LanguageDetectionSkill setDescription(String description)
      Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
      Overrides:
      setDescription in class SearchIndexerSkill
      Parameters:
      description - the description value to set.
      Returns:
      the SearchIndexerSkill object itself.

    • setContext

      public LanguageDetectionSkill setContext(String context)
      Set the context property: 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.
      Overrides:
      setContext in class SearchIndexerSkill
      Parameters:
      context - the context value to set.
      Returns:
      the SearchIndexerSkill object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<SearchIndexerSkill>
      Overrides:
      toJson in class SearchIndexerSkill
      Throws:
      IOException

    • fromJson

      public static LanguageDetectionSkill fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of LanguageDetectionSkill from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of LanguageDetectionSkill if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the LanguageDetectionSkill.