com.ibm.watson.assistant.v2.model

Class MessageRequest

java.lang.Object

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

com.ibm.watson.assistant.v2.model.MessageRequest

All Implemented Interfaces:

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

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

A stateful message request formatted for the Watson Assistant service.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
MessageContext	context() Gets the context.
MessageInput	input() Gets the input.
MessageRequest.Builder	newBuilder() New builder.
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 MessageRequest.Builder newBuilder()

New builder.

Returns:

a MessageRequest builder

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