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

Class CustomEntity

  • public final class CustomEntity
extends Object
    An object that contains information about the matches that were found, and related metadata.

    • Constructor Detail

      • CustomEntity

        public CustomEntity​(String name)
        Creates an instance of CustomEntity class.
        Parameters:
        name - the name value to set.

    • Method Detail

      • getName

        public String getName()
        Get the name property: The top-level entity descriptor. Matches in the skill output will be grouped by this name, and it should represent the "normalized" form of the text being found.
        Returns:
        the name value.

      • getDescription

        public String getDescription()
        Get the description property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output.
        Returns:
        the description value.

      • setDescription

        public CustomEntity setDescription​(String description)
        Set the description property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output.
        Parameters:
        description - the description value to set.
        Returns:
        the CustomEntity object itself.

      • getType

        public String getType()
        Get the type property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output.
        Returns:
        the type value.

      • setType

        public CustomEntity setType​(String type)
        Set the type property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output.
        Parameters:
        type - the type value to set.
        Returns:
        the CustomEntity object itself.

      • getSubtype

        public String getSubtype()
        Get the subtype property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output.
        Returns:
        the subtype value.

      • setSubtype

        public CustomEntity setSubtype​(String subtype)
        Set the subtype property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output.
        Parameters:
        subtype - the subtype value to set.
        Returns:
        the CustomEntity object itself.

      • getId

        public String getId()
        Get the id property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output.
        Returns:
        the id value.

      • setId

        public CustomEntity setId​(String id)
        Set the id property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output.
        Parameters:
        id - the id value to set.
        Returns:
        the CustomEntity object itself.

      • isCaseSensitive

        public Boolean isCaseSensitive()
        Get the caseSensitive property: Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of "Microsoft" could be: microsoft, microSoft, MICROSOFT.
        Returns:
        the caseSensitive value.

      • setCaseSensitive

        public CustomEntity setCaseSensitive​(Boolean caseSensitive)
        Set the caseSensitive property: Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of "Microsoft" could be: microsoft, microSoft, MICROSOFT.
        Parameters:
        caseSensitive - the caseSensitive value to set.
        Returns:
        the CustomEntity object itself.

      • isAccentSensitive

        public Boolean isAccentSensitive()
        Get the accentSensitive property: Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent.
        Returns:
        the accentSensitive value.

      • setAccentSensitive

        public CustomEntity setAccentSensitive​(Boolean accentSensitive)
        Set the accentSensitive property: Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent.
        Parameters:
        accentSensitive - the accentSensitive value to set.
        Returns:
        the CustomEntity object itself.

      • getFuzzyEditDistance

        public Integer getFuzzyEditDistance()
        Get the fuzzyEditDistance property: Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, "Windows10" would still match "Windows", "Windows10" and "Windows 7". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do.
        Returns:
        the fuzzyEditDistance value.

      • setFuzzyEditDistance

        public CustomEntity setFuzzyEditDistance​(Integer fuzzyEditDistance)
        Set the fuzzyEditDistance property: Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, "Windows10" would still match "Windows", "Windows10" and "Windows 7". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do.
        Parameters:
        fuzzyEditDistance - the fuzzyEditDistance value to set.
        Returns:
        the CustomEntity object itself.

      • isDefaultCaseSensitive

        public Boolean isDefaultCaseSensitive()
        Get the defaultCaseSensitive property: Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values.
        Returns:
        the defaultCaseSensitive value.

      • setDefaultCaseSensitive

        public CustomEntity setDefaultCaseSensitive​(Boolean defaultCaseSensitive)
        Set the defaultCaseSensitive property: Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values.
        Parameters:
        defaultCaseSensitive - the defaultCaseSensitive value to set.
        Returns:
        the CustomEntity object itself.

      • isDefaultAccentSensitive

        public Boolean isDefaultAccentSensitive()
        Get the defaultAccentSensitive property: Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values.
        Returns:
        the defaultAccentSensitive value.

      • setDefaultAccentSensitive

        public CustomEntity setDefaultAccentSensitive​(Boolean defaultAccentSensitive)
        Set the defaultAccentSensitive property: Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values.
        Parameters:
        defaultAccentSensitive - the defaultAccentSensitive value to set.
        Returns:
        the CustomEntity object itself.

      • getDefaultFuzzyEditDistance

        public Integer getDefaultFuzzyEditDistance()
        Get the defaultFuzzyEditDistance property: Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values.
        Returns:
        the defaultFuzzyEditDistance value.

      • setDefaultFuzzyEditDistance

        public CustomEntity setDefaultFuzzyEditDistance​(Integer defaultFuzzyEditDistance)
        Set the defaultFuzzyEditDistance property: Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values.
        Parameters:
        defaultFuzzyEditDistance - the defaultFuzzyEditDistance value to set.
        Returns:
        the CustomEntity object itself.

      • getAliases

        public List<CustomEntityAlias> getAliases()
        Get the aliases property: An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name.
        Returns:
        the aliases value.

      • setAliases

        public CustomEntity setAliases​(List<CustomEntityAlias> aliases)
        Set the aliases property: An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name.
        Parameters:
        aliases - the aliases value to set.
        Returns:
        the CustomEntity object itself.