Class CustomEntityLookupSkill


  • public final class CustomEntityLookupSkill
    extends SearchIndexerSkill
    A skill looks for text from a custom, user-defined list of words and phrases.
    • Constructor Detail

      • 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 Detail

      • 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.
      • 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.