com.ibm.watson.assistant.v2.model

Class MessageOptions

java.lang.Object

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

com.ibm.watson.assistant.v2.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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	assistantId
protected MessageContext	context
protected MessageInput	input
protected java.lang.String	sessionId

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	assistantId() Gets the assistantId.
MessageContext	context() Gets the context.
MessageInput	input() Gets the input.
MessageOptions.Builder	newBuilder() New builder.
java.lang.String	sessionId() Gets the sessionId.

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

assistantId

protected java.lang.String assistantId

sessionId

protected java.lang.String sessionId

input

protected MessageInput input

context

protected MessageContext context

Constructor Detail

MessageOptions

protected MessageOptions(MessageOptions.Builder builder)

Method Detail

newBuilder

public MessageOptions.Builder newBuilder()

New builder.

Returns:

a MessageOptions builder

assistantId

public java.lang.String assistantId()

Gets the assistantId. Unique identifier of the assistant. To find the assistant ID in the Watson Assistant user interface, open the assistant settings and click **API Details**. For information about creating assistants, see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-add#assistant-add-task). **Note:** Currently, the v2 API does not support creating assistants.

Returns:

the assistantId

sessionId

public java.lang.String sessionId()

Gets the sessionId. Unique identifier of the session.

Returns:

the sessionId

input

public MessageInput input()

Gets the input. An input object that includes the input text.

Returns:

the input

context

public MessageContext context()

Gets the context. State information for the conversation. The context is stored by the assistant on a per-session basis. You can use this property to set or modify context variables, which can also be accessed by dialog nodes.

Returns:

the context