CustomEntity interface

Package:

@azure/search-documents

An object that contains information about the matches that were found, and related metadata.

Properties

accentSensitive	Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent.
aliases	An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name.
caseSensitive	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.
defaultAccentSensitive	Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values.
defaultCaseSensitive	Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values.
defaultFuzzyEditDistance	Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values.
description	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.
fuzzyEditDistance	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.
id	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.
name	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.
subtype	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.
type	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.

Property Details

accentSensitive

Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent.

accentSensitive?: boolean

Property Value

boolean

aliases

An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name.

aliases?: CustomEntityAlias[]

Property Value

CustomEntityAlias[]

caseSensitive

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.

caseSensitive?: boolean

Property Value

boolean

defaultAccentSensitive

Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values.

defaultAccentSensitive?: boolean

Property Value

boolean

defaultCaseSensitive

Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values.

defaultCaseSensitive?: boolean

Property Value

boolean

defaultFuzzyEditDistance

Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values.

defaultFuzzyEditDistance?: number

Property Value

number

description

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.

description?: string

Property Value

string

fuzzyEditDistance

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.

fuzzyEditDistance?: number

Property Value

number

id

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.

id?: string

Property Value

string

name

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.

name: string

Property Value

string

subtype

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.

subtype?: string

Property Value

string

type

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.

type?: string

Property Value

string