@aigne/agent-library 1.20.5 → 1.21.2

package/lib/dts/fs-memory/index.d.ts

@@ -1,59 +0,0 @@
-import { type AIAgentOptions, type Message } from "@aigne/core";
-import { MemoryAgent, type MemoryAgentOptions, type MemoryRecorderInput, type MemoryRetrieverInput } from "@aigne/core/memory/index.js";
-export declare const MEMORY_FILE_NAME = "memory.yaml";
-/**
- * Configuration options for the FSMemory class.
- */
-export interface FSMemoryOptions extends Partial<MemoryAgentOptions> {
-    /**
-     * The root directory where memory files will be stored.
-     * Can be absolute or relative path. Relative paths are resolved from the current working directory.
-     * Home directory prefix (~) will be expanded appropriately.
-     */
-    rootDir: string;
-    /**
-     * Optional configuration for the memory retriever agent.
-     * Controls how memories are retrieved from the file system.
-     */
-    retrieverOptions?: Partial<FSMemoryRetrieverOptions>;
-    /**
-     * Optional configuration for the memory recorder agent.
-     * Controls how memories are recorded to the file system.
-     */
-    recorderOptions?: Partial<FSMemoryRecorderOptions>;
-}
-/**
- * A memory implementation that stores and retrieves memories using the file system.
- * FSMemory provides persistent storage of agent memories as files in a specified directory.
- *
- * @example
- * Here is an example of how to use the FSMemory class:
- * {@includeCode ../../test/fs-memory/fs-memory.test.ts#example-fs-memory-simple}
- */
-export declare class FSMemory extends MemoryAgent {
-    /**
-     * Creates a new FSMemory instance.
-     */
-    constructor(options: FSMemoryOptions);
-}
-interface FSMemoryRetrieverOptions extends AIAgentOptions<FSMemoryRetrieverAgentInput, FSMemoryRetrieverAgentOutput> {
-    memoryFileName: string;
-}
-interface FSMemoryRetrieverAgentInput extends MemoryRetrieverInput {
-    allMemory: string;
-}
-interface FSMemoryRetrieverAgentOutput extends Message {
-    memories: {
-        content: string;
-    }[];
-}
-interface FSMemoryRecorderOptions extends AIAgentOptions<FSMemoryRecorderAgentInput, FSMemoryRecorderAgentOutput> {
-    memoryFileName: string;
-}
-type FSMemoryRecorderAgentInput = MemoryRecorderInput;
-interface FSMemoryRecorderAgentOutput extends Message {
-    memories: {
-        content: string;
-    }[];
-}
-export {};

package/lib/esm/agentic-memory/index.d.ts

@@ -1,38 +0,0 @@
-import { type AgentInvokeOptions, type AgentOptions, AIAgent, MemoryAgent, type MemoryAgentOptions, MemoryRecorder, type MemoryRecorderInput, type MemoryRecorderOutput, type Message, type PromptBuilder } from "@aigne/core";
-import { type DefaultMemoryStorageOptions } from "../default-memory/default-memory-storage/index.js";
-import { DefaultMemoryRetriever, type DefaultMemoryRetrieverOptions } from "../default-memory/index.js";
-import { MemoryStorage } from "../default-memory/storage.js";
-export interface AgenticMemoryOptions extends Partial<MemoryAgentOptions>, Omit<AgenticMemoryRecorderOptions, "storage" | keyof AgentOptions>, Omit<AgenticMemoryRetrieverOptions, "storage" | keyof AgentOptions> {
-    storage?: MemoryStorage | DefaultMemoryStorageOptions;
-}
-export declare class AgenticMemory extends MemoryAgent {
-    constructor(options?: AgenticMemoryOptions);
-    storage: MemoryStorage;
-}
-export interface AgenticMemoryRetrieverOptions extends DefaultMemoryRetrieverOptions {
-}
-export declare class AgenticMemoryRetriever extends DefaultMemoryRetriever {
-}
-export interface AgenticMemoryRecorderOptions extends AgentOptions<MemoryRecorderInput, MemoryRecorderOutput> {
-    storage: MemoryStorage;
-    instructions?: string | PromptBuilder;
-    agent?: AIAgent<AgenticMemoryExtractorInput, AgenticMemoryExtractorOutput>;
-    inputKey?: string | string[];
-    outputKey?: string | string[];
-}
-export interface AgenticMemoryExtractorInput extends Message {
-    content: unknown;
-}
-export interface AgenticMemoryExtractorOutput extends Message {
-    newMemories: {
-        content: string;
-    }[];
-}
-export declare class AgenticMemoryRecorder extends MemoryRecorder {
-    constructor(options: AgenticMemoryRecorderOptions);
-    private storage;
-    private inputKey?;
-    private outputKey?;
-    private agent;
-    process(input: MemoryRecorderInput, options: AgentInvokeOptions): Promise<MemoryRecorderOutput>;
-}

