Class VertexAiSessionService

Connects to the Vertex AI Agent Engine Session Service using GenAI API client.

https://cloud.google.com/vertex-ai/generative-ai/docs/agent-engine/sessions/overview

Hierarchy (view full)

BaseSessionService
- VertexAiSessionService

Index

Constructors

Methods

updateSessionState createSession getSession listSessions deleteSession appendEvent

Constructors

constructor

new VertexAiSessionService(options?): VertexAiSessionService
Initializes the VertexAiSessionService.
Parameters
- options: {
      project?: string;
      location?: string;
      agentEngineId?: string;
  } = {}
  - Optionalproject?: string
  - Optionallocation?: string
  - OptionalagentEngineId?: string
Returns VertexAiSessionService
Overrides BaseSessionService.constructor
- Defined in packages/adk/src/sessions/vertex-ai-session-service.ts:43

Methods

`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
Inherited from BaseSessionService.updateSessionState
- Defined in packages/adk/src/sessions/base-session-service.ts:101

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.
Overrides BaseSessionService.createSession
- Defined in packages/adk/src/sessions/vertex-ai-session-service.ts:56

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.
Overrides BaseSessionService.getSession
- Defined in packages/adk/src/sessions/vertex-ai-session-service.ts:131

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.
Overrides BaseSessionService.listSessions
- Defined in packages/adk/src/sessions/vertex-ai-session-service.ts:226

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>
Overrides BaseSessionService.deleteSession
- Defined in packages/adk/src/sessions/vertex-ai-session-service.ts:268

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.
Overrides BaseSessionService.appendEvent
- Defined in packages/adk/src/sessions/vertex-ai-session-service.ts:288