Class Session<S>

Session encapsulates a statful execution environment for chat. Chat session executed within a session in this environment will have acesss to session session convesation history.

const ai = genkit({...});
const chat = ai.chat(); // create a Session
let response = await chat.send('hi'); // session/history aware conversation
response = await chat.send('tell me a story');

Type Parameters

S = any

Index

Constructors

constructor

new Session<S = any>(
 registry: Registry,
 options?: {
 id?: string;
 sessionData?: SessionData<S>;
 stateSchema?: S;
 store?: SessionStore<S>;
 },
): Session<S>
Type Parameters
- S = any
Parameters
- registry: Registry
- Optionaloptions: {
 id?: string;
 sessionData?: SessionData<S>;
 stateSchema?: S;
 store?: SessionStore<S>;
 }
Returns Session<S>
- Defined in ai/lib/session.d.ts:56

Properties

`Readonly`id

id: string

`Readonly`registry

registry: Registry

Accessors

state

get state(): S | undefined
Returns S | undefined
- Defined in ai/lib/session.d.ts:62

Methods

chat

chat(options?: ChatOptions<I, S>): Chat

Create a chat session with the provided options.

const session = ai.createSession({});
const chat = session.chat({
  system: 'talk like a pirate',
})
let response = await chat.send('tell me a joke');
response = await chat.send('another one');

Type Parameters

Parameters

Optionaloptions: ChatOptions<I, S>

Returns Chat

chat(preamble: ExecutablePrompt, options?: ChatOptions<I, S>): Chat
Create a chat session with the provided preamble.
```
const triageAgent = ai.definePrompt({
 system: 'help the user triage a problem',
})
const session = ai.createSession({});
const chat = session.chat(triageAgent);
const { text } = await chat.send('my phone feels hot');
```
Type Parameters
- I
Parameters
- preamble: ExecutablePrompt
- Optionaloptions: ChatOptions<I, S>
Returns Chat
- Defined in ai/lib/session.d.ts:97
chat(
 threadName: string,
 preamble: ExecutablePrompt,
 options?: ChatOptions<I, S>,
): Chat
Craete a separate chat conversation ("thread") within the given preamble.
```
const session = ai.createSession({});
const lawyerChat = session.chat('lawyerThread', {
 system: 'talk like a lawyer',
});
const pirateChat = session.chat('pirateThread', {
 system: 'talk like a pirate',
});
await lawyerChat.send('tell me a joke');
await pirateChat.send('tell me a joke');
```
Type Parameters
- I
Parameters
- threadName: string
- preamble: ExecutablePrompt
- Optionaloptions: ChatOptions<I, S>
Returns Chat
- Defined in ai/lib/session.d.ts:113

chat(threadName: string, options?: ChatOptions<I, S>): Chat

Craete a separate chat conversation ("thread").

const session = ai.createSession({});
const lawyerChat = session.chat('lawyerThread', {
  system: 'talk like a lawyer',
});
const pirateChat = session.chat('pirateThread', {
  system: 'talk like a pirate',
});
await lawyerChat.send('tell me a joke');
await pirateChat.send('tell me a joke');

Type Parameters

Parameters

threadName: string
Optionaloptions: ChatOptions<I, S>

Returns Chat

run

run<O>(fn: () => O): O
Executes provided function within this session context allowing calling ai.currentSession().state
Type Parameters
- O
Parameters
- fn: () => O
Returns O
- Defined in ai/lib/session.d.ts:134

toJSON

toJSON(): SessionData<S> | undefined
Returns SessionData<S> | undefined
- Defined in ai/lib/session.d.ts:135

updateMessages