package/lib/esm/agentic-memory/index.js

@@ -1,67 +0,0 @@
-import { AIAgent, MemoryAgent, MemoryRecorder, } from "@aigne/core";
-import { flat, pick } from "@aigne/core/utils/type-utils.js";
-import { z } from "zod";
-import { DefaultMemoryStorage, } from "../default-memory/default-memory-storage/index.js";
-import { DefaultMemoryRetriever, } from "../default-memory/index.js";
-import { MemoryStorage } from "../default-memory/storage.js";
-import { DEFAULT_FS_MEMORY_RECORDER_INSTRUCTIONS } from "./prompt.js";
-export class AgenticMemory extends MemoryAgent {
-    constructor(options = {}) {
-        const storage = options.storage instanceof MemoryStorage
-            ? options.storage
-            : new DefaultMemoryStorage(options.storage);
-        super({
-            ...options,
-            recorder: options.recorder ?? new AgenticMemoryRecorder({ ...options, storage }),
-            retriever: options.retriever ?? new AgenticMemoryRetriever({ ...options, storage }),
-            autoUpdate: options.autoUpdate ?? true,
-        });
-        this.storage = storage;
-    }
-    storage;
-}
-export class AgenticMemoryRetriever extends DefaultMemoryRetriever {
-}
-export class AgenticMemoryRecorder extends MemoryRecorder {
-    constructor(options) {
-        super(options);
-        this.storage = options.storage;
-        this.inputKey = flat(options.inputKey);
-        this.outputKey = flat(options.outputKey);
-        this.agent =
-            options.agent ??
-                AIAgent.from({
-                    name: "agentic_memory_extractor",
-                    description: "Records memories in files by AI agent",
-                    instructions: options.instructions || DEFAULT_FS_MEMORY_RECORDER_INSTRUCTIONS,
-                    outputSchema: z.object({
-                        newMemories: z
-                            .array(z.object({
-                            content: z.string().describe("Content of the memory"),
-                        }))
-                            .describe("Newly created memories"),
-                    }),
-                });
-    }
-    storage;
-    inputKey;
-    outputKey;
-    agent;
-    async process(input, options) {
-        const agenticMemories = await options.context.invoke(this.agent, {
-            content: input.content.map((item) => ({
-                input: item.input && this.inputKey?.length ? pick(item.input, this.inputKey) : item.input,
-                output: item.output && this.outputKey?.length ? pick(item.output, this.outputKey) : item.output,
-                source: item.source,
-            })),
-        });
-        const newMemories = [];
-        for (const item of agenticMemories.newMemories) {
-            const { result } = await this.storage.create({ content: item.content }, options);
-            newMemories.push(result);
-        }
-        return {
-            memories: newMemories,
-        };
-    }
-}

package/lib/esm/agentic-memory/prompt.d.ts

