Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RuntimeEntity

The entity value that was recognized in the user input.

Hierarchy

  • RuntimeEntity

Index

Properties

Optional alternatives

alternatives: RuntimeEntityAlternative[]

An array of possible alternative values that the user might have intended instead of the value returned in the value property. This property is returned only for @sys-time and @sys-date entities when the user's input is ambiguous.

This property is included only if the new system entities are enabled for the skill.

Optional confidence

confidence: number

A decimal percentage that represents Watson's confidence in the recognized entity.

entity

entity: string

An entity detected in the input.

Optional groups

groups: CaptureGroup[]

The recognized capture groups for the entity, as defined by the entity pattern.

Optional interpretation

An object containing detailed information about the entity recognized in the user input. This property is included only if the new system entities are enabled for the skill.

For more information about how the new system entities are interpreted, see the documentation.

Optional location

location: number[]

An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text.

Optional metadata

metadata: JsonObject

Deprecated.* Any metadata for the entity.

Beginning with the 2021-06-14 API version, the metadata property is no longer returned. For information about system entities recognized in the user input, see the interpretation property.

Optional role

An object describing the role played by a system entity that is specifies the beginning or end of a range recognized in the user input. This property is included only if the new system entities are enabled for the skill.

value

value: string

The term in the input text that was recognized as an entity value.

Generated using TypeDoc