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

Class MessageRequest.Builder

java.lang.Object

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

Enclosing class:

MessageRequest

public static class MessageRequest.Builder
extends Object

The Class Builder.

Constructor Summary

Constructors

Constructor and Description
Builder() Instantiates a new Builder.

Method Summary

Modifier and Type	Method and Description
MessageRequest.Builder	alternateIntents(Boolean alternateIntents) Sets the alternate intents flag.
MessageRequest	build() Generates a new MessageRequest object.
MessageRequest.Builder	context(Map<String,Object> context) Sets the context/state which is to be sent to the message API as a part of the service request.
MessageRequest.Builder	entities(List<Entity> entities) Sets the list the entities to be send as part of the request. Existing entities will be replaced.
MessageRequest.Builder	entity(Entity entity) Adds an entity to the list of entities to be send as part of the request.
MessageRequest.Builder	input(Map<String,Object> input) Sets the input which is to be sent to the message API as a part of the service request.
MessageRequest.Builder	inputText(String text) Sets the input text which is to be sent to the message API as a part of the service request.
MessageRequest.Builder	intent(Intent intent) Adds an intent to the list of intents to be send as part of the request.
MessageRequest.Builder	intents(List<Intent> intents) Sets the list the intents to be send as part of the request. Existing intents will be replaced.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Instantiates a new Builder.

Method Detail

alternateIntents

public MessageRequest.Builder alternateIntents(Boolean alternateIntents)

Sets the alternate intents flag. Set to true to return all matching intents

Parameters:

alternateIntents - the alternate intents flag

Returns:

a builder object

build

public MessageRequest build()

Generates a new MessageRequest object. It will contain the parameters set in the builder.

Returns:

a MessageRequest instance

context

public MessageRequest.Builder context(Map<String,Object> context)

Sets the context/state which is to be sent to the message API as a part of the service request. Each response from the message API returns a context object which represents the state as defined by the service. The state is not maintained by the service, so the client must keep the state from each API call, and pass that state in as a part of any subsequent requests.

Parameters:

context - a map containing key value pairs representing the state/context of the conversation

Returns:

a builder object

input

public MessageRequest.Builder input(Map<String,Object> input)

Sets the input which is to be sent to the message API as a part of the service request. Typically the input will contain a text property (key and value). The text property is generally interpreted as being the user/system input which the service must parse for intents, entities etc..
In advanced cases the client may pass in more than just text as a part of the service input. For the majority of cases calling the inputText(String) method is sufficient to send text to the service on behalf of the user/system.

Parameters:

input - a map of properties to be sent to the service under the input property

Returns:

a builder object

entity

public MessageRequest.Builder entity(Entity entity)

Adds an entity to the list of entities to be send as part of the request.

Parameters:

entity - the entity

Returns:

the builder

intent

public MessageRequest.Builder intent(Intent intent)

Adds an intent to the list of intents to be send as part of the request.

Parameters:

intent - the intent

Returns:

the builder

entities

public MessageRequest.Builder entities(List<Entity> entities)

Sets the list the entities to be send as part of the request.
Existing entities will be replaced.

Parameters:

entities - the entities

Returns:

the builder

intents

public MessageRequest.Builder intents(List<Intent> intents)

Sets the list the intents to be send as part of the request.
Existing intents will be replaced.

Parameters:

intents - the intents

Returns:

the builder

inputText

public MessageRequest.Builder inputText(String text)

Sets the input text which is to be sent to the message API as a part of the service request.

Parameters:

text - the textual value to be assigned to the 'text' property on the input object.

Returns:

a builder object