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.

Method Summary

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

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

assistantId

public String assistantId()

Gets the assistantId.

The assistant ID or the environment ID of the environment where the assistant is deployed, depending on the type of request: - For message, session, and log requests, specify the environment ID of the environment where the assistant is deployed. - For all other requests, specify the assistant ID of the assistant.

To find the environment ID or assistant ID in the watsonx Assistant user interface, open the assistant settings and scroll to the **Environments** section.

**Note:** If you are using the classic Watson Assistant experience, always use the assistant ID. To find the assistant ID in the user interface, open the assistant settings and click API Details.

Returns:

the assistantId

sessionId

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

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

**Note:** The total size of the context data stored for a stateful session cannot exceed 100KB.

Returns:

the context

userId

public String userId()

Gets the userId.

A string value that identifies the user who is interacting with the assistant. 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.global.session_id**.

**Note:** This property is the same as the **user_id** property in the global system context. If **user_id** is specified in both locations, the value specified at the root is used.

Returns:

the userId