com.ibm.watson.assistant.v2.model

Class RuntimeEntity

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.assistant.v2.model.RuntimeEntity

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class RuntimeEntity
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The entity value that was recognized in the user input.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RuntimeEntity.Builder Builder.

Method Summary

Modifier and Type	Method and Description
List<RuntimeEntityAlternative>	alternatives() Gets the alternatives.
Double	confidence() Gets the confidence.
String	entity() Gets the entity.
List<CaptureGroup>	groups() Gets the groups.
RuntimeEntityInterpretation	interpretation() Gets the interpretation.
List<Long>	location() Gets the location.
RuntimeEntity.Builder	newBuilder() New builder.
RuntimeEntityRole	role() Gets the role.
String	skill() Gets the skill.
String	value() Gets the value.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public RuntimeEntity.Builder newBuilder()

New builder.

Returns:

a RuntimeEntity builder

entity

public String entity()

Gets the entity.

An entity detected in the input.

Returns:

the entity

location

public List<Long> location()

Gets the location.

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

Returns:

the location

value

public String value()

Gets the value.

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

Returns:

the value

confidence

public Double confidence()

Gets the confidence.

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

Returns:

the confidence

groups

public List<CaptureGroup> groups()

Gets the groups.

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

Returns:

the groups

interpretation

public RuntimeEntityInterpretation interpretation()

Gets the 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](https://cloud.ibm.com/docs/assistant?topic=assistant-beta-system-entities).

Returns:

the interpretation

alternatives

public List<RuntimeEntityAlternative> alternatives()

Gets the alternatives.

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.

Returns:

the alternatives

role

public RuntimeEntityRole role()

Gets the 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.

Returns:

the role

skill

public String skill()

Gets the skill.

The skill that recognized the entity value. Currently, the only possible values are `main skill` for the dialog skill (if enabled) and `actions skill` for the actions skill.

This property is present only if the assistant has both a dialog skill and an actions skill.

Returns:

the skill