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

Class KeyPhraseExtractionSkill

java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexerSkill
com.azure.search.documents.indexes.models.KeyPhraseExtractionSkill
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchIndexerSkill>
public final class KeyPhraseExtractionSkill extends SearchIndexerSkill
A skill that uses text analytics for key phrase extraction.

  • Constructor Details

    • KeyPhraseExtractionSkill

      public KeyPhraseExtractionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)
      Creates an instance of KeyPhraseExtractionSkill 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.

    • getDefaultLanguageCode

      public KeyPhraseExtractionSkillLanguage getDefaultLanguageCode()
      Get the defaultLanguageCode property: A value indicating which language code to use. Default is `en`.
      Returns:
      the defaultLanguageCode value.

    • setDefaultLanguageCode

      public KeyPhraseExtractionSkill setDefaultLanguageCode(KeyPhraseExtractionSkillLanguage defaultLanguageCode)
      Set the defaultLanguageCode property: A value indicating which language code to use. Default is `en`.
      Parameters:
      defaultLanguageCode - the defaultLanguageCode value to set.
      Returns:
      the KeyPhraseExtractionSkill object itself.

    • getMaxKeyPhraseCount

      public Integer getMaxKeyPhraseCount()
      Get the maxKeyPhraseCount property: A number indicating how many key phrases to return. If absent, all identified key phrases will be returned.
      Returns:
      the maxKeyPhraseCount value.

    • setMaxKeyPhraseCount

      public KeyPhraseExtractionSkill setMaxKeyPhraseCount(Integer maxKeyPhraseCount)
      Set the maxKeyPhraseCount property: A number indicating how many key phrases to return. If absent, all identified key phrases will be returned.
      Parameters:
      maxKeyPhraseCount - the maxKeyPhraseCount value to set.
      Returns:
      the KeyPhraseExtractionSkill 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 KeyPhraseExtractionSkill 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 KeyPhraseExtractionSkill object itself.

    • setName

      public KeyPhraseExtractionSkill 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 KeyPhraseExtractionSkill 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 KeyPhraseExtractionSkill 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 KeyPhraseExtractionSkill fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of KeyPhraseExtractionSkill from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of KeyPhraseExtractionSkill 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 KeyPhraseExtractionSkill.