com.ibm.watson.assistant.v2.model

Class MessageInput

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

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

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class MessageInput
extends com.ibm.cloud.sdk.core.service.model.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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<RuntimeEntity>	entities
protected java.util.List<RuntimeIntent>	intents
protected java.lang.String	messageType
protected MessageInputOptions	options
protected java.lang.String	suggestionId
protected java.lang.String	text

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MessageInput(MessageInput.Builder builder)

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.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

messageType

@SerializedName(value="message_type")
protected java.lang.String messageType

text

protected java.lang.String text

intents

protected java.util.List<RuntimeIntent> intents

entities

protected java.util.List<RuntimeEntity> entities

suggestionId

@SerializedName(value="suggestion_id")
protected java.lang.String suggestionId

options

protected MessageInputOptions options

Constructor Detail

MessageInput

protected MessageInput(MessageInput.Builder builder)

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.

Returns:

the text

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

options

public MessageInputOptions options()

Gets the options.

Optional properties that control how the assistant responds.

Returns:

the options