@aigne/core 0.4.204 → 0.4.205-0

package/lib/cjs/index.js

@@ -27,4 +27,4 @@ __exportStar(require("./function-agent"), exports);
 __exportStar(require("./function-runner"), exports);
 __exportStar(require("./llm-decision-agent"), exports);
 __exportStar(require("./local-function-agent"), exports);
-__exportStar(require("./memory"), exports);
+__exportStar(require("./memorable"), exports);

package/lib/cjs/llm-agent.js

@@ -11,83 +11,73 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 var LLMAgent_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LLMAgent = void 0;
 exports.createLLMAgentDefinition = createLLMAgentDefinition;
-const lodash_1 = require("lodash");
+const remove_1 = __importDefault(require("lodash/remove"));
 const nanoid_1 = require("nanoid");
 const tsyringe_1 = require("tsyringe");
 const constants_1 = require("./constants");
 const data_type_schema_1 = require("./data-type-schema");
 const llm_model_1 = require("./llm-model");
+const logger_1 = __importDefault(require("./logger"));
 const runnable_1 = require("./runnable");
 const utils_1 = require("./utils");
+const message_utils_1 = require("./utils/message-utils");
 const mustache_utils_1 = require("./utils/mustache-utils");
 const ordered_map_1 = require("./utils/ordered-map");