updateMessages(
 thread: string,
 messages: {
 content: (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 reasoning?: undefined;
 resource?: undefined;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 reasoning?: undefined;
 resource?: undefined;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 reasoning?: undefined;
 resource?: undefined;
 text?: undefined;
 toolRequest: {
 input?: unknown;
 name: string;
 partial?: boolean;
 ref?: string;
 };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 reasoning?: undefined;
 resource?: undefined;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string } & {
 content?: (
 | {
 custom?: ...;
 data?: ...;
 media?: ...;
 metadata?: ...;
 reasoning?: ...;
 resource?: ...;
 text: ...;
 toolRequest?: ...;
 toolResponse?: ...;
 }
 | {
 custom?: ...;
 data?: ...;
 media: ...;
 metadata?: ...;
 reasoning?: ...;
 resource?: ...;
 text?: ...;
 toolRequest?: ...;
 toolResponse?: ...;
 }
 | {
 custom?: ...;
 data?: ...;
 media?: ...;
 metadata?: ...;
 reasoning?: ...;
 resource?: ...;
 text?: ...;
 toolRequest: ...;
 toolResponse?: ...;
 }
 | {
 custom?: ...;
 data?: ...;
 media?: ...;
 metadata?: ...;
 reasoning?: ...;
 resource?: ...;
 text?: ...;
 toolRequest?: ...;
 toolResponse: ...;
 }
 | {
 custom?: ...;
 data?: ...;
 media?: ...;
 metadata?: ...;
 reasoning?: ...;
 resource?: ...;
 text?: ...;
 toolRequest?: ...;
 toolResponse?: ...;
 }
 | {
 custom: ...;
 data?: ...;
 media?: ...;
 metadata?: ...;
 reasoning?: ...;
 resource?: ...;
 text?: ...;
 toolRequest?: ...;
 toolResponse?: ...;
 }
 | {
 custom?: ...;
 data?: ...;
 media?: ...;
 metadata?: ...;
 reasoning: ...;
 resource?: ...;
 text?: ...;
 toolRequest?: ...;
 toolResponse?: ...;
 }
 | {
 custom?: ...;
 data?: ...;
 media?: ...;
 metadata?: ...;
 reasoning?: ...;
 resource: ...;
 text?: ...;
 toolRequest?: ...;
 toolResponse?: ...;
 }
 )[];
 };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 reasoning?: undefined;
 resource?: undefined;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 reasoning?: undefined;
 resource?: undefined;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 reasoning: string;
 resource?: undefined;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 reasoning?: undefined;
 resource: { uri: string };
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[];
 metadata?: Record<string, unknown>;
 role: "user" | "model" | "tool" | "system";
 }[],
): Promise<void>
Update messages for a given thread.
Parameters
- thread: string
- messages: {
 content: (
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 reasoning?: undefined;
 resource?: undefined;
 text: string;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media: { contentType?: string; url: string };
 metadata?: Record<string, unknown>;
 reasoning?: undefined;
 resource?: undefined;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 reasoning?: undefined;
 resource?: undefined;
 text?: undefined;
 toolRequest: {
 input?: unknown;
 name: string;
 partial?: boolean;
 ref?: string;
 };
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 reasoning?: undefined;
 resource?: undefined;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse: { name: string; output?: unknown; ref?: string } & {
 content?: (
 | {
 custom?: ...;
 data?: ...;
 media?: ...;
 metadata?: ...;
 reasoning?: ...;
 resource?: ...;
 text: ...;
 toolRequest?: ...;
 toolResponse?: ...;
 }
 | {
 custom?: ...;
 data?: ...;
 media: ...;
 metadata?: ...;
 reasoning?: ...;
 resource?: ...;
 text?: ...;
 toolRequest?: ...;
 toolResponse?: ...;
 }
 | {
 custom?: ...;
 data?: ...;
 media?: ...;
 metadata?: ...;
 reasoning?: ...;
 resource?: ...;
 text?: ...;
 toolRequest: ...;
 toolResponse?: ...;
 }
 | {
 custom?: ...;
 data?: ...;
 media?: ...;
 metadata?: ...;
 reasoning?: ...;
 resource?: ...;
 text?: ...;
 toolRequest?: ...;
 toolResponse: ...;
 }
 | {
 custom?: ...;
 data?: ...;
 media?: ...;
 metadata?: ...;
 reasoning?: ...;
 resource?: ...;
 text?: ...;
 toolRequest?: ...;
 toolResponse?: ...;
 }
 | {
 custom: ...;
 data?: ...;
 media?: ...;
 metadata?: ...;
 reasoning?: ...;
 resource?: ...;
 text?: ...;
 toolRequest?: ...;
 toolResponse?: ...;
 }
 | {
 custom?: ...;
 data?: ...;
 media?: ...;
 metadata?: ...;
 reasoning: ...;
 resource?: ...;
 text?: ...;
 toolRequest?: ...;
 toolResponse?: ...;
 }
 | {
 custom?: ...;
 data?: ...;
 media?: ...;
 metadata?: ...;
 reasoning?: ...;
 resource: ...;
 text?: ...;
 toolRequest?: ...;
 toolResponse?: ...;
 }
 )[];
 };
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 reasoning?: undefined;
 resource?: undefined;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom: Record<string, any>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 reasoning?: undefined;
 resource?: undefined;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 reasoning: string;
 resource?: undefined;
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 | {
 custom?: Record<string, unknown>;
 data?: unknown;
 media?: undefined;
 metadata?: Record<string, unknown>;
 reasoning?: undefined;
 resource: { uri: string };
 text?: undefined;
 toolRequest?: undefined;
 toolResponse?: undefined;
 }
 )[];
 metadata?: Record<string, unknown>;
 role: "user" | "model" | "tool" | "system";
 }[]
Returns Promise<void>
- Defined in ai/lib/session.d.ts:71

updateState

updateState(data: Partial<S>): Promise<void>
Update session state data by patching the existing state.
Parameters
- data: Partial<S>
 Partial state update that will be merged with existing state
Returns Promise<void>
- Defined in ai/lib/session.d.ts:67

Class Session<S>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Session<S>

Properties

Readonlyid

Readonlyregistry

Accessors

state

Returns S | undefined

Methods

chat

Type Parameters

Parameters

Returns Chat

Type Parameters

Parameters

Returns Chat

Type Parameters

Parameters

Returns Chat

Type Parameters

Parameters

Returns Chat

run

Type Parameters

Parameters

Returns O

toJSON

Returns SessionData<S> | undefined

updateMessages

Parameters

Returns Promise<void>

updateState

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`id

`Readonly`registry