Package version:

Interface CustomEntity

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

interface CustomEntity {
    accentSensitive?: boolean;
    aliases?: CustomEntityAlias[];
    caseSensitive?: boolean;
    defaultAccentSensitive?: boolean;
    defaultCaseSensitive?: boolean;
    defaultFuzzyEditDistance?: number;
    description?: string;
    fuzzyEditDistance?: number;
    id?: string;
    name: string;
    subtype?: string;
    type?: string;
}

Properties

accentSensitive? aliases? caseSensitive? defaultAccentSensitive? defaultCaseSensitive? defaultFuzzyEditDistance? description? fuzzyEditDistance? id? name subtype? type?

Properties

OptionalaccentSensitive

accentSensitive?: boolean

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

Optionalaliases

aliases?: CustomEntityAlias[]

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

OptionalcaseSensitive

caseSensitive?: boolean

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.

OptionaldefaultAccentSensitive

defaultAccentSensitive?: boolean

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

OptionaldefaultCaseSensitive

defaultCaseSensitive?: boolean

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

OptionaldefaultFuzzyEditDistance

defaultFuzzyEditDistance?: number

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

Optionaldescription

description?: string

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.

OptionalfuzzyEditDistance

fuzzyEditDistance?: number

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.

Optionalid

id?: string

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

name: string

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.

Optionalsubtype

subtype?: string

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.

Optionaltype

type?: string

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.

Settings

Member Visibility