com.ibm.watson.assistant.v1.model

Class MessageOptions

java.lang.Object

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

com.ibm.watson.assistant.v1.model.MessageOptions

All Implemented Interfaces:

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

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

The message options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
Boolean	alternateIntents() Gets the alternateIntents.
Context	context() Gets the context.
List<RuntimeEntity>	entities() Gets the entities.
MessageInput	input() Gets the input.
List<RuntimeIntent>	intents() Gets the intents.
MessageOptions.Builder	newBuilder() New builder.
Boolean	nodesVisitedDetails() Gets the nodesVisitedDetails.
OutputData	output() Gets the output.
String	userId() Gets the userId.
String	workspaceId() Gets the workspaceId.

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 MessageOptions.Builder newBuilder()

New builder.

Returns:

a MessageOptions builder

workspaceId

public String workspaceId()

Gets the workspaceId.

Unique identifier of the workspace.

Returns:

the workspaceId

input

public MessageInput input()

Gets the input.

An input object that includes the input text.

Returns:

the input

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

alternateIntents

public Boolean alternateIntents()

Gets the alternateIntents.

Whether to return more than one intent. A value of `true` indicates that all matching intents are returned.

Returns:

the alternateIntents

context

public Context context()

Gets the context.

State information for the conversation. To maintain state, include the context from the previous response.

Returns:

the context

output

public OutputData output()

Gets the output.

An output object that includes the response to the user, the dialog nodes that were triggered, and messages from the log.

Returns:

the output

userId

public String userId()

Gets the userId.

A string value that identifies the user who is interacting with the workspace. The client must provide a unique identifier for each individual end user who accesses the application. For user-based plans, this user ID is used to identify unique users for billing purposes. This string cannot contain carriage return, newline, or tab characters. If no value is specified in the input, **user_id** is automatically set to the value of **context.conversation_id**.

**Note:** This property is the same as the **user_id** property in the context metadata. If **user_id** is specified in both locations in a message request, the value specified at the root is used.

Returns:

the userId

nodesVisitedDetails

public Boolean nodesVisitedDetails()

Gets the nodesVisitedDetails.

Whether to include additional diagnostic information about the dialog nodes that were visited during processing of the message.

Returns:

the nodesVisitedDetails