com.ibm.watson.assistant.v1.model

Class RuntimeEntity

java.lang.Object

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

com.ibm.watson.assistant.v1.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

A term from the request that was identified as an entity.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<RuntimeEntityAlternative>	alternatives
protected java.lang.Double	confidence
protected java.lang.String	entity
protected java.util.List<CaptureGroup>	groups
protected RuntimeEntityInterpretation	interpretation
protected java.util.List<java.lang.Long>	location
protected java.util.Map<java.lang.String,java.lang.Object>	metadata
protected RuntimeEntityRole	role
protected java.lang.String	value

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RuntimeEntity(RuntimeEntity.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<RuntimeEntityAlternative>	alternatives() Gets the alternatives.
java.lang.Double	confidence() Gets the confidence.
java.lang.String	entity() Gets the entity.
java.util.List<CaptureGroup>	groups() Gets the groups.
RuntimeEntityInterpretation	interpretation() Gets the interpretation.
java.util.List<java.lang.Long>	location() Gets the location.
java.util.Map<java.lang.String,java.lang.Object>	metadata() Gets the metadata.
RuntimeEntity.Builder	newBuilder() New builder.
RuntimeEntityRole	role() Gets the role.
java.lang.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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

entity

protected java.lang.String entity

location

protected java.util.List<java.lang.Long> location

value

protected java.lang.String value

confidence

protected java.lang.Double confidence

metadata

protected java.util.Map<java.lang.String,java.lang.Object> metadata

groups

protected java.util.List<CaptureGroup> groups

interpretation

protected RuntimeEntityInterpretation interpretation

alternatives

protected java.util.List<RuntimeEntityAlternative> alternatives

role

protected RuntimeEntityRole role

Constructor Detail

RuntimeEntity

protected RuntimeEntity(RuntimeEntity.Builder builder)

Method Detail

newBuilder

public RuntimeEntity.Builder newBuilder()

New builder.

Returns:

a RuntimeEntity builder

entity

public java.lang.String entity()

Gets the entity.

An entity detected in the input.

Returns:

the entity

location

public java.util.List<java.lang.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 java.lang.String value()

Gets the value.

The entity value that was recognized in the user input.

Returns:

the value

confidence

public java.lang.Double confidence()

Gets the confidence.

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

Returns:

the confidence

metadata

public java.util.Map<java.lang.String,java.lang.Object> metadata()

Gets the metadata.

Any metadata for the entity.

Returns:

the metadata

groups

public java.util.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 workspace.

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 java.util.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 workspace.

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 workspace.

Returns:

the role