Package com.ibm.watson.assistant.v2.model

Class MessageStatelessOptions

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.watson.assistant.v2.model.MessageStatelessOptions
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class MessageStatelessOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
The messageStateless options.

  • Method Details

    • newBuilder

      public MessageStatelessOptions.Builder newBuilder()
      New builder.
      Returns:
      a MessageStatelessOptions builder

    • assistantId

      public 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

    • input

      public MessageInputStateless input()
      Gets the input.

      An input object that includes the input text.

      Returns:
      the input

    • context

      public MessageContextStateless 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 not stored by the assistant. To maintain session state, include the context from the previous response.

      **Note:** The total size of the context data for a stateless session cannot exceed 250KB.

      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 in a message request, the value specified at the root is used.

      Returns:
      the userId