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

Constructors

constructor

Properties

id registry

Accessors

state

Methods

chat run toJSON updateMessages updateState

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

    Returns Session<S>

Properties

Readonlyid

id: string

Readonlyregistry

registry: Registry

Accessors

state

  • get state(): undefined | S

  • Returns undefined | S

Methods

chat

  • chat<I>(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

    • I

    Parameters

    • Optionaloptions: ChatOptions<I, S>

    Returns Chat

  • chat<I>(
        preamble: ExecutablePrompt<I, ZodTypeAny, ZodTypeAny>,
        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

    Returns Chat

  • chat<I>(
        threadName: string,
        preamble: ExecutablePrompt<I, ZodTypeAny, ZodTypeAny>,
        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

    Returns Chat

  • chat<I>(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

    • I

    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

toJSON

updateMessages

  • updateMessages(
        thread: string,
        messages: {
            content: (
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    text: string;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media: { contentType?: string; url: string };
                    metadata?: Record<string, unknown>;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    text?: undefined;
                    toolRequest: { input?: unknown; name: string; ref?: string };
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse: { name: string; output?: unknown; ref?: string };
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom: Record<string, any>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    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>;
                  text: string;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media: { contentType?: string; url: string };
                  metadata?: Record<string, unknown>;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  text?: undefined;
                  toolRequest: { input?: unknown; name: string; ref?: string };
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse: { name: string; output?: unknown; ref?: string };
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom: Record<string, any>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
          )[];
          metadata?: Record<string, unknown>;
          role: "user" | "model" | "tool" | "system";
      }[]

    Returns Promise<void>

updateState

  • updateState(data: S): Promise<void>

  • Update session state data.

    Parameters

    • data: S

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods