com.ibm.watson.assistant.v2.model

Class StatefulMessageResponse

java.lang.Object

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

com.ibm.watson.assistant.v2.model.StatefulMessageResponse

All Implemented Interfaces:

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

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

A response from the watsonx Assistant service.

Method Summary

Modifier and Type	Method and Description
MessageContext	getContext() Gets the context.
MessageInput	getMaskedInput() Gets the maskedInput.
MessageOutput	getMaskedOutput() Gets the maskedOutput.
MessageOutput	getOutput() Gets the output.
String	getUserId() 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

getOutput

public MessageOutput getOutput()

Gets the output.

Assistant output to be rendered or processed by the client.

Returns:

the output

getContext

public MessageContext getContext()

Gets the context.

Context data for the conversation. You can use this property to access context variables. The context is stored by the assistant on a per-session basis.

**Note:** The context is included in message responses only if **return_context**=`true` in the message request. Full context is always included in logs.

Returns:

the context

getUserId

public String getUserId()

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.

Returns:

the userId

getMaskedOutput

public MessageOutput getMaskedOutput()

Gets the maskedOutput.

Assistant output to be rendered or processed by the client. All private data is masked or removed.

Returns:

the maskedOutput

getMaskedInput

public MessageInput getMaskedInput()

Gets the maskedInput.

An input object that includes the input text. All private data is masked or removed.

Returns:

the maskedInput