com.ibm.watson.developer_cloud.conversation.v1.model

Class Entity

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

com.ibm.watson.developer_cloud.conversation.v1.model.Entity

public class Entity
extends GenericModel

An class used to describe the entity payload object.

Constructor Summary

Constructors

Constructor and Description
Entity(String entity, String value, Integer[] location) Instantiates a new entity.

Method Summary

Modifier and Type	Method and Description
String	getEntity() Returns the name of the entity.
Integer[]	getLocation() Returns the location of the entity within the input string, the array will have two values: a start index and end index.
String	getValue() Returns the detected value of the entity.
void	setEntity(String entity) Sets the entity detected by the system for the given input.
void	setLocation(Integer... location) Sets the location of the entity detected by the system (i.e.
void	setValue(String value) Sets the value of the entity as detected by the system.

Methods inherited from class com.ibm.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Entity

public Entity(String entity,
              String value,
              Integer[] location)

Instantiates a new entity.

Parameters:

entity - the entity

value - the value

location - the location

Method Detail

getEntity

public String getEntity()

Returns the name of the entity. e.g. "I'd like to get a pepperoni pizza", entity in this case would likely be "topping" (depending on how the system has been trained). The getValue() of the input would be "pepperoni".

Returns:

the name of an entity

getLocation

public Integer[] getLocation()

Returns the location of the entity within the input string, the array will have two values: a start index and end index.

Returns:

an array of locations (start and end)

getValue

public String getValue()

Returns the detected value of the entity.

Returns:

a string representing the entity value

setEntity

public void setEntity(String entity)

Sets the entity detected by the system for the given input.

Parameters:

entity - the new entity

setLocation

public void setLocation(Integer... location)

Sets the location of the entity detected by the system (i.e. starting index and end index).

Parameters:

location - an array of Integers representing a start and end index

setValue

public void setValue(String value)

Sets the value of the entity as detected by the system.

Parameters:

value - the new value