com.ibm.watson.developer_cloud.conversation.v1_experimental.model

Class MessageResponse

java.lang.Object

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

com.ibm.watson.developer_cloud.conversation.v1_experimental.model.MessageResponse

public class MessageResponse
extends GenericModel

The response payload from the Conversation service's message API call ConversationService.message(String, MessageRequest).

See Also:

http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/conversation.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageResponse.Entity An class used to describe the entity payload object.
static class	MessageResponse.Intent A class representing an Intent as detected by the service.

Constructor Summary

Constructors

Constructor and Description
MessageResponse()

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getContext() Returns the context as returned by the service.
List<MessageResponse.Entity>	getEntities() Returns the list of entities as detected by the service.
List<MessageResponse.Intent>	getIntents() Returns the list of intents as detected by the service.
Map<String,Object>	getOutput() Returns the output as returned by the service, may be null.
String	getText() A convenience method for getting the text property from the output object.
void	setContext(Map<String,Object> context) Sets the context as determined by the service.
void	setEntities(List<MessageResponse.Entity> entities) Sets a list of entities as detected by the service.
void	setIntents(List<MessageResponse.Intent> intents) Sets a list of intents as detected by the service.
void	setOutput(Map<String,Object> output) Sets the output as returned by the service.

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

MessageResponse

public MessageResponse()

Method Detail

getContext

public Map<String,Object> getContext()

Returns the context as returned by the service. At each step in the chat flow the conversation designer has the ability to add information to the chat context. The context is a map of key value pairs, with the values being any valid JSON objects/primitives.

Returns:

a map representing context/state

getEntities

public List<MessageResponse.Entity> getEntities()

Returns the list of entities as detected by the service.

Returns:

an array of MessageResponse.Entity objects

getIntents

public List<MessageResponse.Intent> getIntents()

Returns the list of intents as detected by the service.

Returns:

an array of MessageResponse.Intent objects.

getOutput

public Map<String,Object> getOutput()

Returns the output as returned by the service, may be null.

Returns:

a map of objects representing the response from the Dialog portion of the service.

setContext

public void setContext(Map<String,Object> context)

Sets the context as determined by the service.

Parameters:

context - a map of key value pairs

setEntities

public void setEntities(List<MessageResponse.Entity> entities)

Sets a list of entities as detected by the service.

Parameters:

entities - an array of entities

setIntents

public void setIntents(List<MessageResponse.Intent> intents)

Sets a list of intents as detected by the service.

Parameters:

intents - an array of intents

setOutput

public void setOutput(Map<String,Object> output)

Sets the output as returned by the service.

Parameters:

output - a map of outputs as defined by the conversation designer

getText

public String getText()

A convenience method for getting the text property from the output object. This is equivalent to calling:

 String text = null;
 Map output = response.getOutput();
 return if(output != null){ text
 = output.get("text"); }

Returns:

the text which is to be displayed/returned to the end user