TakeSnapshotOptions

type TakeSnapshotOptions = {
  preset?: SnapshotPreset;
  include?: SnapshotField[];
  exclude?: SnapshotField[];
  appData?: Record<string, JSONValue>;
};

Defined in: src/agent/snapshot.ts:54

Options for taking a snapshot of agent state.

Properties

preset?

optional preset?: SnapshotPreset;

Defined in: src/agent/snapshot.ts:59

Preset to use as the starting set of fields. If not specified, starts with an empty set (unless include is specified).

---

include?

optional include?: SnapshotField[];

Defined in: src/agent/snapshot.ts:64

Fields to add to the snapshot. These are added to the preset fields (if any).

---

exclude?

optional exclude?: SnapshotField[];

Defined in: src/agent/snapshot.ts:69

Fields to exclude from the snapshot. Applied after preset and include to filter out specific fields.

---

appData?

optional appData?: Record<string, JSONValue>;

Defined in: src/agent/snapshot.ts:74

Application-owned data to store in the snapshot. Strands does not read or modify this data.