com.ibm.watson.assistant.v1.model

Class MessageInput

java.lang.Object

com.ibm.cloud.sdk.core.service.model.DynamicModel<Object>

com.ibm.watson.assistant.v1.model.MessageInput

All Implemented Interfaces:

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

public class MessageInput
extends com.ibm.cloud.sdk.core.service.model.DynamicModel<Object>

An input object that includes the input text.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageInput.Builder Builder.

Constructor Summary

Constructors

Constructor and Description
MessageInput()

Method Summary

Modifier and Type	Method and Description
String	getOriginalText() Gets the originalText.
String	getSuggestedText() Gets the suggestedText.
String	getText() Gets the text.
Boolean	isSpellingAutoCorrect() Gets the spellingAutoCorrect.
Boolean	isSpellingSuggestions() Gets the spellingSuggestions.
MessageInput.Builder	newBuilder() New builder.
void	setSpellingAutoCorrect(Boolean spellingAutoCorrect) Sets the spellingAutoCorrect.
void	setSpellingSuggestions(Boolean spellingSuggestions) Sets the spellingSuggestions.
void	setText(String text) Sets the text.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.DynamicModel

equals, get, getAdditionalPropertyTypeToken, getProperties, getPropertyNames, hashCode, put, removeProperties, removeProperty, setProperties, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageInput

public MessageInput()

Method Detail

newBuilder

public MessageInput.Builder newBuilder()

New builder.

Returns:

a MessageInput builder

getText

public String getText()

Gets the text.

The text of the user input. This string cannot contain carriage return, newline, or tab characters.

Returns:

the text

setText

public void setText(String text)

Sets the text.

Parameters:

text - the new text

isSpellingSuggestions

public Boolean isSpellingSuggestions()

Gets the spellingSuggestions.

Whether to use spelling correction when processing the input. This property overrides the value of the **spelling_suggestions** property in the workspace settings.

Returns:

the spellingSuggestions

setSpellingSuggestions

public void setSpellingSuggestions(Boolean spellingSuggestions)

Sets the spellingSuggestions.

Parameters:

spellingSuggestions - the new spellingSuggestions

isSpellingAutoCorrect

public Boolean isSpellingAutoCorrect()

Gets the spellingAutoCorrect.

Whether to use autocorrection when processing the input. If spelling correction is used and this property is `false`, any suggested corrections are returned in the **suggested_text** property of the message response. If this property is `true`, any corrections are automatically applied to the user input, and the original text is returned in the **original_text** property of the message response. This property overrides the value of the **spelling_auto_correct** property in the workspace settings.

Returns:

the spellingAutoCorrect

setSpellingAutoCorrect

public void setSpellingAutoCorrect(Boolean spellingAutoCorrect)

Sets the spellingAutoCorrect.

Parameters:

spellingAutoCorrect - the new spellingAutoCorrect

getSuggestedText

public String getSuggestedText()

Gets the suggestedText.

Any suggested corrections of the input text. This property is returned only if spelling correction is enabled and autocorrection is disabled.

Returns:

the suggestedText

getOriginalText

public String getOriginalText()

Gets the originalText.

The original user input text. This property is returned only if autocorrection is enabled and the user input was corrected.

Returns:

the originalText