PURISTA

Appearance

PURISTA API

PURISTA API / @purista/ai / SessionHelpers

Type Alias: SessionHelpers ​

SessionHelpers = object

Defined in: packages/ai/src/runtime/context.ts:412

Properties ​

identity ​

identity: object

Defined in: packages/ai/src/runtime/context.ts:436

Identity metadata used to build scoped session ids.

agentName ​

agentName: string

agentVersion ​

agentVersion: string

baseSessionId ​

baseSessionId: string

principalId? ​

optional principalId: string

tenantId? ​

optional tenantId: string

Methods ​

delete() ​

delete(sessionId?): Promise<void>

Defined in: packages/ai/src/runtime/context.ts:428

Delete a session. If no id is provided, the default scoped id is used.

Parameters ​

sessionId? ​

string

Returns ​

Promise<void>

load() ​

load(sessionId?): Promise<ConversationStoreRecord | undefined>

Defined in: packages/ai/src/runtime/context.ts:416

Load the session record. If no id is provided, the default scoped id is used.

Parameters ​

sessionId? ​

string

Returns ​

Promise<ConversationStoreRecord | undefined>

resolveSessionId() ​

resolveSessionId(sessionId?): string

Defined in: packages/ai/src/runtime/context.ts:432

Returns the effective scoped session id for explicit or implicit usage.

Parameters ​

sessionId? ​

string

Returns ​

string

save() ​

save(record): Promise<void>

Defined in: packages/ai/src/runtime/context.ts:420

Save session data. If sessionId is omitted, the default scoped id is used.

Parameters ​

record ​

ConversationStoreRecord | { conversationId?: string; data: ConversationStoreRecordData; updatedAt?: number; }

Returns ​

Promise<void>