com.ibm.watson.assistant.v2.model

Class MessageInputOptions

java.lang.Object

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

com.ibm.watson.assistant.v2.model.MessageInputOptions

All Implemented Interfaces:

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

public class MessageInputOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Optional properties that control how the assistant responds.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
Boolean	alternateIntents() Gets the alternateIntents.
Boolean	asyncCallout() Gets the asyncCallout.
Boolean	debug() Gets the debug.
Boolean	export() Gets the export.
MessageInputOptions.Builder	newBuilder() New builder.
Boolean	restart() Gets the restart.
Boolean	returnContext() Gets the returnContext.
MessageInputOptionsSpelling	spelling() Gets the spelling.

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 Detail

newBuilder

public MessageInputOptions.Builder newBuilder()

New builder.

Returns:

a MessageInputOptions builder

restart

public Boolean restart()

Gets the restart.

Whether to restart dialog processing at the root of the dialog, regardless of any previously visited nodes. **Note:** This does not affect `turn_count` or any other context variables.

Returns:

the restart

alternateIntents

public Boolean alternateIntents()

Gets the alternateIntents.

Whether to return more than one intent. Set to `true` to return all matching intents.

Returns:

the alternateIntents

asyncCallout

public Boolean asyncCallout()

Gets the asyncCallout.

Whether custom extension callouts are executed asynchronously. Asynchronous execution means the response to the extension callout will be processed on the subsequent message call, the initial message response signals to the client that the operation may be long running. With synchronous execution the custom extension is executed and returns the response in a single message turn. **Note:** **async_callout** defaults to true for API versions earlier than 2023-06-15.

Returns:

the asyncCallout

spelling

public MessageInputOptionsSpelling spelling()

Gets the spelling.

Spelling correction options for the message. Any options specified on an individual message override the settings configured for the skill.

Returns:

the spelling

debug

public Boolean debug()

Gets the debug.

Whether to return additional diagnostic information. Set to `true` to return additional information in the `output.debug` property. If you also specify **return_context**=`true`, the returned skill context includes the `system.state` property.

Returns:

the debug

returnContext

public Boolean returnContext()

Gets the returnContext.

Whether to return session context with the response. If you specify `true`, the response includes the `context` property. If you also specify **debug**=`true`, the returned skill context includes the `system.state` property.

Returns:

the returnContext

export

public Boolean export()

Gets the export.

Whether to return session context, including full conversation state. If you specify `true`, the response includes the `context` property, and the skill context includes the `system.state` property.

**Note:** If **export**=`true`, the context is returned regardless of the value of **return_context**.

Returns:

the export