@@ -1 +0,0 @@
-export declare const DEFAULT_FS_MEMORY_RECORDER_INSTRUCTIONS = "You manage memory based on conversation analysis and the existing memories.\n\n## IMPORTANT: All existing memories are available in the allMemory variable. DO NOT call any tools.\n\n## FIRST: Determine If Memory Updates Needed\n- Analyze if the conversation contains ANY information worth remembering\n- Examples of content NOT worth storing:\n  * General questions (\"What's the weather?\", \"How do I do X?\")\n  * Greetings and small talk (\"Hello\", \"How are you?\", \"Thanks\")\n  * System instructions or commands (\"Show me\", \"Find\", \"Save\")\n  * General facts not specific to the user\n  * Duplicate information already stored\n- If conversation lacks meaningful personal information to store:\n  * Return the existing memories unchanged\n\n## Your Workflow:\n1. Read the existing memories from the allMemory variable\n2. Extract key topics from the conversation\n3. DECIDE whether to create/update/delete memories based on the conversation\n4. Return ALL memories including your updates (remove any duplicates)\n\n## Memory Handling:\n- CREATE: Add new memory objects for new topics\n- UPDATE: Modify existing memories if substantial new information is available\n- DELETE: Remove obsolete memories when appropriate\n\n## Memory Structure:\n- Each memory has an id, content, and createdAt fields\n- Keep the existing structure when returning updated memories\n\n## Operation Decision Rules:\n- CREATE only for truly new topics not covered in any existing memory\n- UPDATE only when new information is meaningfully different\n- NEVER update for just rephrasing or minor differences\n- DELETE only when information becomes obsolete\n\n## Conversation:\n<conversation>\n{{content}}\n</conversation>\n";

package/lib/esm/agentic-memory/prompt.js

@@ -1,41 +0,0 @@
-export const DEFAULT_FS_MEMORY_RECORDER_INSTRUCTIONS = `You manage memory based on conversation analysis and the existing memories.
-
-## IMPORTANT: All existing memories are available in the allMemory variable. DO NOT call any tools.
-
-## FIRST: Determine If Memory Updates Needed
-- Analyze if the conversation contains ANY information worth remembering
-- Examples of content NOT worth storing:
-  * General questions ("What's the weather?", "How do I do X?")
-  * Greetings and small talk ("Hello", "How are you?", "Thanks")
-  * System instructions or commands ("Show me", "Find", "Save")
-  * General facts not specific to the user
-  * Duplicate information already stored
-- If conversation lacks meaningful personal information to store:
-  * Return the existing memories unchanged
-
-## Your Workflow:
-1. Read the existing memories from the allMemory variable
-2. Extract key topics from the conversation
-3. DECIDE whether to create/update/delete memories based on the conversation
-4. Return ALL memories including your updates (remove any duplicates)
-
-## Memory Handling:
-- CREATE: Add new memory objects for new topics
-- UPDATE: Modify existing memories if substantial new information is available
-- DELETE: Remove obsolete memories when appropriate
-
-## Memory Structure:
-- Each memory has an id, content, and createdAt fields
-- Keep the existing structure when returning updated memories
-
-## Operation Decision Rules:
-- CREATE only for truly new topics not covered in any existing memory
-- UPDATE only when new information is meaningfully different
-- NEVER update for just rephrasing or minor differences
-- DELETE only when information becomes obsolete
-
-## Conversation:
-<conversation>
-{{content}}
-</conversation>
-`;

package/lib/esm/default-memory/default-memory-storage/index.d.ts

@@ -1,29 +0,0 @@
-import type { AgentInvokeOptions, Context, Memory } from "@aigne/core";
-import type { PromiseOrValue } from "@aigne/core/utils/type-utils.js";
-import type { SqliteRemoteDatabase } from "drizzle-orm/sqlite-proxy";
-import { MemoryStorage } from "../storage.js";
-import { Memories } from "./models/memory.js";
-export interface DefaultMemoryStorageOptions {
-    url?: string;
-    getSessionId?: (context: Context) => PromiseOrValue<string>;
-    enableFTS?: boolean;
-}
-export declare class DefaultMemoryStorage extends MemoryStorage {
-    options?: DefaultMemoryStorageOptions | undefined;
-    constructor(options?: DefaultMemoryStorageOptions | undefined);
-    private _db;
-    private initSqlite;
-    get db(): Promise<SqliteRemoteDatabase<Record<string, never>>>;
-    private convertMemory;
-    search(query: {
-        search?: string;
-        limit?: number;
-        orderBy?: [keyof typeof Memories.$inferSelect, "asc" | "desc"];
-    }, { context }: AgentInvokeOptions): Promise<{
-        result: Memory[];
-    }>;
-    create(memory: Pick<Memory, "content">, { context }: AgentInvokeOptions): Promise<{
-        result: Memory;
-    }>;
-    protected segment(str: string): string[];
-}

