@aigne/core 1.13.0 → 1.14.0

package/lib/esm/models/ollama-chat-model.d.ts

@@ -1,4 +1,20 @@
 import { OpenAIChatModel, type OpenAIChatModelOptions } from "./openai-chat-model.js";
+/**
+ * Implementation of the ChatModel interface for Ollama
+ *
+ * This model allows you to run open-source LLMs locally using Ollama,
+ * with an OpenAI-compatible API interface.
+ *
+ * Default model: 'llama3.2'
+ *
+ * @example
+ * Here's how to create and use an Ollama chat model:
+ * {@includeCode ../../test/models/ollama-chat-model.test.ts#example-ollama-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../../test/models/ollama-chat-model.test.ts#example-ollama-chat-model-streaming}
+ */
 export declare class OllamaChatModel extends OpenAIChatModel {
     constructor(options?: OpenAIChatModelOptions);
     protected apiKeyEnvName: string;

package/lib/esm/models/ollama-chat-model.js

@@ -1,6 +1,22 @@
 import { OpenAIChatModel } from "./openai-chat-model.js";
 const OLLAMA_DEFAULT_BASE_URL = "http://localhost:11434/v1";
 const OLLAMA_DEFAULT_CHAT_MODEL = "llama3.2";
+/**
+ * Implementation of the ChatModel interface for Ollama
+ *
+ * This model allows you to run open-source LLMs locally using Ollama,
+ * with an OpenAI-compatible API interface.
+ *
+ * Default model: 'llama3.2'
+ *
+ * @example
+ * Here's how to create and use an Ollama chat model:
+ * {@includeCode ../../test/models/ollama-chat-model.test.ts#example-ollama-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../../test/models/ollama-chat-model.test.ts#example-ollama-chat-model-streaming}
+ */
 export class OllamaChatModel extends OpenAIChatModel {
     constructor(options) {
         super({

package/lib/esm/models/open-router-chat-model.d.ts

@@ -1,4 +1,20 @@
 import { OpenAIChatModel, type OpenAIChatModelOptions } from "./openai-chat-model.js";
+/**
+ * Implementation of the ChatModel interface for OpenRouter service
+ *
+ * OpenRouter provides access to a variety of large language models through a unified API.
+ * This implementation uses the OpenAI-compatible interface to connect to OpenRouter's service.
+ *
+ * Default model: 'openai/gpt-4o'
+ *
+ * @example
+ * Here's how to create and use an OpenRouter chat model:
+ * {@includeCode ../../test/models/open-router-chat-model.test.ts#example-openrouter-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../../test/models/open-router-chat-model.test.ts#example-openrouter-chat-model-streaming}
+ */
 export declare class OpenRouterChatModel extends OpenAIChatModel {
     constructor(options?: OpenAIChatModelOptions);
     protected apiKeyEnvName: string;

package/lib/esm/models/open-router-chat-model.js

@@ -1,6 +1,22 @@
 import { OpenAIChatModel } from "./openai-chat-model.js";
 const OPEN_ROUTER_DEFAULT_CHAT_MODEL = "openai/gpt-4o";
 const OPEN_ROUTER_BASE_URL = "https://openrouter.ai/api/v1";
+/**
+ * Implementation of the ChatModel interface for OpenRouter service
+ *
+ * OpenRouter provides access to a variety of large language models through a unified API.
+ * This implementation uses the OpenAI-compatible interface to connect to OpenRouter's service.
+ *
+ * Default model: 'openai/gpt-4o'
+ *
+ * @example
+ * Here's how to create and use an OpenRouter chat model:
+ * {@includeCode ../../test/models/open-router-chat-model.test.ts#example-openrouter-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../../test/models/open-router-chat-model.test.ts#example-openrouter-chat-model-streaming}
+ */
 export class OpenRouterChatModel extends OpenAIChatModel {
     constructor(options) {
         super({

package/lib/esm/models/openai-chat-model.d.ts

@@ -1,8 +1,8 @@
 import OpenAI from "openai";
 import type { ChatCompletionMessageParam, ChatCompletionTool } from "openai/resources";
 import { z } from "zod";
-import type { AgentInvokeOptions, AgentResponse } from "../agents/agent.js";
-import type { Context } from "../aigne/context.js";
+import type { AgentProcessResult } from "../agents/agent.js";
+import { type PromiseOrValue } from "../utils/type-utils.js";
 import { ChatModel, type ChatModelInput, type ChatModelInputMessage, type ChatModelInputTool, type ChatModelOptions, type ChatModelOutput, type Role } from "./chat-model.js";
 export interface OpenAIChatModelCapabilities {
     supportsNativeStructuredOutputs: boolean;
@@ -13,12 +13,36 @@ export interface OpenAIChatModelCapabilities {
     supportsToolStreaming: boolean;
     supportsTemperature: boolean;
 }
+/**
+ * Configuration options for OpenAI Chat Model
+ */
 export interface OpenAIChatModelOptions {
+    /**
+     * API key for OpenAI API
+     *
+     * If not provided, will look for OPENAI_API_KEY in environment variables
+     */
     apiKey?: string;
+    /**
+     * Base URL for OpenAI API
+     *
+     * Useful for proxies or alternate endpoints
+     */
     baseURL?: string;
+    /**
+     * OpenAI model to use
+     *
+     * Defaults to 'gpt-4o-mini'
+     */
     model?: string;
+    /**
+     * Additional model options to control behavior
+     */
     modelOptions?: ChatModelOptions;
 }
+/**
+ * @hidden
+ */
 export declare const openAIChatModelOptionsSchema: z.ZodObject<{
     apiKey: z.ZodOptional<z.ZodString>;
     baseURL: z.ZodOptional<z.ZodString>;
@@ -70,9 +94,31 @@ export declare const openAIChatModelOptionsSchema: z.ZodObject<{
     apiKey?: string | undefined;
     baseURL?: string | undefined;
 }>;
+/**
+ * Implementation of the ChatModel interface for OpenAI's API
+ *
+ * This model provides access to OpenAI's capabilities including:
+ * - Text generation
+ * - Tool use with parallel tool calls
+ * - JSON structured output
+ * - Image understanding
+ *
+ * Default model: 'gpt-4o-mini'
+ *
+ * @example
+ * Here's how to create and use an OpenAI chat model:
+ * {@includeCode ../../test/models/openai-chat-model.test.ts#example-openai-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../../test/models/openai-chat-model.test.ts#example-openai-chat-model-streaming}
+ */
 export declare class OpenAIChatModel extends ChatModel {
     options?: OpenAIChatModelOptions | undefined;
     constructor(options?: OpenAIChatModelOptions | undefined);
+    /**
+     * @hidden
+     */
     protected _client?: OpenAI;
     protected apiKeyEnvName: string;
     protected apiKeyDefault: string | undefined;
@@ -85,18 +131,36 @@ export declare class OpenAIChatModel extends ChatModel {
     protected supportsTemperature: boolean;
     get client(): OpenAI;
     get modelOptions(): ChatModelOptions | undefined;
-    process(input: ChatModelInput, _context: Context, options?: AgentInvokeOptions): Promise<AgentResponse<ChatModelOutput>>;
+    /**
+     * Process the input and generate a response
+     * @param input The input to process
+     * @returns The generated response
+     */
+    process(input: ChatModelInput): PromiseOrValue<AgentProcessResult<ChatModelOutput>>;
+    private _process;
     private getParallelToolCalls;
     private getRunMessages;
     private getRunResponseFormat;
     private requestStructuredOutput;
     private extractResultFromStream;
 }
+/**
+ * @hidden
+ */
 export declare const ROLE_MAP: {
     [key in Role]: ChatCompletionMessageParam["role"];
 };
+/**
+ * @hidden
+ */
 export declare function contentsFromInputMessages(messages: ChatModelInputMessage[]): Promise<ChatCompletionMessageParam[]>;
+/**
+ * @hidden
+ */
 export declare function toolsFromInputTools(tools?: ChatModelInputTool[], options?: {
     addTypeToEmptyParameters?: boolean;
 }): ChatCompletionTool[] | undefined;
+/**
+ * @hidden
+ */
 export declare function jsonSchemaToOpenAIJsonSchema(schema: Record<string, unknown>): Record<string, unknown>;

package/lib/esm/models/openai-chat-model.js

@@ -12,6 +12,9 @@ const OPENAI_CHAT_MODEL_CAPABILITIES = {
     "o4-mini": { supportsParallelToolCalls: false, supportsTemperature: false },
     "o3-mini": { supportsParallelToolCalls: false, supportsTemperature: false },
 };
+/**
+ * @hidden
+ */
 export const openAIChatModelOptionsSchema = z.object({
     apiKey: z.string().optional(),
     baseURL: z.string().optional(),
@@ -27,6 +30,25 @@ export const openAIChatModelOptionsSchema = z.object({
     })
         .optional(),
 });
+/**
+ * Implementation of the ChatModel interface for OpenAI's API
+ *
+ * This model provides access to OpenAI's capabilities including:
+ * - Text generation
+ * - Tool use with parallel tool calls
+ * - JSON structured output
+ * - Image understanding
+ *
+ * Default model: 'gpt-4o-mini'
+ *
+ * @example
+ * Here's how to create and use an OpenAI chat model:
+ * {@includeCode ../../test/models/openai-chat-model.test.ts#example-openai-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../../test/models/openai-chat-model.test.ts#example-openai-chat-model-streaming}
+ */
 export class OpenAIChatModel extends ChatModel {
     options;
     constructor(options) {
@@ -37,6 +59,9 @@ export class OpenAIChatModel extends ChatModel {
         const preset = options?.model ? OPENAI_CHAT_MODEL_CAPABILITIES[options.model] : undefined;
         Object.assign(this, preset);
     }
+    /**
+     * @hidden
+     */
     _client;
     apiKeyEnvName = "OPENAI_API_KEY";
     apiKeyDefault;
@@ -60,7 +85,15 @@ export class OpenAIChatModel extends ChatModel {
     get modelOptions() {
         return this.options?.modelOptions;
     }
-    async process(input, _context, options) {
+    /**
+     * Process the input and generate a response
+     * @param input The input to process
+     * @returns The generated response
+     */
+    process(input) {
+        return this._process(input);
+    }
+    async _process(input) {
         const messages = await this.getRunMessages(input);
         const body = {
             model: this.options?.model || CHAT_MODEL_OPENAI_DEFAULT_MODEL,
@@ -86,7 +119,7 @@ export class OpenAIChatModel extends ChatModel {
             parallel_tool_calls: this.getParallelToolCalls(input),
             response_format: responseFormat,
         });
-        if (options?.streaming && input.responseFormat?.type !== "json_schema") {
+        if (input.responseFormat?.type !== "json_schema") {
             return await this.extractResultFromStream(stream, false, true);
         }
         const result = await this.extractResultFromStream(stream, jsonMode);
@@ -254,12 +287,18 @@ export class OpenAIChatModel extends ChatModel {
         return streaming ? result : await agentResponseStreamToObject(result);
     }
 }
+/**
+ * @hidden
+ */
 export const ROLE_MAP = {
     system: "system",
     user: "user",
     agent: "assistant",
     tool: "tool",
 };
+/**
+ * @hidden
+ */
 export async function contentsFromInputMessages(messages) {
     return messages.map((i) => ({
         role: ROLE_MAP[i.role],
@@ -289,6 +328,9 @@ export async function contentsFromInputMessages(messages) {
         name: i.name,
     }));
 }
+/**
+ * @hidden
+ */
 export function toolsFromInputTools(tools, options) {
     return tools?.length
         ? tools.map((i) => {
@@ -307,6 +349,9 @@ export function toolsFromInputTools(tools, options) {
         })
         : undefined;
 }
+/**
+ * @hidden
+ */
 export function jsonSchemaToOpenAIJsonSchema(schema) {
     if (schema?.type === "object") {
         const { required, properties } = schema;

package/lib/esm/models/xai-chat-model.d.ts

@@ -1,4 +1,20 @@
 import { OpenAIChatModel, type OpenAIChatModelOptions } from "./openai-chat-model.js";
+/**
+ * Implementation of the ChatModel interface for X.AI's API (Grok)
+ *
+ * This model uses OpenAI-compatible API format to interact with X.AI models,
+ * providing access to models like Grok.
+ *
+ * Default model: 'grok-2-latest'
+ *
+ * @example
+ * Here's how to create and use an X.AI chat model:
+ * {@includeCode ../../test/models/xai-chat-model.test.ts#example-xai-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../../test/models/xai-chat-model.test.ts#example-xai-chat-model-streaming}
+ */
 export declare class XAIChatModel extends OpenAIChatModel {
     constructor(options?: OpenAIChatModelOptions);
     protected apiKeyEnvName: string;

package/lib/esm/models/xai-chat-model.js

@@ -1,6 +1,22 @@
 import { OpenAIChatModel } from "./openai-chat-model.js";
 const XAI_DEFAULT_CHAT_MODEL = "grok-2-latest";
 const XAI_BASE_URL = "https://api.x.ai/v1";
+/**
+ * Implementation of the ChatModel interface for X.AI's API (Grok)
+ *
+ * This model uses OpenAI-compatible API format to interact with X.AI models,
+ * providing access to models like Grok.
+ *
+ * Default model: 'grok-2-latest'
+ *
+ * @example
+ * Here's how to create and use an X.AI chat model:
+ * {@includeCode ../../test/models/xai-chat-model.test.ts#example-xai-chat-model}
+ *
+ * @example
+ * Here's an example with streaming response:
+ * {@includeCode ../../test/models/xai-chat-model.test.ts#example-xai-chat-model-streaming}
+ */
 export class XAIChatModel extends OpenAIChatModel {
     constructor(options) {
         super({

package/lib/esm/prompt/prompt-builder.d.ts

@@ -1,20 +1,19 @@
 import type { GetPromptResult } from "@modelcontextprotocol/sdk/types.js";
 import { Agent, type Message } from "../agents/agent.js";
 import type { AIAgent } from "../agents/ai-agent.js";
-import type { AgentMemory } from "../agents/memory.js";
 import type { Context } from "../aigne/context.js";
+import type { MemoryAgent } from "../memory/memory.js";
 import type { ChatModel, ChatModelInput } from "../models/chat-model.js";
 import { ChatMessagesTemplate } from "./template.js";
 export declare const MESSAGE_KEY = "$message";
-export declare const DEFAULT_MAX_HISTORY_MESSAGES = 10;
 export declare function createMessage<I extends Message>(message: string | I): I;
 export declare function getMessage(input: Message): string | undefined;
 export interface PromptBuilderOptions {
     instructions?: string | ChatMessagesTemplate;
 }
 export interface PromptBuilderBuildOptions {
-    memory?: AgentMemory;
-    context?: Context;
+    memory?: MemoryAgent | MemoryAgent[];
+    context: Context;
     agent?: AIAgent;
     input?: Message;
     model?: ChatModel;
@@ -37,6 +36,7 @@ export declare class PromptBuilder {
         toolAgents?: Agent[];
     }>;
     private buildMessages;
+    private convertMemoriesToMessages;
     private buildResponseFormat;
     private buildTools;
 }

package/lib/esm/prompt/prompt-builder.js

@@ -1,11 +1,12 @@
 import { readFile } from "node:fs/promises";
+import { stringify } from "yaml";
 import { ZodObject } from "zod";
 import { Agent } from "../agents/agent.js";
 import { outputSchemaToResponseFormatSchema } from "../utils/json-schema.js";
-import { isNil, unique } from "../utils/type-utils.js";
-import { AgentMessageTemplate, ChatMessagesTemplate, SystemMessageTemplate, UserMessageTemplate, } from "./template.js";
+import { isNil, orArrayToArray, unique } from "../utils/type-utils.js";
+import { MEMORY_MESSAGE_TEMPLATE } from "./prompts/memory-message-template.js";
+import { AgentMessageTemplate, ChatMessagesTemplate, PromptTemplate, SystemMessageTemplate, UserMessageTemplate, } from "./template.js";
 export const MESSAGE_KEY = "$message";
-export const DEFAULT_MAX_HISTORY_MESSAGES = 10;
 export function createMessage(message) {
     return typeof message === "string"
         ? { [MESSAGE_KEY]: message }
@@ -67,26 +68,20 @@ export class PromptBuilder {
     instructions;
     async build(options) {
         return {
-            messages: this.buildMessages(options),
+            messages: await this.buildMessages(options),
             responseFormat: this.buildResponseFormat(options),
             ...this.buildTools(options),
         };
     }
-    buildMessages(options) {
+    async buildMessages(options) {
         const { input } = options;
         const messages = (typeof this.instructions === "string"
             ? ChatMessagesTemplate.from([SystemMessageTemplate.from(this.instructions)])
             : this.instructions)?.format(options.input) ?? [];
-        const memory = options.memory ?? options.agent?.memory;
-        if (memory?.enabled) {
-            const k = memory.maxMemoriesInChat ?? DEFAULT_MAX_HISTORY_MESSAGES;
-            const histories = memory.memories.slice(-k);
-            if (histories?.length)
-                messages.push(...histories.map((i) => ({
-                    role: i.role,
-                    content: convertMessageToContent(i.content),
-                    name: i.source,
-                })));
+        for (const memory of orArrayToArray(options.memory ?? options.agent?.memories)) {
+            const memories = (await memory.retrieve({ search: input && getMessage(input) }, options.context))?.memories;
+            if (memories?.length)
+                messages.push(...this.convertMemoriesToMessages(memories, options));
         }
         const content = input && getMessage(input);
         // add user input if it's not the same as the last message
@@ -95,6 +90,15 @@ export class PromptBuilder {
         }
         return messages;
     }
+    convertMemoriesToMessages(memories, options) {
+        const str = stringify(memories.map((i) => i.content));
+        return [
+            {
+                role: "system",
+                content: PromptTemplate.from(options.agent?.memoryPromptTemplate || MEMORY_MESSAGE_TEMPLATE).format({ memories: str }),
+            },
+        ];
+    }
     buildResponseFormat(options) {
         const outputSchema = options.outputSchema || options.agent?.outputSchema;
         if (!outputSchema)
@@ -114,6 +118,7 @@ export class PromptBuilder {
     buildTools(options) {
         const toolAgents = unique((options.context?.skills ?? [])
             .concat(options.agent?.skills ?? [])
+            .concat(options.agent?.memoryAgentsAsTools ? options.agent.memories : [])
             // TODO: support nested tools?
             .flatMap((i) => (i.isInvokable ? i.skills.concat(i) : i.skills)), (i) => i.name);
         const tools = toolAgents.map((i) => ({
@@ -169,7 +174,3 @@ function isFromPath(value) {
 function isEmptyObjectType(schema) {
     return schema instanceof ZodObject && Object.keys(schema.shape).length === 0;
 }
-function convertMessageToContent(i) {
-    const str = i[MESSAGE_KEY];
-    return !isNil(str) ? (typeof str === "string" ? str : JSON.stringify(str)) : JSON.stringify(i);
-}

package/lib/esm/prompt/prompts/memory-message-template.d.ts

@@ -0,0 +1 @@
+export declare const MEMORY_MESSAGE_TEMPLATE = "Here are some useful memories to consider:\n\n<memories>\n{{memories}}\n</memories>\n";

package/lib/esm/prompt/prompts/memory-message-template.js

@@ -0,0 +1,7 @@
+export const MEMORY_MESSAGE_TEMPLATE = `\
+Here are some useful memories to consider:
+
+<memories>
+{{memories}}
+</memories>
+`;

package/lib/esm/prompt/template.js

@@ -1,5 +1,7 @@
+import { inspect } from "node:util";
 import Mustache from "mustache";
 import { z } from "zod";
+import { tryOrThrow } from "../utils/type-utils.js";
 export class PromptTemplate {
     template;
     static from(template) {
@@ -76,7 +78,9 @@ export class ToolMessageTemplate extends ChatMessageTemplate {
         return new ToolMessageTemplate(content, toolCallId, name);
     }
     constructor(content, toolCallId, name) {
-        super("tool", typeof content === "string" ? content : JSON.stringify(content), name);
+        super("tool", typeof content === "string"
+            ? content
+            : tryOrThrow(() => JSON.stringify(content), `Failed to stringify tool content. toolCallId: ${toolCallId}, content: ${inspect(content)}`), name);
         this.toolCallId = toolCallId;
     }
     format(variables) {

package/lib/esm/server/error.d.ts

@@ -1,4 +1,15 @@
+/**
+ * Custom error class for AIGNEServer HTTP-related errors.
+ * Extends the standard Error class with an HTTP status code property.
+ * This allows error responses to include appropriate HTTP status codes.
+ */
 export declare class ServerError extends Error {
     status: number;
+    /**
+     * Creates a new ServerError instance.
+     *
+     * @param status - The HTTP status code for this error (e.g., 400, 404, 500)
+     * @param message - The error message describing what went wrong
+     */
     constructor(status: number, message: string);
 }

package/lib/esm/server/error.js

@@ -1,5 +1,16 @@
+/**
+ * Custom error class for AIGNEServer HTTP-related errors.
+ * Extends the standard Error class with an HTTP status code property.
+ * This allows error responses to include appropriate HTTP status codes.
+ */
 export class ServerError extends Error {
     status;
+    /**
+     * Creates a new ServerError instance.
+     *
+     * @param status - The HTTP status code for this error (e.g., 400, 404, 500)
+     * @param message - The error message describing what went wrong
+     */
     constructor(status, message) {
         super(message);
         this.status = status;

package/lib/esm/server/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./error.js";
+export * from "./server.js";

package/lib/esm/server/index.js

@@ -0,0 +1,2 @@
+export * from "./error.js";
+export * from "./server.js";