com.ibm.watson.developer_cloud.assistant.v2.model

Class MessageInput

java.lang.Object

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

com.ibm.watson.developer_cloud.assistant.v2.model.MessageInput

All Implemented Interfaces:

ObjectModel

public class MessageInput
extends GenericModel

An input object that includes the input text.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageInput.Builder Builder.
static interface	MessageInput.MessageType The type of user input.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<RuntimeEntity>	entities() Gets the entities.
java.util.List<RuntimeIntent>	intents() Gets the intents.
java.lang.String	messageType() Gets the messageType.
MessageInput.Builder	newBuilder() New builder.
MessageInputOptions	options() Gets the options.
java.lang.String	suggestionId() Gets the suggestionId.
java.lang.String	text() Gets the text.

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

newBuilder

public MessageInput.Builder newBuilder()

New builder.

Returns:

a MessageInput builder

messageType

public java.lang.String messageType()

Gets the messageType. The type of user input. Currently, only text input is supported.

Returns:

the messageType

text

public java.lang.String text()

Gets the text. The text of the user input. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 2048 characters.

Returns:

the text

options

public MessageInputOptions options()

Gets the options. Optional properties that control how the assistant responds.

Returns:

the options

intents

public java.util.List<RuntimeIntent> intents()

Gets the intents. Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

Returns:

the intents

entities

public java.util.List<RuntimeEntity> entities()

Gets the entities. Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.

Returns:

the entities

suggestionId

public java.lang.String suggestionId()

Gets the suggestionId. For internal use only.

Returns:

the suggestionId