Package 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	Description
static class	MessageInput.Builder	Builder.
static interface	MessageInput.MessageType	The type of the message:

Method Summary

Modifier and Type	Method	Description
List<RuntimeEntity>	entities()	Gets the entities.
List<RuntimeIntent>	intents()	Gets the intents.
String	messageType()	Gets the messageType.
MessageInput.Builder	newBuilder()	New builder.
MessageInputOptions	options()	Gets the options.
String	suggestionId()	Gets the suggestionId.
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

getClass, notify, notifyAll, wait, wait, wait

Method Details

newBuilder

public MessageInput.Builder newBuilder()

New builder.

Returns:

a MessageInput builder

messageType

public String messageType()

Gets the messageType.

The type of the message:

- `text`: The user input is processed normally by the assistant. - `search`: Only search results are returned. (Any dialog or actions skill is bypassed.)

**Note:** A `search` message results in an error if no search skill is configured for the assistant.

Returns:

the messageType

text

public 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 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 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 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