package/lib/esm/default-memory/default-memory-storage/index.js

@@ -1,91 +0,0 @@
-import { initDatabase } from "@aigne/sqlite";
-import { asc, desc, eq, isNull, sql } from "drizzle-orm";
-import { v7 } from "uuid";
-import { stringify } from "yaml";
-import { MemoryStorage } from "../storage.js";
-import { migrate } from "./migrate.js";
-import { Memories } from "./models/memory.js";
-const DEFAULT_MAX_MEMORY_COUNT = 10;
-export class DefaultMemoryStorage extends MemoryStorage {
-    options;
-    constructor(options) {
-        super();
-        this.options = options;
-    }
-    _db;
-    async initSqlite() {
-        const db = (await initDatabase({ url: this.options?.url }));
-        await migrate(db);
-        return db;
-    }
-    get db() {
-        this._db ??= this.initSqlite();
-        return this._db;
-    }
-    convertMemory(m) {
-        return {
-            id: m.id,
-            sessionId: m.sessionId,
-            content: m.content,
-            createdAt: m.createdAt.toISOString(),
-        };
-    }
-    async search(query, { context }) {
-        const { limit = DEFAULT_MAX_MEMORY_COUNT } = query;
-        const sessionId = (await this.options?.getSessionId?.(context)) ?? null;
-        const db = await this.db;
-        const memories = this.options?.enableFTS && query.search
-            ? await db
-                .select()
-                .from(Memories)
-                .innerJoin(sql `Memories_fts`, sql `Memories_fts.id = ${Memories.id}`)
-                .where(sql `Memories_fts MATCH ${sql.param(this.segment(query.search).join(" OR "))}`)
-                .orderBy(sql `bm25(Memories_fts)`)
-                .limit(limit)
-                .execute()
-                .then((rows) => rows.map((row) => row.Memories))
-            : await db
-                .select()
-                .from(Memories)
-                .where(sessionId ? eq(Memories.sessionId, sessionId) : isNull(Memories.sessionId))
-                .orderBy(query.orderBy
-                ? (query.orderBy[1] === "asc" ? asc : desc)(sql.identifier(query.orderBy[0]))
-                : desc(Memories.id))
-                .limit(limit)
-                .execute();
-        return {
-            result: memories.map(this.convertMemory),
-        };
-    }
-    async create(memory, { context }) {
-        const sessionId = (await this.options?.getSessionId?.(context)) ?? null;
-        const db = await this.db;
-        const id = v7();
-        const [[result]] = await Promise.all([
-            db
-                .insert(Memories)
-                .values({
-                ...memory,
-                id,
-                content: memory.content,
-                sessionId,
-            })
-                .returning()
-                .execute(),
-            this.options?.enableFTS &&
-                db.run(sql `\
-          insert into Memories_fts (id, content)
-          values (${sql.param(id)}, ${sql.param(this.segment(stringify(memory.content)).join(" "))})`),
-        ]);
-        if (!result)
-            throw new Error("Failed to create memory");
-        return { result: this.convertMemory(result) };
-    }
-    segment(str) {
-        return (Array.from(new Intl.Segmenter(undefined, { granularity: "word" }).segment(str))
-            .map((i) => i.segment)
-            // Remove non-alphanumeric characters and trim whitespace
-            .map((i) => i.replace(/[^\p{L}\p{N}\s]/gu, "").trim())
-            .filter(Boolean));
-    }
-}

package/lib/esm/default-memory/default-memory-storage/migrate.d.ts

@@ -1,3 +0,0 @@
-import type { LibSQLDatabase } from "drizzle-orm/libsql";
-import type { SqliteRemoteDatabase } from "drizzle-orm/sqlite-proxy";
-export declare function migrate(db: LibSQLDatabase | SqliteRemoteDatabase): Promise<void>;

package/lib/esm/default-memory/default-memory-storage/migrate.js

@@ -1,26 +0,0 @@
-import { sql } from "drizzle-orm/sql";
-import init from "./migrations/001-init.js";
-export async function migrate(db) {
-    const migrations = [init];
-    const migrationsTable = "__drizzle_migrations";
-    const migrationTableCreate = sql `
-    CREATE TABLE IF NOT EXISTS ${sql.identifier(migrationsTable)} (
-      id SERIAL PRIMARY KEY,
-      hash text NOT NULL
-    )
-  `;
-    await db.run(migrationTableCreate).execute();
-    const dbMigrations = await db
-        .values(sql `SELECT id, hash FROM ${sql.identifier(migrationsTable)} ORDER BY id DESC LIMIT 1`)
-        .execute();
-    const lastDbMigration = dbMigrations[0];
-    const queriesToRun = [];
-    for (const migration of migrations) {
-        if (!lastDbMigration || lastDbMigration[1] < migration.hash) {
-            queriesToRun.push(...migration.sql, `INSERT INTO \`${migrationsTable}\` ("hash") VALUES('${migration.hash}')`);
-        }
-    }
-    for (const query of queriesToRun) {
-        await db.run(query).execute();
-    }
-}

package/lib/esm/default-memory/default-memory-storage/migrations/001-init.d.ts

@@ -1,5 +0,0 @@
-declare const _default: {
-    hash: string;
-    sql: string[];
-};
-export default _default;

package/lib/esm/default-memory/default-memory-storage/migrations/001-init.js

@@ -1,20 +0,0 @@
-export default {
-    hash: "001-init",
-    sql: [
-        `\
-CREATE TABLE "Memories" (
-  "id" TEXT NOT NULL PRIMARY KEY,
-  "createdAt" DATETIME NOT NULL,
-  "updatedAt" DATETIME NOT NULL,
-  "sessionId" TEXT,
-  "content" JSON NOT NULL
-)
-`,
-        `\
-CREATE VIRTUAL TABLE "Memories_fts" USING fts5(
-  id UNINDEXED,
-  content
-)
-`,
-    ],
-};

package/lib/esm/default-memory/default-memory-storage/models/memory.d.ts

