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

Class CustomEntityLookupSkill

java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexerSkill
com.azure.search.documents.indexes.models.CustomEntityLookupSkill
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchIndexerSkill>
public final class CustomEntityLookupSkill extends SearchIndexerSkill
A skill looks for text from a custom, user-defined list of words and phrases.

  • Constructor Details

    • CustomEntityLookupSkill

      public CustomEntityLookupSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)
      Creates an instance of CustomEntityLookupSkill 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 CustomEntityLookupSkillLanguage getDefaultLanguageCode()
      Get the defaultLanguageCode property: A value indicating which language code to use. Default is `en`.
      Returns:
      the defaultLanguageCode value.

    • setDefaultLanguageCode

      public CustomEntityLookupSkill setDefaultLanguageCode(CustomEntityLookupSkillLanguage 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 CustomEntityLookupSkill object itself.

    • getEntitiesDefinitionUri

      public String getEntitiesDefinitionUri()
      Get the entitiesDefinitionUri property: Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS.
      Returns:
      the entitiesDefinitionUri value.

    • setEntitiesDefinitionUri

      public CustomEntityLookupSkill setEntitiesDefinitionUri(String entitiesDefinitionUri)
      Set the entitiesDefinitionUri property: Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS.
      Parameters:
      entitiesDefinitionUri - the entitiesDefinitionUri value to set.
      Returns:
      the CustomEntityLookupSkill object itself.

    • getInlineEntitiesDefinition

      public List<CustomEntity> getInlineEntitiesDefinition()
      Get the inlineEntitiesDefinition property: The inline CustomEntity definition.
      Returns:
      the inlineEntitiesDefinition value.

    • setInlineEntitiesDefinition

      public CustomEntityLookupSkill setInlineEntitiesDefinition(List<CustomEntity> inlineEntitiesDefinition)
      Set the inlineEntitiesDefinition property: The inline CustomEntity definition.
      Parameters:
      inlineEntitiesDefinition - the inlineEntitiesDefinition value to set.
      Returns:
      the CustomEntityLookupSkill object itself.

    • isGlobalDefaultCaseSensitive

      public Boolean isGlobalDefaultCaseSensitive()
      Get the globalDefaultCaseSensitive property: A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value.
      Returns:
      the globalDefaultCaseSensitive value.

    • setGlobalDefaultCaseSensitive

      public CustomEntityLookupSkill setGlobalDefaultCaseSensitive(Boolean globalDefaultCaseSensitive)
      Set the globalDefaultCaseSensitive property: A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value.
      Parameters:
      globalDefaultCaseSensitive - the globalDefaultCaseSensitive value to set.
      Returns:
      the CustomEntityLookupSkill object itself.

    • isGlobalDefaultAccentSensitive

      public Boolean isGlobalDefaultAccentSensitive()
      Get the globalDefaultAccentSensitive property: A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value.
      Returns:
      the globalDefaultAccentSensitive value.

    • setGlobalDefaultAccentSensitive

      public CustomEntityLookupSkill setGlobalDefaultAccentSensitive(Boolean globalDefaultAccentSensitive)
      Set the globalDefaultAccentSensitive property: A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value.
      Parameters:
      globalDefaultAccentSensitive - the globalDefaultAccentSensitive value to set.
      Returns:
      the CustomEntityLookupSkill object itself.

    • getGlobalDefaultFuzzyEditDistance

      public Integer getGlobalDefaultFuzzyEditDistance()
      Get the globalDefaultFuzzyEditDistance property: A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value.
      Returns:
      the globalDefaultFuzzyEditDistance value.

    • setGlobalDefaultFuzzyEditDistance

      public CustomEntityLookupSkill setGlobalDefaultFuzzyEditDistance(Integer globalDefaultFuzzyEditDistance)
      Set the globalDefaultFuzzyEditDistance property: A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value.
      Parameters:
      globalDefaultFuzzyEditDistance - the globalDefaultFuzzyEditDistance value to set.
      Returns:
      the CustomEntityLookupSkill object itself.

    • setName

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

    • setInlineEntitiesDefinition

      public CustomEntityLookupSkill setInlineEntitiesDefinition(CustomEntity... inlineEntitiesDefinition)
      Set the inlineEntitiesDefinition property: The inline CustomEntity definition.
      Parameters:
      inlineEntitiesDefinition - the inlineEntitiesDefinition value to set.
      Returns:
      the CustomEntityLookupSkill object itself.