Class BaseSessionService`Abstract`

Base class for session services. The service provides a set of methods for managing sessions and events.

Hierarchy (view full)

BaseSessionService

Index

Constructors

Methods

createSession getSession listSessions deleteSession endSession appendEvent updateSessionState

Constructors

constructor

new BaseSessionService(): BaseSessionService
Returns BaseSessionService

Methods

`Abstract`createSession

createSession(appName, userId, state?, sessionId?): Promise<Session>
Creates a new session.
Parameters
- appName: string
  The name of the app.
- userId: string
  The id of the user.
- Optionalstate: Record<string, any>
  The initial state of the session.
- OptionalsessionId: string
  The client-provided id of the session. If not provided, a generated ID will be used.
Returns Promise<Session>
The newly created session instance.
- Defined in packages/adk/src/sessions/base-session-service.ts:36

`Abstract`getSession

getSession(appName, userId, sessionId, config?): Promise<Session>
Gets a session.
Parameters
- appName: string
  The name of the app.
- userId: string
  The id of the user.
- sessionId: string
  The id of the session.
- Optionalconfig: GetSessionConfig
  Optional config for getting the session.
Returns Promise<Session>
The session or undefined if not found.
- Defined in packages/adk/src/sessions/base-session-service.ts:51

`Abstract`listSessions

listSessions(appName, userId): Promise<ListSessionsResponse>
Lists all the sessions.
Parameters
- appName: string
  The name of the app.
- userId: string
  The id of the user.
Returns Promise<ListSessionsResponse>
The response containing the list of sessions.
- Defined in packages/adk/src/sessions/base-session-service.ts:64

`Abstract`deleteSession

deleteSession(appName, userId, sessionId): Promise<void>
Deletes a session.
Parameters
- appName: string
  The name of the app.
- userId: string
  The id of the user.
- sessionId: string
  The id of the session.
Returns Promise<void>
- Defined in packages/adk/src/sessions/base-session-service.ts:75

`Abstract`endSession

endSession(appName, userId, sessionId): Promise<Session>
Ends a session and returns its final state. This is typically called when a session is complete and should be stored in long-term memory before potential cleanup.
Parameters
- appName: string
  The name of the app.
- userId: string
  The id of the user.
- sessionId: string
  The id of the session.
Returns Promise<Session>
The session with its final state, or undefined if not found.
- Defined in packages/adk/src/sessions/base-session-service.ts:90

appendEvent

appendEvent(session, event): Promise<Event>
Appends an event to a session object.
Parameters
- session: Session
  The session to append the event to.
- event: Event
  The event to append.
Returns Promise<Event>
The appended event.
- Defined in packages/adk/src/sessions/base-session-service.ts:102

`Protected`updateSessionState

updateSessionState(session, event): void
Updates the session state based on the event.
Parameters
- session: Session
  The session to update.
- event: Event
  The event containing state changes.
Returns void
- Defined in packages/adk/src/sessions/base-session-service.ts:116