Package com.oracle.bmc.generativeaiagentruntime.model

Class Session

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeaiagentruntime.model.Session

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public final class Session
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

A session represents an interactive conversation initiated by a user through an API to engage with an agent.

It involves a series of exchanges where the user sends queries or prompts, and the agent responds with relevant information, actions, or assistance based on the user’s input. The session persists for the duration of the interaction, maintaining context and continuity to provide coherent and meaningful responses throughout the conversation.
Note: Objects should always be created or deserialized using the Session.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Session.Builder, which maintain a set of all explicitly set fields called Session.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Session.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
Session(String id, String displayName, String description, String welcomeMessage, Date timeCreated, Date timeUpdated)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Session.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDescription()	A description of the session.
String	getDisplayName()	A user-friendly name.
String	getId()	A unique ID for the session.
Date	getTimeCreated()	The date and time that the session started in the format of an RFC3339 datetime string.
Date	getTimeUpdated()	The date and time that the session was last updated in the format of an RFC3339 datetime string.
String	getWelcomeMessage()	A greeting message that the you receive when you start of a session.
int	hashCode()
Session.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Session

@Deprecated
@ConstructorProperties({"id","displayName","description","welcomeMessage","timeCreated","timeUpdated"})
public Session(String id,
               String displayName,
               String description,
               String welcomeMessage,
               Date timeCreated,
               Date timeUpdated)

Deprecated.

Method Detail

builder

public static Session.Builder builder()

Create a new builder.

toBuilder

public Session.Builder toBuilder()

getId

public String getId()

A unique ID for the session.

This ID is immutable on creation.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly name.

Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:

the value

getDescription

public String getDescription()

A description of the session.

Returns:

the value

getWelcomeMessage

public String getWelcomeMessage()

A greeting message that the you receive when you start of a session.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time that the session started in the format of an RFC3339 datetime string.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The date and time that the session was last updated in the format of an RFC3339 datetime string.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel