Class Session<S>

State manager for a session turn, tracking messages, custom state, and artifacts.

Type Parameters

S = unknown

Hierarchy

EventEmitter
- Session

Index

Constructors

constructor

new Session<S = unknown>(initialState: SessionState<S>): Session<S>
Type Parameters
- S = unknown
Parameters
- initialState: SessionState<S>
Returns Session<S>
Overrides EventEmitter.constructor
- Defined in ai/lib/session.d.ts:119

Properties

`Readonly`sessionId

sessionId: string

Stable identifier that correlates traces across agent turns.

Methods

addArtifacts

addArtifacts(
    artifacts: {
        metadata?: Record<string, any>;
        name?: string;
        parts: (
            | {
                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;
            }
        )[];
    }[],
): void
Adds artifacts to the session, deduplicating items by name. Emits 'artifactAdded' for new artifacts and 'artifactUpdated' for replacements.
Parameters
- artifacts: {
      metadata?: Record<string, any>;
      name?: string;
      parts: (
          | {
              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;
          }
      )[];
  }[]
Returns void
- Defined in ai/lib/session.d.ts:155

addMessages

addMessages(
    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";
    }[],
): void
Appends a list of messages to the session.
Parameters
- 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 void
- Defined in ai/lib/session.d.ts:134

emit

emit(event: string, ...args: any[]): void
Parameters
- event: string
- ...args: any[]
Returns void
Inherited from EventEmitter.emit
- Defined in core/lib/async.d.ts:84

getArtifacts

getArtifacts(): {
    metadata?: Record<string, any>;
    name?: string;
    parts: (
        | {
            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;
        }
    )[];
}[]
Retrieves the list of artifacts generated during the session.

Returns {
    metadata?: Record<string, any>;
    name?: string;
    parts: (
        | {
            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;
        }
    )[];
}[]
- Defined in ai/lib/session.d.ts:150

getCustom

getCustom(): S | undefined
Retrieves the custom state of the session.

Returns S | undefined
- Defined in ai/lib/session.d.ts:142

getMessages

getMessages(): {
    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";
}[]
Retrieves all messages associated with the session.

Returns a copy so callers cannot mutate the session's internal message array in place.

Returns {
    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";
}[]
- Defined in ai/lib/session.d.ts:130

getState

getState(): SessionState<S>
Returns a deep copy of the current session state.

Returns SessionState<S>
- Defined in ai/lib/session.d.ts:123

getVersion

getVersion(): number
Gets the current mutation version of the session state.

Returns number
- Defined in ai/lib/session.d.ts:163

off

off(event: string, listener: (...args: any[]) => void): void
Parameters
- event: string
- listener: (...args: any[]) => void
Returns void
Inherited from EventEmitter.off
- Defined in core/lib/async.d.ts:83

on

on(event: string, listener: (...args: any[]) => void): void
Parameters
- event: string
- listener: (...args: any[]) => void
Returns void
Inherited from EventEmitter.on
- Defined in core/lib/async.d.ts:82

run

run<O>(fn: () => O): O
Runs the provided function inside the session's context.
Type Parameters
- O
Parameters
- fn: () => O
Returns O
- Defined in ai/lib/session.d.ts:159

setMessages

setMessages(
    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";
    }[],
): void
Overwrites the session messages.
Parameters
- 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 void
- Defined in ai/lib/session.d.ts:138

updateCustom

updateCustom(fn: (custom?: S) => S): void
Updates the custom state of the session using a mutator function.
Parameters
- fn: (custom?: S) => S
Returns void
- Defined in ai/lib/session.d.ts:146

Class Session<S>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Session<S>

Properties

ReadonlysessionId

Methods

addArtifacts

Parameters

Returns void

addMessages

Parameters

Returns void

emit

Parameters

Returns void

getArtifacts

getCustom

Returns S | undefined

getMessages

getState

Returns SessionState<S>

getVersion

Returns number

off

Parameters

Returns void

on

Parameters

Returns void

run

Type Parameters

Parameters

Returns O

setMessages

Parameters

Returns void

updateCustom

Parameters

Returns void

Settings

On This Page

`Readonly`sessionId