IBM.Watson.Assistant.v2.Model.RuntimeEntity Class Reference

The entity value that was recognized in the user input. More...

Properties
string	Entity [get, set]
	An entity detected in the input. More...
List< long?>	Location [get, set]
	An array of zero-based character offsets that indicate where the detected entity values begin and end in the input text. More...
string	Value [get, set]
	The term in the input text that was recognized as an entity value. More...
float	Confidence [get, set]
	A decimal percentage that represents Watson's confidence in the recognized entity. More...
Dictionary< string, object >	Metadata [get, set]
	Any metadata for the entity. More...
List< CaptureGroup >	Groups [get, set]
	The recognized capture groups for the entity, as defined by the entity pattern. More...
RuntimeEntityInterpretation	Interpretation [get, set]
	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. More...
List< RuntimeEntityAlternative >	Alternatives [get, set]
	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. More...
RuntimeEntityRole	Role [get, set]
	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. More...

Detailed Description

The entity value that was recognized in the user input.

Property Documentation

Alternatives

List<RuntimeEntityAlternative> IBM.Watson.Assistant.v2.Model.RuntimeEntity.Alternatives

getset

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.

Confidence

float IBM.Watson.Assistant.v2.Model.RuntimeEntity.Confidence

getset

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

Entity

string IBM.Watson.Assistant.v2.Model.RuntimeEntity.Entity

getset

An entity detected in the input.

Groups

List<CaptureGroup> IBM.Watson.Assistant.v2.Model.RuntimeEntity.Groups

getset

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

Interpretation

RuntimeEntityInterpretation IBM.Watson.Assistant.v2.Model.RuntimeEntity.Interpretation

getset

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.

Location

List<long?> IBM.Watson.Assistant.v2.Model.RuntimeEntity.Location

getset

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

Metadata

Dictionary<string, object> IBM.Watson.Assistant.v2.Model.RuntimeEntity.Metadata

getset

Any metadata for the entity.

Role

RuntimeEntityRole IBM.Watson.Assistant.v2.Model.RuntimeEntity.Role

getset

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

string IBM.Watson.Assistant.v2.Model.RuntimeEntity.Value

getset

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

---

The documentation for this class was generated from the following file:

• src/IBM.Watson.Assistant.v2/Model/RuntimeEntity.cs