Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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.

Properties

Optional description

description: undefined | string

A description of the session.

Optional displayName

displayName: undefined | string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

id

id: string

A unique ID for the session. This ID is immutable on creation.

timeCreated

timeCreated: Date

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

Optional timeUpdated

timeUpdated: Date

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

Optional welcomeMessage

welcomeMessage: undefined | string

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

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Session): object

getJsonObj