+const structured_output_schema_1 = require("./utils/structured-output-schema");
 let LLMAgent = LLMAgent_1 = class LLMAgent extends runnable_1.Runnable {
     definition;
     model;
+    context;
     static create(options) {
         const definition = createLLMAgentDefinition(options);
         return new LLMAgent_1(definition);
     }
-    constructor(definition, model) {
+    constructor(definition, model, context) {
         super(definition);
         this.definition = definition;
         this.model = model;
+        this.context = context;
     }
     async run(input, options) {
         const { definition, model } = this;
         if (!model)
             throw new Error('LLM model is required');
-        const messages = ordered_map_1.OrderedRecord.toArray(definition.messages);
-        if (!messages.length)
-            throw new Error('Messages are required');
-        // TODO: support comment/image for messages
+        const { originalMessages, messagesWithMemory } = await this.prepareMessages(input);
         const llmInputs = {
-            messages: messages.map(({ role, content }) => ({
-                role,
-                content: (0, mustache_utils_1.renderMessage)(content, input),
-            })),
+            messages: messagesWithMemory,
             modelOptions: definition.modelOptions,
         };
-        const outputs = ordered_map_1.OrderedRecord.toArray(definition.outputs).filter((0, utils_1.isPropsNonNullable)('name'));
-        const textOutput = outputs.find((i) => i.name === constants_1.StreamTextOutputName);
-        const jsonOutputs = outputs.filter((i) => i.name !== constants_1.StreamTextOutputName);
-        const outputJsonSchema = jsonOutputs.length ? outputsToJsonSchema(ordered_map_1.OrderedRecord.fromArray(jsonOutputs)) : undefined;
-        const jsonOutput = outputJsonSchema
-            ? model
-                .run({
-                ...llmInputs,
-                responseFormat: outputJsonSchema && {
-                    type: 'json_schema',
-                    jsonSchema: {
-                        name: 'output',
-                        schema: outputJsonSchema,
-                        strict: true,
-                    },
-                },
-            })
-                .then(async (response) => {
-                if (!response.$text)
-                    throw new Error('No text in JSON mode response');
-                const json = JSON.parse(response.$text);
-                // TODO: validate json with outputJsonSchema
-                return json;
-            })
+        const jsonOutput = this.runWithStructuredOutput(llmInputs);
+        const textOutput = ordered_map_1.OrderedRecord.find(definition.outputs, (i) => i.name === constants_1.StreamTextOutputName)
+            ? await this.runWithTextOutput(llmInputs)
             : undefined;
+        const updateMemories = (text, json) => {
+            return this.updateMemories([
+                ...originalMessages,
+                { role: 'assistant', content: (0, mustache_utils_1.renderMessage)('{{text}}\n{{json}}', { text, json }).trim() },
+            ]);
+        };
         if (options?.stream) {
+            let $text = '';
             return new ReadableStream({
                 start: async (controller) => {
                     try {
                         if (textOutput) {
-                            const textStreamOutput = await model.run(llmInputs, { stream: true });
-                            for await (const chunk of textStreamOutput) {
+                            for await (const chunk of textOutput) {
+                                $text += chunk.$text || '';
                                 controller.enqueue({ $text: chunk.$text });
                             }
                         }
-                        controller.enqueue({ delta: await jsonOutput });
+                        const json = await jsonOutput;
+                        controller.enqueue({ delta: json });
+                        await updateMemories($text || undefined, json);
                     }
                     catch (error) {
                         controller.error(error);
@@ -98,62 +88,185 @@ let LLMAgent = LLMAgent_1 = class LLMAgent extends runnable_1.Runnable {
                 },
             });
         }
-        const text = textOutput ? await model.run(llmInputs) : undefined;
+        const [$text, json] = await Promise.all([
+            textOutput ? (0, utils_1.runnableResponseStreamToObject)(textOutput).then((res) => res.$text || undefined) : undefined,
+            jsonOutput,
+        ]);
+        await updateMemories($text, json);
+        return { $text, ...json };
+    }
+    async prepareMessages(input) {
+        const { definition } = this;
+        const originalMessages = ordered_map_1.OrderedRecord.toArray(definition.messages).map(({ role, content }) => ({
+            role,
+            // TODO: support use memory variables in message content
+            content: typeof content === 'string' ? (0, mustache_utils_1.renderMessage)(content, input) : content,
+        }));
+        if (!originalMessages.length)
+            throw new Error('Messages are required');
+        const { primaryMemory, memory } = await this.getMemories(input);
+        let messagesWithMemory = [...originalMessages];
+        // Add memory to a system message
+        if (memory) {
+            const message = {
+                role: 'system',
+                content: `\
+        Here are the memories about the user:
+        ${memory}
+        `,
+            };
+            const lastSystemMessageIndex = messagesWithMemory.findLastIndex((i) => i.role === 'assistant');
+            messagesWithMemory.splice(lastSystemMessageIndex + 1, 0, message);
+        }
+        // Add primary memory to messages
+        if (primaryMemory.length)
+            messagesWithMemory = (0, message_utils_1.mergeHistoryMessages)(messagesWithMemory, primaryMemory);
+        // TODO: support comment/image for messages
+        return { originalMessages, messagesWithMemory };
+    }
+    async runWithStructuredOutput(llmInputs) {
+        const jsonOutputs = ordered_map_1.OrderedRecord.filter(this.definition.outputs, (i) => i.name !== constants_1.StreamTextOutputName // ignore `$text` output
+        );
+        if (!jsonOutputs.length)
+            return null;
+        const schema = (0, structured_output_schema_1.outputsToJsonSchema)(ordered_map_1.OrderedRecord.fromArray(jsonOutputs));
+        const { model } = this;
+        if (!model)
+            throw new Error('LLM model is required');
+        const response = await model.run({
+            ...llmInputs,
+            responseFormat: {
+                type: 'json_schema',
+                jsonSchema: {
+                    name: 'output',
+                    schema: schema,
+                    strict: true,
+                },
+            },
+        });
+        if (!response.$text)
+            throw new Error('No text in JSON mode response');
+        const json = JSON.parse(response.$text);
+        // TODO: validate json with outputJsonSchema
+        return json;
+    }
+    async runWithTextOutput(llmInputs) {
+        const { model } = this;
+        if (!model)
+            throw new Error('LLM model is required');
+        return model.run(llmInputs, { stream: true });
+    }
+    async getMemoryQuery(input, query) {
+        if (query?.from === 'variable') {
+            const i = ordered_map_1.OrderedRecord.find(this.definition.inputs, (i) => i.id === query.fromVariableId);
+            if (!i)
+                throw new Error(`Input variable ${query.fromVariableId} not found`);
+            const value = input[i.name];
+            return (0, mustache_utils_1.renderMessage)('{{value}}', { value });
+        }
+        return Object.entries(input)
+            .map(([key, value]) => `${key} ${value}`)
+            .join('\n');
+    }
+    async getMemories(input) {
+        const { memories } = this.definition;
+        const { userId, sessionId } = this.context?.state ?? {};
+        const list = (await Promise.all(ordered_map_1.OrderedRecord.map(memories, async ({ id, memory, query, options }) => {
+            if (!memory) {
+                logger_1.default.warn(`Memory is not defined in agent ${this.name || this.id}`);
+                return null;
+            }
+            const q = await this.getMemoryQuery(input, query);
+            const { results: memories } = await memory.search(q, { ...options, userId, sessionId });
+            return { id, memories };
+        }))).filter(utils_1.isNonNullable);
+        const primary = (0, remove_1.default)(list, (i) => i.id === this.definition.primaryMemoryId)[0]?.memories || [];
+        const primaryMemory = primary
+            .map((i) => {
+            const content = (0, mustache_utils_1.renderMessage)('{{memory}}', { memory: i.memory }).trim();
+            const role = ['user', 'assistant'].includes(i.metadata.role) ? i.metadata.role : undefined;
+            if (!role || !content)
+                return null;
+            return { role, content };
+        })
+            .filter(utils_1.isNonNullable);
+        const memory = list
+            .map((i) => i.memories
+            .map((j) => (0, mustache_utils_1.renderMessage)('{{memory}}\n{{metadata}}', j).trim() || null)
+            .filter(utils_1.isNonNullable)
+            .join('\n'))
+            .join('\n');
         return {
-            $text: text?.$text,
-            ...(await jsonOutput),
+            primaryMemory,
+            memory,
         };
     }
+    /**
+     * Update memories by user messages and assistant responses.
+     * @param messages Messages to be added to memories.
+     */
+    async updateMemories(messages) {
+        const { memories } = this.definition;
+        const { userId, sessionId } = this.context?.state ?? {};
+        await Promise.all(ordered_map_1.OrderedRecord.map(memories, async ({ memory }) => {
+            if (!memory) {
+                logger_1.default.warn(`Memory is not defined in agent ${this.name || this.id}`);
+                return;
+            }
+            return await memory.add(messages, { userId, sessionId });
+        }));
+    }
 };
 exports.LLMAgent = LLMAgent;
 exports.LLMAgent = LLMAgent = LLMAgent_1 = __decorate([
     (0, tsyringe_1.injectable)(),
     __param(0, (0, tsyringe_1.inject)(constants_1.TYPES.definition)),
     __param(1, (0, tsyringe_1.inject)(constants_1.TYPES.llmModel)),
-    __metadata("design:paramtypes", [Object, llm_model_1.LLMModel])
+    __param(2, (0, tsyringe_1.inject)(constants_1.TYPES.context)),
+    __metadata("design:paramtypes", [Object, llm_model_1.LLMModel, Object])
 ], LLMAgent);
+/**
+ * Create LLMAgent definition.
+ * @param options Options to create LLMAgent.
+ * @returns LLMAgent definition.
+ */
 function createLLMAgentDefinition(options) {
+    const agentId = options.name || (0, nanoid_1.nanoid)();
+    const primaryMemories = options.memories?.filter((i) => i.primary);
+    if (primaryMemories && primaryMemories.length > 1) {
+        throw new Error('Only one primary memory is allowed');
+    }
+    const inputs = (0, data_type_schema_1.schemaToDataType)(options.inputs);
+    const outputs = (0, data_type_schema_1.schemaToDataType)(options.outputs);
+    const memories = ordered_map_1.OrderedRecord.fromArray(options.memories?.map((i) => {
+        const { name, memory, query, options } = i;
+        const queryFromVariable = query?.fromVariable
+            ? ordered_map_1.OrderedRecord.find(inputs, (j) => j.name === query.fromVariable)
+            : null;
+        if (query?.fromVariable && !queryFromVariable)
+            throw new Error(`LLMAgent ${agentId} -> Memory ${name} -> Query variable ${query.fromVariable.toString()} not found`);
+        return {
+            id: name || (0, nanoid_1.nanoid)(),
+            name: name,
+            memory: memory,
+            query: queryFromVariable ? { from: 'variable', fromVariableId: queryFromVariable.id } : undefined,
+            options,
+        };
+    }));
+    const messages = ordered_map_1.OrderedRecord.fromArray(options.messages?.map((i) => ({
+        id: (0, nanoid_1.nanoid)(),
+        role: i.role,
+        content: i.content,
+    })));
     return {
-        id: options.id || options.name || (0, nanoid_1.nanoid)(),
+        id: agentId,
         name: options.name,
         type: 'llm_agent',
-        inputs: (0, data_type_schema_1.schemaToDataType)(options.inputs),
-        outputs: (0, data_type_schema_1.schemaToDataType)(options.outputs),
+        inputs,
+        outputs,
+        primaryMemoryId: primaryMemories?.at(0)?.name,
+        memories,
         modelOptions: options.modelOptions,
-        messages: ordered_map_1.OrderedRecord.fromArray(options.messages?.map((i) => ({
-            id: (0, nanoid_1.nanoid)(),
-            role: i.role,
-            content: i.content,
-        }))),
-    };
-}
-function outputsToJsonSchema(outputs) {
-    const outputToSchema = (output) => {
-        const properties = output.type === 'object' && output.properties?.$indexes.length
-            ? ordered_map_1.OrderedRecord.map(output.properties, (property) => {
-                if (!property.name)
-                    return null;
-                const schema = outputToSchema(property);
-                if (!schema)
-                    return null;
-                return { schema, property };
-            }).filter(utils_1.isNonNullable)
-            : undefined;
-        return (0, lodash_1.omitBy)({
-            type: output.type,
-            description: output.description,
-            properties: properties?.length
-                ? Object.fromEntries(properties.map((p) => [p.property.name, p.schema]))
-                : undefined,
-            items: output.type === 'array' && output.items ? outputToSchema(output.items) : undefined,
-            additionalProperties: output.type === 'object' ? false : undefined,
-            required: properties?.length
-                ? properties.filter((i) => i.property.required).map((i) => i.property.name)
-                : undefined,
-        }, (v) => v === undefined);
+        messages,
     };
-    return outputToSchema({
-        type: 'object',
-        properties: outputs,
-    });
 }

package/lib/cjs/memorable.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoryRunner = exports.Memorable = void 0;
+const lodash_1 = require("lodash");
+const runnable_1 = require("./runnable");
+const utils_1 = require("./utils");
+class Memorable extends runnable_1.Runnable {
+    constructor() {
+        super({
+            id: 'memory',
+            type: 'memory',
+            name: 'Memory',
+            inputs: utils_1.OrderedRecord.fromArray([]),
+            outputs: utils_1.OrderedRecord.fromArray([]),
+        });
+    }
+}
+exports.Memorable = Memorable;
+class MemoryRunner extends runnable_1.Runnable {
+    constructor(name) {
+        const id = `${(0, lodash_1.camelCase)(name)}_runner`;
+        super({
+            id,
+            type: id,
+            name: `${(0, lodash_1.startCase)(name)} Runner`,
+            description: `${(0, lodash_1.startCase)(name)} Runner`,
+            inputs: utils_1.OrderedRecord.fromArray([]),
+            outputs: utils_1.OrderedRecord.fromArray([]),
+        });
+    }
+}
+exports.MemoryRunner = MemoryRunner;