Interface VertexAiCreateSessionRequest

The parameters for VertexAiSessionService.createSession.

Extends the common CreateSessionRequest with the mutually exclusive session-expiration options supported by Vertex AI Agent Engine Sessions. See https://cloud.google.com/vertex-ai/generative-ai/docs/reference/rest/v1beta1/projects.locations.reasoningEngines.sessions

interface VertexAiCreateSessionRequest {
    appName: string;
    expireTime?: string;
    sessionId?: string;
    state?: Record<string, unknown>;
    ttl?: string;
    userId: string;
}

Hierarchy (View Summary)

CreateSessionRequest
- VertexAiCreateSessionRequest

Properties

appName

appName: string

The name of the application.

`Optional`expireTime

expireTime?: string

Absolute RFC 3339 UTC expiration, e.g. '2025-10-01T00:00:00Z'.

`Optional`sessionId

sessionId?: string

The ID of the session. A new ID will be generated if not provided.

`Optional`state

state?: Record<string, unknown>

The initial state of the session.

`Optional`ttl

ttl?: string

Lifetime relative to creation, in seconds, e.g. '7200s'.

userId

userId: string

The ID of the user.