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

Class MessageRequest

java.lang.Object

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

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

public class MessageRequest
extends GenericModel

Object that represents the input and context of a conversation. This is used by the ConversationService.message(String, MessageRequest) method

See Also:

http://www.ibm.com/ watson/developercloud/conversation.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageRequest.Builder The Class Builder.

Method Summary

Modifier and Type	Method and Description
Boolean	alternateIntents() Whether to return more than one intent.
Map<String,Object>	context() Returns a map used to store context/state for the message API.
List<Entity>	entities() Returns the entity list.
Map<String,Object>	input() Returns a map storing the input which is to be sent to the service as a part of the API request.
String	inputText() Convenience method which allows the developer to quickly retrieve the 'text' property from the input object.
List<Intent>	intents() Returns the intent list.
MessageRequest.Builder	newBuilder() New builder.

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

Method Detail

alternateIntents

public Boolean alternateIntents()

Whether to return more than one intent. Set to true to return all matching intents boolean
Default: false

Returns:

the boolean indicating if alternate intents should be returned

context

public Map<String,Object> context()

Returns a map used to store context/state for the message API. Each response from the message API will return a context object as a part of the payload. This context must be maintained and passed in as a part of subsequent API calls.

Returns:

a map of properties

input

public Map<String,Object> input()

Returns a map storing the input which is to be sent to the service as a part of the API request.

Returns:

a map of properties

intents

public List<Intent> intents()

Returns the intent list.

Returns:

the intent list

entities

public List<Entity> entities()

Returns the entity list.

Returns:

the entity list

inputText

public String inputText()

Convenience method which allows the developer to quickly retrieve the 'text' property from the input object. This is equivalent to calling:

 Map<String, Object> input = request.getInput();
 String text = null;
 if (input != null) {
   text = input.get("text");
 }
 

Returns:

the value of the input.text property

newBuilder

public MessageRequest.Builder newBuilder()

New builder.

Returns:

the builder