Session¶

class oci.generative_ai_agent_runtime.models.Session(**kwargs)¶

Bases: object

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.

Methods

__init__(**kwargs) Initializes a new Session object with values from keyword arguments.

Attributes

`description`	Gets the description of this Session.
`display_name`	Gets the display_name of this Session.
`id`	[Required] Gets the id of this Session.
`time_created`	[Required] Gets the time_created of this Session.
`time_updated`	Gets the time_updated of this Session.
`welcome_message`	Gets the welcome_message of this Session.

__init__(**kwargs)¶

Initializes a new Session object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this Session.
display_name (str) – The value to assign to the display_name property of this Session.
description (str) – The value to assign to the description property of this Session.
welcome_message (str) – The value to assign to the welcome_message property of this Session.
time_created (datetime) – The value to assign to the time_created property of this Session.
time_updated (datetime) – The value to assign to the time_updated property of this Session.

description¶

Gets the description of this Session. A description of the session.

Returns:	The description of this Session.
Return type:	str

display_name¶

Gets the display_name of this Session. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this Session.
Return type:	str

id¶

[Required] Gets the id of this Session. A unique ID for the session. This ID is immutable on creation.

Returns:	The id of this Session.
Return type:	str

time_created¶

[Required] Gets the time_created of this Session. The date and time that the session started in the format of an RFC3339 datetime string.

Returns:	The time_created of this Session.
Return type:	datetime

time_updated¶

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

Returns:	The time_updated of this Session.
Return type:	datetime

welcome_message¶

Gets the welcome_message of this Session. A greeting message that the you receive when you start of a session.

Returns:	The welcome_message of this Session.
Return type:	str