com.ibm.watson.assistant.v2.model

Class CreateSessionOptions

java.lang.Object

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

com.ibm.watson.assistant.v2.model.CreateSessionOptions

All Implemented Interfaces:

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

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

The createSession options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
RequestAnalytics	analytics() Gets the analytics.
String	assistantId() Gets the assistantId.
CreateSessionOptions.Builder	newBuilder() New builder.

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 CreateSessionOptions.Builder newBuilder()

New builder.

Returns:

a CreateSessionOptions builder

assistantId

public String assistantId()

Gets the assistantId.

The assistant ID or the environment ID of the environment where the assistant is deployed. Set the value for this ID 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 get the **assistant ID** and **environment ID** in the watsonx Assistant interface, open the **Assistant settings** page, and scroll to the **Assistant IDs and API details** section and click **View Details**.

**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

analytics

public RequestAnalytics analytics()

Gets the analytics.

An optional object containing analytics data. Currently, this data is used only for events sent to the Segment extension.

Returns:

the analytics