Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CustomEntity

Package version

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

Hierarchy

  • CustomEntity

Index

Properties

Optional accentSensitive

accentSensitive: undefined | false | true

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

Optional aliases

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

Optional caseSensitive

caseSensitive: undefined | false | true

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.

Optional defaultAccentSensitive

defaultAccentSensitive: undefined | false | true

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

Optional defaultCaseSensitive

defaultCaseSensitive: undefined | false | true

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

Optional defaultFuzzyEditDistance

defaultFuzzyEditDistance: undefined | 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.

Optional description

description: undefined | 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.

Optional fuzzyEditDistance

fuzzyEditDistance: undefined | 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.

Optional id

id: undefined | 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.

Optional subtype

subtype: undefined | 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.

Optional type

type: undefined | 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.

Generated using TypeDoc