@@ -1,102 +0,0 @@
-export declare const Memories: import("drizzle-orm/sqlite-core").SQLiteTableWithColumns<{
-    name: "Memories";
-    schema: undefined;
-    columns: {
-        id: import("drizzle-orm/sqlite-core").SQLiteColumn<{
-            name: "id";
-            tableName: "Memories";
-            dataType: "string";
-            columnType: "SQLiteText";
-            data: string;
-            driverParam: string;
-            notNull: true;
-            hasDefault: true;
-            isPrimaryKey: true;
-            isAutoincrement: false;
-            hasRuntimeDefault: true;
-            enumValues: [string, ...string[]];
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {
-            length: number | undefined;
-        }>;
-        createdAt: import("drizzle-orm/sqlite-core").SQLiteColumn<{
-            name: "createdAt";
-            tableName: "Memories";
-            dataType: "custom";
-            columnType: "SQLiteCustomColumn";
-            data: Date;
-            driverParam: string;
-            notNull: true;
-            hasDefault: true;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: true;
-            enumValues: undefined;
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {
-            sqliteColumnBuilderBrand: "SQLiteCustomColumnBuilderBrand";
-        }>;
-        updatedAt: import("drizzle-orm/sqlite-core").SQLiteColumn<{
-            name: "updatedAt";
-            tableName: "Memories";
-            dataType: "custom";
-            columnType: "SQLiteCustomColumn";
-            data: Date;
-            driverParam: string;
-            notNull: true;
-            hasDefault: true;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: true;
-            enumValues: undefined;
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {
-            sqliteColumnBuilderBrand: "SQLiteCustomColumnBuilderBrand";
-        }>;
-        sessionId: import("drizzle-orm/sqlite-core").SQLiteColumn<{
-            name: "sessionId";
-            tableName: "Memories";
-            dataType: "string";
-            columnType: "SQLiteText";
-            data: string;
-            driverParam: string;
-            notNull: false;
-            hasDefault: false;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: false;
-            enumValues: [string, ...string[]];
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {
-            length: number | undefined;
-        }>;
-        content: import("drizzle-orm/sqlite-core").SQLiteColumn<{
-            name: "content";
-            tableName: "Memories";
-            dataType: "custom";
-            columnType: "SQLiteCustomColumn";
-            data: unknown;
-            driverParam: string;
-            notNull: true;
-            hasDefault: false;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: false;
-            enumValues: undefined;
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {
-            sqliteColumnBuilderBrand: "SQLiteCustomColumnBuilderBrand";
-        }>;
-    };
-    dialect: "sqlite";
-}>;

package/lib/esm/default-memory/default-memory-storage/models/memory.js

@@ -1,18 +0,0 @@
-import { datetime, json } from "@aigne/sqlite/type.js";
-import { sqliteTable, text } from "drizzle-orm/sqlite-core";
-import { v7 } from "uuid";
-export const Memories = sqliteTable("Memories", {
-    id: text("id")
-        .notNull()
-        .primaryKey()
-        .$defaultFn(() => v7()),
-    createdAt: datetime("createdAt")
-        .notNull()
-        .$defaultFn(() => new Date()),
-    updatedAt: datetime("updatedAt")
-        .notNull()
-        .$defaultFn(() => new Date())
-        .$onUpdateFn(() => new Date()),
-    sessionId: text("sessionId"),
-    content: json("content").notNull(),
-});

package/lib/esm/default-memory/index.d.ts

@@ -1,44 +0,0 @@
-import { type AgentInvokeOptions, type AgentOptions, MemoryAgent, type MemoryAgentOptions, MemoryRecorder, type MemoryRecorderInput, type MemoryRecorderOutput, MemoryRetriever, type MemoryRetrieverInput, type MemoryRetrieverOutput } from "@aigne/core";
-import { type DefaultMemoryStorageOptions } from "./default-memory-storage/index.js";
-import { MemoryStorage } from "./storage.js";
-export interface DefaultMemoryOptions extends Partial<MemoryAgentOptions>, Omit<DefaultMemoryRecorderOptions, "storage" | keyof AgentOptions>, Omit<DefaultMemoryRetrieverOptions, "storage" | keyof AgentOptions> {
-    storage?: MemoryStorage | DefaultMemoryStorageOptions;
-}
-export declare class DefaultMemory extends MemoryAgent {
-    constructor(options?: DefaultMemoryOptions);
-    storage: MemoryStorage;
-}
-export interface DefaultMemoryRetrieverOptions extends AgentOptions<MemoryRetrieverInput, MemoryRetrieverOutput> {
-    storage: MemoryStorage;
-    retrieveMemoryCount?: number;
-    retrieveRecentMemoryCount?: number;
-    inputKey?: string | string[];
-    outputKey?: string | string[];
-    getSearchPattern?: DefaultMemoryRetriever["getSearchPattern"];
-    formatMessage?: DefaultMemoryRetriever["formatMessage"];
-    formatMemory?: DefaultMemoryRetriever["formatMemory"];
-}
-export declare class DefaultMemoryRetriever extends MemoryRetriever {
-    constructor(options: DefaultMemoryRetrieverOptions);
-    private storage;
-    private retrieveMemoryCount?;
-    private retrieveRecentMemoryCount?;
-    private inputKey?;
-    private outputKey?;
-    private getSearchPattern;
-    private formatMessage;
-    private formatMemory;
-    process(input: MemoryRetrieverInput, options: AgentInvokeOptions): Promise<MemoryRetrieverOutput>;
-}
-export interface DefaultMemoryRecorderOptions extends AgentOptions<MemoryRecorderInput, MemoryRecorderOutput> {
-    storage: MemoryStorage;
-    inputKey?: string | string[];
-    outputKey?: string | string[];
-}
-export declare class DefaultMemoryRecorder extends MemoryRecorder {
-    constructor(options: DefaultMemoryRecorderOptions);
-    private storage;
-    private inputKey?;
-    private outputKey?;
-    process(input: MemoryRecorderInput, options: AgentInvokeOptions): Promise<MemoryRecorderOutput>;
-}