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
java.lang.Double	confidence() Gets the confidence.
java.lang.String	entity() Gets the entity.
java.util.List<CaptureGroup>	groups() Gets the groups.
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.
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

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 term in the input text that was recognized as an entity value.

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