@aigne/core 1.14.0 → 1.16.0

package/lib/esm/agents/agent.d.ts

@@ -3,7 +3,8 @@ import { ZodObject, type ZodType } from "zod";
 import type { Context } from "../aigne/context.js";
 import type { MessagePayload } from "../aigne/message-queue.js";
 import type { MemoryAgent } from "../memory/memory.js";
-import { type Nullish, type PromiseOrValue } from "../utils/type-utils.js";
+import { type Nullish, type PromiseOrValue, type XOr } from "../utils/type-utils.js";
+import type { GuideRailAgent, GuideRailAgentOutput } from "./guide-rail-agent.js";
 import { type TransferAgentOutput } from "./types.js";
 export * from "./types.js";
 /**
@@ -29,7 +30,7 @@ export type PublishTopic<O extends Message> = string | string[] | ((output: O) =
  * @template I The agent input message type
  * @template O The agent output message type
  */
-export interface AgentOptions<I extends Message = Message, O extends Message = Message> {
+export interface AgentOptions<I extends Message = Message, O extends Message = Message> extends Partial<Pick<Agent, "guideRails" | "hooks">> {
     /**
      * Topics the agent should subscribe to
      *
@@ -139,6 +140,35 @@ export declare abstract class Agent<I extends Message = Message, O extends Messa
      * List of memories this agent can use
      */
     readonly memories: MemoryAgent[];
+    /**
+     * Lifecycle hooks for agent processing.
+     *
+     * Hooks enable tracing, logging, monitoring, and custom behavior
+     * without modifying the core agent implementation
+     *
+     * @example
+     * Here's an example of using hooks:
+     * {@includeCode ../../test/agents/agent.test.ts#example-agent-hooks}
+     */
+    readonly hooks: AgentHooks;
+    /**
+     * List of GuideRail agents applied to this agent
+     *
+     * GuideRail agents validate, transform, or control the message flow by:
+     * - Enforcing rules and safety policies
+     * - Validating inputs/outputs against specific criteria
+     * - Implementing business logic validations
+     * - Monitoring and auditing agent behavior
+     *
+     * Each GuideRail agent can examine both input and expected output,
+     * and has the ability to abort the process with an explanation
+     *
+     * @example
+     * Here's an example of using GuideRail agents:
+     *
+     * {@includeCode ../../test/agents/agent.test.ts#example-agent-guide-rails}
+     */
+    readonly guideRails?: GuideRailAgent[];
     /**
      * Name of the agent, used for identification and logging
      *
@@ -301,6 +331,7 @@ export declare abstract class Agent<I extends Message = Message, O extends Messa
      * @returns Agent response (streaming or regular)
      */
     invoke(input: I | string, context?: Context, options?: AgentInvokeOptions): Promise<AgentResponse<O>>;
+    protected invokeSkill<I extends Message, O extends Message>(skill: Agent<I, O>, input: I, context: Context): Promise<O>;
     /**
      * Process agent output
      *
@@ -319,7 +350,6 @@ export declare abstract class Agent<I extends Message = Message, O extends Messa
      *
      * @param error Caught error
      * @param context Execution context
-     * @throws Always throws the received error
      */
     private processAgentError;
     /**
@@ -342,7 +372,25 @@ export declare abstract class Agent<I extends Message = Message, O extends Messa
      * @param _ Input message (unused)
      * @param context Execution context
      */
-    protected preprocess(_: I, context: Context): void;
+    protected preprocess(_: I, context: Context): PromiseOrValue<void>;
+    private checkResponseByGuideRails;
+    private runGuideRails;
+    /**
+     * Handle errors detected by GuideRail agents
+     *
+     * This method is called when a GuideRail agent aborts the process, providing
+     * a way for agents to customize error handling behavior. By default, it simply
+     * returns the original error, but subclasses can override this method to:
+     * - Transform the error into a more specific response
+     * - Apply recovery strategies
+     * - Log or report the error in a custom format
+     * - Return a fallback output instead of an error
+     *
+     * @param error The GuideRail agent output containing abort=true and a reason
+     * @returns Either the original/modified error or a substitute output object
+     *          which will be tagged with $status: "GuideRailError"
+     */
+    protected onGuideRailError(error: GuideRailAgentOutput): Promise<O | GuideRailAgentOutput>;
     /**
      * Post-processing operations after handling output
      *
@@ -354,7 +402,7 @@ export declare abstract class Agent<I extends Message = Message, O extends Messa
      * @param output Output message
      * @param context Execution context
      */
-    protected postprocess(input: I, output: O, context: Context): void;
+    protected postprocess(input: I, output: O, context: Context): PromiseOrValue<void>;
     protected publishToTopics(output: Message, context: Context): Promise<void>;
     /**
      * Core processing method of the agent, must be implemented in subclasses
@@ -419,6 +467,81 @@ export declare abstract class Agent<I extends Message = Message, O extends Messa
      */
     [Symbol.asyncDispose](): Promise<void>;
 }
+/**
+ * Lifecycle hooks for agent execution
+ *
+ * Hooks provide a way to intercept and extend agent behavior at key points during
+ * the agent's lifecycle, enabling custom functionality like logging, monitoring,
+ * tracing, error handling, and more.
+ */
+export interface AgentHooks<I extends Message = Message, O extends Message = Message> {
+    /**
+     * Called when agent processing begins
+     *
+     * This hook runs before the agent processes input, allowing for
+     * setup operations, logging, or input transformations.
+     *
+     * @param event Object containing the input message
+     */
+    onStart?: (event: {
+        input: I;
+    }) => PromiseOrValue<void>;
+    /**
+     * Called when agent processing completes or fails
+     *
+     * This hook runs after processing finishes, receiving either the output
+     * or an error if processing failed. Useful for cleanup operations,
+     * logging results, or error handling.
+     *
+     * @param event Object containing the input message and either output or error
+     */
+    onEnd?: (event: XOr<{
+        input: I;
+        output: O;
+        error: Error;
+    }, "output", "error">) => PromiseOrValue<void>;
+    /**
+     * Called before a skill (sub-agent) is invoked
+     *
+     * This hook runs when the agent delegates work to a skill,
+     * allowing for tracking skill usage or transforming input to the skill.
+     *
+     * @param event Object containing the skill being used and input message
+     */
+    onSkillStart?: (event: {
+        skill: Agent;
+        input: I;
+    }) => PromiseOrValue<void>;
+    /**
+     * Called after a skill (sub-agent) completes or fails
+     *
+     * This hook runs when a skill finishes execution, receiving either the output
+     * or an error if the skill failed. Useful for monitoring skill performance
+     * or handling skill-specific errors.
+     *
+     * @param event Object containing the skill used, input message, and either output or error
+     */
+    onSkillEnd?: (event: XOr<{
+        skill: Agent;
+        input: I;
+        output: O;
+        error: Error;
+    }, "output", "error">) => PromiseOrValue<void>;
+    /**
+     * Called when an agent hands off processing to another agent
+     *
+     * This hook runs when a source agent transfers control to a target agent,
+     * allowing for tracking of handoffs between agents and monitoring the flow
+     * of processing in multi-agent systems.
+     *
+     * @param event Object containing the source agent, target agent, and input message
+     */
+    onHandoff?: (event: {
+        source: Agent;
+        target: Agent;
+        input: I;
+    }) => PromiseOrValue<void>;
+}
 /**
  * Response type for an agent, can be:
  * - Direct response object
@@ -427,7 +550,7 @@ export declare abstract class Agent<I extends Message = Message, O extends Messa
  *
  * @template T Response data type
  */
-export type AgentResponse<T> = T | TransferAgentOutput | AgentResponseStream<T>;
+export type AgentResponse<T> = T | AgentResponseStream<T> | TransferAgentOutput | GuideRailAgentOutput;
 /**
  * Streaming response type for an agent
  *

package/lib/esm/agents/agent.js

@@ -19,6 +19,16 @@ export const agentOptionsSchema = z.object({
     skills: z.array(z.union([z.custom(), z.custom()])).optional(),
     disableEvents: z.boolean().optional(),
     memory: z.union([z.custom(), z.array(z.custom())]).optional(),
+    hooks: z
+        .object({
+        onStart: z.custom().optional(),
+        onEnd: z.custom().optional(),
+        onSkillStart: z.custom().optional(),
+        onSkillEnd: z.custom().optional(),
+        onHandoff: z.custom().optional(),
+    })
+        .optional(),
+    guideRails: z.array(z.custom()).optional(),
 });
 /**
  * Agent is the base class for all agents.
@@ -65,11 +75,42 @@ export class Agent {
         else if (options.memory) {
             this.memories.push(options.memory);
         }
+        this.hooks = options.hooks ?? {};
+        this.guideRails = options.guideRails;
     }
     /**
      * List of memories this agent can use
      */
     memories = [];
+    /**
+     * Lifecycle hooks for agent processing.
+     *
+     * Hooks enable tracing, logging, monitoring, and custom behavior
+     * without modifying the core agent implementation
+     *
+     * @example
+     * Here's an example of using hooks:
+     * {@includeCode ../../test/agents/agent.test.ts#example-agent-hooks}
+     */
+    hooks;
+    /**
+     * List of GuideRail agents applied to this agent
+     *
+     * GuideRail agents validate, transform, or control the message flow by:
+     * - Enforcing rules and safety policies
+     * - Validating inputs/outputs against specific criteria
+     * - Implementing business logic validations
+     * - Monitoring and auditing agent behavior
+     *
+     * Each GuideRail agent can examine both input and expected output,
+     * and has the ability to abort the process with an explanation
+     *
+     * @example
+     * Here's an example of using GuideRail agents:
+     *
+     * {@includeCode ../../test/agents/agent.test.ts#example-agent-guide-rails}
+     */
+    guideRails;
     /**
      * Name of the agent, used for identification and logging
      *
@@ -226,12 +267,13 @@ export class Agent {
     async invoke(input, context, options) {
         const ctx = context ?? (await this.newDefaultContext());
         const message = typeof input === "string" ? createMessage(input) : input;
-        logger.core("Invoke agent %s started with input: %O", this.name, input);
+        logger.debug("Invoke agent %s started with input: %O", this.name, input);
         if (!this.disableEvents)
             ctx.emit("agentStarted", { agent: this, input: message });
         try {
+            await this.hooks.onStart?.({ input: message });
             const parsedInput = checkArguments(`Agent ${this.name} input`, this.inputSchema, message);
-            this.preprocess(parsedInput, ctx);
+            await this.preprocess(parsedInput, ctx);
             this.checkContextStatus(ctx);
             let response = await this.process(parsedInput, ctx);
             if (response instanceof Agent) {
@@ -243,27 +285,34 @@ export class Agent {
                     : isAsyncGenerator(response)
                         ? asyncGeneratorToReadableStream(response)
                         : objectToAgentResponseStream(response);
-                return onAgentResponseStreamEnd(stream, async (result) => {
+                return this.checkResponseByGuideRails(message, onAgentResponseStreamEnd(stream, async (result) => {
                     return await this.processAgentOutput(parsedInput, result, ctx);
                 }, {
-                    errorCallback: (error) => {
-                        try {
-                            this.processAgentError(error, ctx);
-                        }
-                        catch (error) {
-                            return error;
-                        }
+                    errorCallback: async (error) => {
+                        return await this.processAgentError(message, error, ctx);
                     },
-                });
+                }), ctx);
             }
-            return await this.processAgentOutput(parsedInput, response instanceof ReadableStream
+            return await this.checkResponseByGuideRails(message, this.processAgentOutput(parsedInput, response instanceof ReadableStream
                 ? await agentResponseStreamToObject(response)
                 : isAsyncGenerator(response)
                     ? await agentResponseStreamToObject(response)
-                    : response, ctx);
+                    : response, ctx), ctx);
         }
         catch (error) {
-            this.processAgentError(error, ctx);
+            throw await this.processAgentError(message, error, ctx);
+        }
+    }
+    async invokeSkill(skill, input, context) {
+        await this.hooks.onSkillStart?.({ skill, input });
+        try {
+            const output = await context.invoke(skill, input);
+            await this.hooks.onSkillEnd?.({ skill, input, output });
+            return output;
+        }
+        catch (error) {
+            await this.hooks.onSkillEnd?.({ skill, input, error });
+            throw error;
         }
     }
     /**
@@ -279,10 +328,11 @@ export class Agent {
     async processAgentOutput(input, output, context) {
         const parsedOutput = checkArguments(`Agent ${this.name} output`, this.outputSchema, output);
         const finalOutput = this.includeInputInOutput ? { ...input, ...parsedOutput } : parsedOutput;
-        this.postprocess(input, finalOutput, context);
-        logger.core("Invoke agent %s succeed with output: %O", this.name, finalOutput);
+        await this.postprocess(input, finalOutput, context);
+        logger.debug("Invoke agent %s succeed with output: %O", this.name, finalOutput);
         if (!this.disableEvents)
             context.emit("agentSucceed", { agent: this, output: finalOutput });
+        await this.hooks.onEnd?.({ input, output: finalOutput });
         return finalOutput;
     }
     /**
@@ -292,13 +342,13 @@ export class Agent {
      *
      * @param error Caught error
      * @param context Execution context
-     * @throws Always throws the received error
      */
-    processAgentError(error, context) {
-        logger.core("Invoke agent %s failed with error: %O", this.name, error);
+    async processAgentError(input, error, context) {
+        logger.error("Invoke agent %s failed with error: %O", this.name, error);
         if (!this.disableEvents)
             context.emit("agentFailed", { agent: this, error });
-        throw error;
+        await this.hooks.onEnd?.({ input, error });
+        return error;
     }
     /**
      * Check agent invocation usage to prevent exceeding limits
@@ -330,6 +380,48 @@ export class Agent {
         this.checkContextStatus(context);
         this.checkAgentInvokesUsage(context);
     }
+    async checkResponseByGuideRails(input, output, context) {
+        if (!this.guideRails?.length)
+            return output;
+        const result = await output;
+        if (result instanceof ReadableStream) {
+            return onAgentResponseStreamEnd(result, async (result) => {
+                const error = await this.runGuideRails(input, result, context);
+                if (error) {
+                    return {
+                        ...(await this.onGuideRailError(error)),
+                        $status: "GuideRailError",
+                    };
+                }
+            });
+        }
+        const error = await this.runGuideRails(input, result, context);
+        if (!error)
+            return output;
+        return { ...(await this.onGuideRailError(error)), $status: "GuideRailError" };
+    }
+    async runGuideRails(input, output, context) {
+        const result = await Promise.all((this.guideRails ?? []).map((i) => context.invoke(i, { input, output })));
+        return result.find((i) => !!i.abort);
+    }
+    /**
+     * Handle errors detected by GuideRail agents
+     *
+     * This method is called when a GuideRail agent aborts the process, providing
+     * a way for agents to customize error handling behavior. By default, it simply
+     * returns the original error, but subclasses can override this method to:
+     * - Transform the error into a more specific response
+     * - Apply recovery strategies
+     * - Log or report the error in a custom format
+     * - Return a fallback output instead of an error
+     *
+     * @param error The GuideRail agent output containing abort=true and a reason
+     * @returns Either the original/modified error or a substitute output object
+     *          which will be tagged with $status: "GuideRailError"
+     */
+    async onGuideRailError(error) {
+        return error;
+    }
     /**
      * Post-processing operations after handling output
      *

package/lib/esm/agents/ai-agent.d.ts

@@ -1,10 +1,10 @@
 import { type ZodObject, type ZodType, z } from "zod";
 import type { Context } from "../aigne/context.js";
 import { type DefaultMemoryOptions } from "../memory/default-memory.js";
-import { ChatModel } from "../models/chat-model.js";
-import type { ChatModelInput } from "../models/chat-model.js";
 import { PromptBuilder } from "../prompt/prompt-builder.js";
 import { Agent, type AgentOptions, type AgentProcessAsyncGenerator, type Message } from "./agent.js";
+import { ChatModel, type ChatModelInput } from "./chat-model.js";
+import type { GuideRailAgentOutput } from "./guide-rail-agent.js";
 /**
  * Configuration options for an AI Agent
  *
@@ -216,6 +216,7 @@ export declare class AIAgent<I extends Message = Message, O extends Message = Me
      * @protected
      */
     process(input: I, context: Context): AgentProcessAsyncGenerator<O>;
+    protected onGuideRailError(error: GuideRailAgentOutput): Promise<O | GuideRailAgentOutput>;
     /**
      * Process router mode requests
      *

package/lib/esm/agents/ai-agent.js

@@ -1,12 +1,11 @@
 import { z } from "zod";
 import { DefaultMemory } from "../memory/default-memory.js";
 import { MemoryAgent } from "../memory/memory.js";
-import { ChatModel } from "../models/chat-model.js";
 import { MESSAGE_KEY, PromptBuilder } from "../prompt/prompt-builder.js";
 import { AgentMessageTemplate, ToolMessageTemplate } from "../prompt/template.js";
-import { readableStreamToAsyncIterator } from "../utils/stream-utils.js";
 import { checkArguments, isEmpty } from "../utils/type-utils.js";
 import { Agent, agentOptionsSchema, } from "./agent.js";
+import { ChatModel, } from "./chat-model.js";
 import { isTransferAgentOutput } from "./types.js";
 /**
  * Tool choice options for AI agents
@@ -206,7 +205,7 @@ export class AIAgent extends Agent {
         for (;;) {
             const modelOutput = {};
             const stream = await context.invoke(model, { ...modelInput, messages: modelInput.messages.concat(toolCallMessages) }, { streaming: true });
-            for await (const value of readableStreamToAsyncIterator(stream)) {
+            for await (const value of stream) {
                 if (value.delta.text?.text) {
                     yield { delta: { text: { [outputKey]: value.delta.text.text } } };
                 }
@@ -223,9 +222,7 @@ export class AIAgent extends Agent {
                     if (!tool)
                         throw new Error(`Tool not found: ${call.function.name}`);
                     // NOTE: should pass both arguments (model generated) and input (user provided) to the tool
-                    const output = await context
-                        .invoke(tool, { ...input, ...call.function.arguments }, { disableTransfer: true })
-                        .catch((error) => {
+                    const output = await this.invokeSkill(tool, { ...input, ...call.function.arguments }, context).catch((error) => {
                         if (!this.catchToolsError) {
                             return Promise.reject(error);
                         }
@@ -249,7 +246,7 @@ export class AIAgent extends Agent {
                 }
             }
             const result = {};
-            if (modelInput.responseFormat?.type === "json_schema") {
+            if (json) {
                 Object.assign(result, json);
             }
             else if (text) {
@@ -261,6 +258,12 @@ export class AIAgent extends Agent {
             return;
         }
     }
+    async onGuideRailError(error) {
+        const outputKey = this.outputKey || MESSAGE_KEY;
+        return {
+            [outputKey]: error.reason,
+        };
+    }
     /**
      * Process router mode requests
      *
@@ -277,7 +280,7 @@ export class AIAgent extends Agent {
         const tool = toolsMap.get(call.function.name);
         if (!tool)
             throw new Error(`Tool not found: ${call.function.name}`);
-        const stream = await context.invoke(tool, { ...call.function.arguments, ...input }, { streaming: true });
-        yield* readableStreamToAsyncIterator(stream);
+        const stream = await context.invoke(tool, { ...call.function.arguments, ...input }, { streaming: true, sourceAgent: this });
+        yield* stream;
     }
 }

package/lib/{dts/models → esm/agents}/chat-model.d.ts

@@ -1,6 +1,6 @@
-import { Agent, type AgentProcessResult, type Message } from "../agents/agent.js";
 import type { Context } from "../aigne/context.js";
 import type { PromiseOrValue } from "../utils/type-utils.js";
+import { Agent, type AgentProcessResult, type Message } from "./agent.js";
 /**
  * ChatModel is an abstract base class for interacting with Large Language Models (LLMs).
  *
@@ -10,19 +10,19 @@ import type { PromiseOrValue } from "../utils/type-utils.js";
  *
  * @example
  * Here's how to implement a custom ChatModel:
- * {@includeCode ../../test/models/chat-model.test.ts#example-chat-model}
+ * {@includeCode ../../test/agents/chat-model.test.ts#example-chat-model}
  *
  * @example
  * Here's an example showing streaming response with readable stream:
- * {@includeCode ../../test/models/chat-model.test.ts#example-chat-model-streaming}
+ * {@includeCode ../../test/agents/chat-model.test.ts#example-chat-model-streaming}
  *
  * @example
  * Here's an example showing streaming response with async generator:
- * {@includeCode ../../test/models/chat-model.test.ts#example-chat-model-streaming-async-generator}
+ * {@includeCode ../../test/agents/chat-model.test.ts#example-chat-model-streaming-async-generator}
  *
  * @example
  * Here's an example with tool calls:
- * {@includeCode ../../test/models/chat-model.test.ts#example-chat-model-tools}
+ * {@includeCode ../../test/agents/chat-model.test.ts#example-chat-model-tools}
  */
 export declare abstract class ChatModel extends Agent<ChatModelInput, ChatModelOutput> {
     constructor();
@@ -44,6 +44,17 @@ export declare abstract class ChatModel extends Agent<ChatModelInput, ChatModelO
         supportsParallelToolCalls: boolean;
     };
     private validateToolNames;
+    /**
+     * Normalizes tool names to ensure compatibility with language models
+     *
+     * This method converts tool names to a format that complies with model requirements
+     * by replacing hyphens and whitespace characters with underscores. The normalized
+     * names are used for tool calls while preserving the original names for reference.
+     *
+     * @param name - The original tool name to normalize
+     * @returns A promise that resolves to the normalized tool name
+     */
+    protected normalizeToolName(name: string): Promise<string>;
     /**
      * Performs preprocessing operations before handling input
      *
@@ -53,7 +64,7 @@ export declare abstract class ChatModel extends Agent<ChatModelInput, ChatModelO
      * @param context Execution context
      * @throws Error if token usage exceeds maximum limit
      */
-    protected preprocess(input: ChatModelInput, context: Context): void;
+    protected preprocess(input: ChatModelInput, context: Context): Promise<void>;
     /**
      * Performs postprocessing operations after handling output
      *
@@ -94,11 +105,11 @@ export declare abstract class ChatModel extends Agent<ChatModelInput, ChatModelO
  *
  * @example
  * Here's a basic ChatModel input example:
- * {@includeCode ../../test/models/chat-model.test.ts#example-chat-model}
+ * {@includeCode ../../test/agents/chat-model.test.ts#example-chat-model}
  *
  * @example
  * Here's an example with tool calling:
- * {@includeCode ../../test/models/chat-model.test.ts#example-chat-model-tools}
+ * {@includeCode ../../test/agents/chat-model.test.ts#example-chat-model-tools}
  */
 export interface ChatModelInput extends Message {
     /**
@@ -213,7 +224,7 @@ export type ChatModelInputResponseFormat = {
  *
  * @example
  * Here's an example showing how to use tools:
- * {@includeCode ../../test/models/chat-model.test.ts#example-chat-model-tools}
+ * {@includeCode ../../test/agents/chat-model.test.ts#example-chat-model-tools}
  */
 export interface ChatModelInputTool {
     /**
@@ -249,7 +260,7 @@ export interface ChatModelInputTool {
  *
  * @example
  * Here's an example showing how to use tools:
- * {@includeCode ../../test/models/chat-model.test.ts#example-chat-model-tools}
+ * {@includeCode ../../test/agents/chat-model.test.ts#example-chat-model-tools}
  */
 export type ChatModelInputToolChoice = "auto" | "none" | "required" | {
     type: "function";
@@ -296,11 +307,11 @@ export interface ChatModelOptions {
  *
  * @example
  * Here's a basic output example:
- * {@includeCode ../../test/models/chat-model.test.ts#example-chat-model}
+ * {@includeCode ../../test/agents/chat-model.test.ts#example-chat-model}
  *
  * @example
  * Here's an example with tool calls:
- * {@includeCode ../../test/models/chat-model.test.ts#example-chat-model-tools}
+ * {@includeCode ../../test/agents/chat-model.test.ts#example-chat-model-tools}
  */
 export interface ChatModelOutput extends Message {
     /**
@@ -331,7 +342,7 @@ export interface ChatModelOutput extends Message {
  *
  * @example
  * Here's an example with tool calls:
- * {@includeCode ../../test/models/chat-model.test.ts#example-chat-model-tools}
+ * {@includeCode ../../test/agents/chat-model.test.ts#example-chat-model-tools}
  */
 export interface ChatModelOutputToolCall {
     /**