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

Class EntityRecognitionSkill

java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexerSkill
com.azure.search.documents.indexes.models.EntityRecognitionSkill
public final class EntityRecognitionSkill extends SearchIndexerSkill
Text analytics entity recognition.

  • Constructor Details

  • Method Details

    • getSkillVersion

      public EntityRecognitionSkillVersion getSkillVersion()
      Gets the version of the EntityRecognitionSkill.
      Returns:
      The version of the EntityRecognitionSkill.

    • getCategories

      public List<EntityCategory> getCategories()
      Get the categories property: A list of entity categories that should be extracted.
      Returns:
      the categories value.

    • setCategories

      public EntityRecognitionSkill setCategories(List<EntityCategory> categories)
      Set the categories property: A list of entity categories that should be extracted.
      Parameters:
      categories - the categories value to set.
      Returns:
      the EntityRecognitionSkill object itself.

    • getDefaultLanguageCode

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

    • setDefaultLanguageCode

      public EntityRecognitionSkill setDefaultLanguageCode(EntityRecognitionSkillLanguage 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 EntityRecognitionSkill object itself.

    • areTypelessEntitiesIncluded

      public Boolean areTypelessEntitiesIncluded()
      Get the includeTypelessEntities property: Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced.
      Returns:
      the includeTypelessEntities value.

    • setTypelessEntitiesIncluded

      public EntityRecognitionSkill setTypelessEntitiesIncluded(Boolean includeTypelessEntities)
      Set the includeTypelessEntities property: Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced.
      Parameters:
      includeTypelessEntities - the includeTypelessEntities value to set.
      Returns:
      the EntityRecognitionSkill object itself.
      Throws:
      IllegalArgumentException - If includeTypelessEntities is supplied when getSkillVersion() is EntityRecognitionSkillVersion.V3.

    • getMinimumPrecision

      public Double getMinimumPrecision()
      Get the minimumPrecision property: A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included.
      Returns:
      the minimumPrecision value.

    • setMinimumPrecision

      public EntityRecognitionSkill setMinimumPrecision(Double minimumPrecision)
      Set the minimumPrecision property: A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included.
      Parameters:
      minimumPrecision - the minimumPrecision value to set.
      Returns:
      the EntityRecognitionSkill object itself.

    • setName

      public EntityRecognitionSkill 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 EntityRecognitionSkill 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 EntityRecognitionSkill 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.

    • 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 EntityRecognitionSkill 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 EntityRecognitionSkill object itself.
      Throws:
      IllegalArgumentException - If modelVersion is supplied when getSkillVersion() is EntityRecognitionSkillVersion.V1.

    • setCategories

      public EntityRecognitionSkill setCategories(EntityCategory... categories)
      Set the categories property: A list of entity categories that should be extracted.
      Parameters:
      categories - the categories value to set.
      Returns:
      the EntityRecognitionSkill object itself.