Class Session
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.
Inherited Members
Namespace: Oci.GenerativeaiagentruntimeService.Models
Assembly: OCI.DotNetSDK.Generativeaiagentruntime.dll
Syntax
public class Session
Properties
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | A description of the session. |
DisplayName
Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | A unique ID for the session. This ID is immutable on creation. |
Remarks
Required
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time that the session started in the format of an RFC3339 datetime string. |
Remarks
Required
TimeUpdated
Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time that the session was last updated in the format of an RFC3339 datetime string. |
WelcomeMessage
Declaration
[JsonProperty(PropertyName = "welcomeMessage")]
public string WelcomeMessage { get; set; }
Property Value
Type | Description |
---|---|
string | A greeting message that the you receive when you start of a session. |