@aigne/core 1.15.0 → 1.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (141) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/README.md +9 -7
  3. package/README.zh.md +9 -7
  4. package/lib/cjs/agents/agent.d.ts +129 -6
  5. package/lib/cjs/agents/agent.js +112 -20
  6. package/lib/cjs/agents/ai-agent.d.ts +3 -2
  7. package/lib/cjs/agents/ai-agent.js +10 -6
  8. package/lib/{esm/models → cjs/agents}/chat-model.d.ts +24 -13
  9. package/lib/cjs/{models → agents}/chat-model.js +48 -7
  10. package/lib/cjs/agents/guide-rail-agent.d.ts +62 -0
  11. package/lib/cjs/agents/guide-rail-agent.js +14 -0
  12. package/lib/cjs/agents/mcp-agent.js +9 -9
  13. package/lib/cjs/aigne/aigne.d.ts +3 -2
  14. package/lib/cjs/aigne/aigne.js +2 -2
  15. package/lib/cjs/aigne/context.d.ts +2 -1
  16. package/lib/cjs/aigne/context.js +7 -0
  17. package/lib/cjs/index.d.ts +1 -1
  18. package/lib/cjs/index.js +1 -1
  19. package/lib/cjs/loader/agent-yaml.d.ts +1 -1
  20. package/lib/cjs/loader/index.d.ts +18 -11
  21. package/lib/cjs/loader/index.js +8 -27
  22. package/lib/cjs/memory/retriever.d.ts +2 -2
  23. package/lib/cjs/prompt/prompt-builder.d.ts +3 -3
  24. package/lib/cjs/prompt/template.d.ts +3 -3
  25. package/lib/cjs/utils/json-schema.js +1 -1
  26. package/lib/cjs/utils/logger.d.ts +33 -8
  27. package/lib/cjs/utils/logger.js +63 -5
  28. package/lib/cjs/utils/model-utils.d.ts +1 -1
  29. package/lib/cjs/utils/stream-utils.d.ts +3 -1
  30. package/lib/cjs/utils/stream-utils.js +31 -1
  31. package/lib/cjs/utils/type-utils.d.ts +5 -0
  32. package/lib/dts/agents/agent.d.ts +129 -6
  33. package/lib/dts/agents/ai-agent.d.ts +3 -2
  34. package/lib/{cjs/models → dts/agents}/chat-model.d.ts +24 -13
  35. package/lib/dts/agents/guide-rail-agent.d.ts +62 -0
  36. package/lib/dts/aigne/aigne.d.ts +3 -2
  37. package/lib/dts/aigne/context.d.ts +2 -1
  38. package/lib/dts/index.d.ts +1 -1
  39. package/lib/dts/loader/agent-yaml.d.ts +1 -1
  40. package/lib/dts/loader/index.d.ts +18 -11
  41. package/lib/dts/memory/retriever.d.ts +2 -2
  42. package/lib/dts/prompt/prompt-builder.d.ts +3 -3
  43. package/lib/dts/prompt/template.d.ts +3 -3
  44. package/lib/dts/utils/logger.d.ts +33 -8
  45. package/lib/dts/utils/model-utils.d.ts +1 -1
  46. package/lib/dts/utils/stream-utils.d.ts +3 -1
  47. package/lib/dts/utils/type-utils.d.ts +5 -0
  48. package/lib/esm/agents/agent.d.ts +129 -6
  49. package/lib/esm/agents/agent.js +112 -20
  50. package/lib/esm/agents/ai-agent.d.ts +3 -2
  51. package/lib/esm/agents/ai-agent.js +10 -6
  52. package/lib/{dts/models → esm/agents}/chat-model.d.ts +24 -13
  53. package/lib/esm/{models → agents}/chat-model.js +48 -7
  54. package/lib/esm/agents/guide-rail-agent.d.ts +62 -0
  55. package/lib/esm/agents/guide-rail-agent.js +11 -0
  56. package/lib/esm/agents/mcp-agent.js +9 -9
  57. package/lib/esm/aigne/aigne.d.ts +3 -2
  58. package/lib/esm/aigne/aigne.js +2 -2
  59. package/lib/esm/aigne/context.d.ts +2 -1
  60. package/lib/esm/aigne/context.js +7 -0
  61. package/lib/esm/index.d.ts +1 -1
  62. package/lib/esm/index.js +1 -1
  63. package/lib/esm/loader/agent-yaml.d.ts +1 -1
  64. package/lib/esm/loader/index.d.ts +18 -11
  65. package/lib/esm/loader/index.js +8 -27
  66. package/lib/esm/memory/retriever.d.ts +2 -2
  67. package/lib/esm/prompt/prompt-builder.d.ts +3 -3
  68. package/lib/esm/prompt/template.d.ts +3 -3
  69. package/lib/esm/utils/json-schema.js +1 -1
  70. package/lib/esm/utils/logger.d.ts +33 -8
  71. package/lib/esm/utils/logger.js +61 -4
  72. package/lib/esm/utils/model-utils.d.ts +1 -1
  73. package/lib/esm/utils/stream-utils.d.ts +3 -1
  74. package/lib/esm/utils/stream-utils.js +29 -1
  75. package/lib/esm/utils/type-utils.d.ts +5 -0
  76. package/package.json +1 -20
  77. package/lib/cjs/client/client.d.ts +0 -97
  78. package/lib/cjs/client/client.js +0 -87
  79. package/lib/cjs/client/index.d.ts +0 -1
  80. package/lib/cjs/client/index.js +0 -17
  81. package/lib/cjs/models/bedrock-chat-model.d.ts +0 -79
  82. package/lib/cjs/models/bedrock-chat-model.js +0 -303
  83. package/lib/cjs/models/claude-chat-model.d.ts +0 -114
  84. package/lib/cjs/models/claude-chat-model.js +0 -317
  85. package/lib/cjs/models/deepseek-chat-model.d.ts +0 -23
  86. package/lib/cjs/models/deepseek-chat-model.js +0 -35
  87. package/lib/cjs/models/gemini-chat-model.d.ts +0 -23
  88. package/lib/cjs/models/gemini-chat-model.js +0 -35
  89. package/lib/cjs/models/ollama-chat-model.d.ts +0 -22
  90. package/lib/cjs/models/ollama-chat-model.js +0 -34
  91. package/lib/cjs/models/open-router-chat-model.d.ts +0 -22
  92. package/lib/cjs/models/open-router-chat-model.js +0 -34
  93. package/lib/cjs/models/openai-chat-model.d.ts +0 -166
  94. package/lib/cjs/models/openai-chat-model.js +0 -415
  95. package/lib/cjs/models/xai-chat-model.d.ts +0 -21
  96. package/lib/cjs/models/xai-chat-model.js +0 -33
  97. package/lib/cjs/server/error.d.ts +0 -15
  98. package/lib/cjs/server/error.js +0 -22
  99. package/lib/cjs/server/index.d.ts +0 -2
  100. package/lib/cjs/server/index.js +0 -18
  101. package/lib/cjs/server/server.d.ts +0 -135
  102. package/lib/cjs/server/server.js +0 -187
  103. package/lib/dts/client/client.d.ts +0 -97
  104. package/lib/dts/client/index.d.ts +0 -1
  105. package/lib/dts/models/bedrock-chat-model.d.ts +0 -79
  106. package/lib/dts/models/claude-chat-model.d.ts +0 -114
  107. package/lib/dts/models/deepseek-chat-model.d.ts +0 -23
  108. package/lib/dts/models/gemini-chat-model.d.ts +0 -23
  109. package/lib/dts/models/ollama-chat-model.d.ts +0 -22
  110. package/lib/dts/models/open-router-chat-model.d.ts +0 -22
  111. package/lib/dts/models/openai-chat-model.d.ts +0 -166
  112. package/lib/dts/models/xai-chat-model.d.ts +0 -21
  113. package/lib/dts/server/error.d.ts +0 -15
  114. package/lib/dts/server/index.d.ts +0 -2
  115. package/lib/dts/server/server.d.ts +0 -135
  116. package/lib/esm/client/client.d.ts +0 -97
  117. package/lib/esm/client/client.js +0 -83
  118. package/lib/esm/client/index.d.ts +0 -1
  119. package/lib/esm/client/index.js +0 -1
  120. package/lib/esm/models/bedrock-chat-model.d.ts +0 -79
  121. package/lib/esm/models/bedrock-chat-model.js +0 -298
  122. package/lib/esm/models/claude-chat-model.d.ts +0 -114
  123. package/lib/esm/models/claude-chat-model.js +0 -310
  124. package/lib/esm/models/deepseek-chat-model.d.ts +0 -23
  125. package/lib/esm/models/deepseek-chat-model.js +0 -31
  126. package/lib/esm/models/gemini-chat-model.d.ts +0 -23
  127. package/lib/esm/models/gemini-chat-model.js +0 -31
  128. package/lib/esm/models/ollama-chat-model.d.ts +0 -22
  129. package/lib/esm/models/ollama-chat-model.js +0 -30
  130. package/lib/esm/models/open-router-chat-model.d.ts +0 -22
  131. package/lib/esm/models/open-router-chat-model.js +0 -30
  132. package/lib/esm/models/openai-chat-model.d.ts +0 -166
  133. package/lib/esm/models/openai-chat-model.js +0 -405
  134. package/lib/esm/models/xai-chat-model.d.ts +0 -21
  135. package/lib/esm/models/xai-chat-model.js +0 -29
  136. package/lib/esm/server/error.d.ts +0 -15
  137. package/lib/esm/server/error.js +0 -18
  138. package/lib/esm/server/index.d.ts +0 -2
  139. package/lib/esm/server/index.js +0 -2
  140. package/lib/esm/server/server.d.ts +0 -135
  141. package/lib/esm/server/server.js +0 -180
@@ -1,7 +1,14 @@
1
+ import type { Camelize } from "camelize-ts";
1
2
  import { z } from "zod";
2
3
  import { type Agent } from "../agents/agent.js";
3
- import type { ChatModel, ChatModelOptions } from "../models/chat-model.js";
4
+ import type { ChatModel, ChatModelOptions } from "../agents/chat-model.js";
4
5
  export interface LoadOptions {
6
+ models: {
7
+ new (parameters: {
8
+ model?: string;
9
+ modelOptions?: ChatModelOptions;
10
+ }): ChatModel;
11
+ }[];
5
12
  path: string;
6
13
  }
7
14
  export declare function load(options: LoadOptions): Promise<{
@@ -15,12 +22,12 @@ export declare function load(options: LoadOptions): Promise<{
15
22
  temperature?: number | null | undefined;
16
23
  provider?: string | null | undefined;
17
24
  top_p?: number | null | undefined;
18
- frequent_penalty?: number | null | undefined;
25
+ frequency_penalty?: number | null | undefined;
19
26
  presence_penalty?: number | null | undefined;
20
27
  } | null | undefined;
21
28
  }>;
22
29
  export declare function loadAgent(path: string): Promise<Agent>;
23
- export declare function loadModel(model?: z.infer<typeof aigneFileSchema>["chat_model"], modelOptions?: ChatModelOptions): Promise<ChatModel | undefined>;
30
+ export declare function loadModel(models: LoadOptions["models"], model?: Camelize<z.infer<typeof aigneFileSchema>["chat_model"]>, modelOptions?: ChatModelOptions): Promise<ChatModel | undefined>;
24
31
  declare const aigneFileSchema: z.ZodObject<{
25
32
  name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
26
33
  description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -29,35 +36,35 @@ declare const aigneFileSchema: z.ZodObject<{
29
36
  name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
30
37
  temperature: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
31
38
  top_p: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
32
- frequent_penalty: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
39
+ frequency_penalty: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
33
40
  presence_penalty: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
34
41
  }, "strip", z.ZodTypeAny, {
35
42
  name?: string | null | undefined;
36
43
  temperature?: number | null | undefined;
37
44
  provider?: string | null | undefined;
38
45
  top_p?: number | null | undefined;
39
- frequent_penalty?: number | null | undefined;
46
+ frequency_penalty?: number | null | undefined;
40
47
  presence_penalty?: number | null | undefined;
41
48
  }, {
42
49
  name?: string | null | undefined;
43
50
  temperature?: number | null | undefined;
44
51
  provider?: string | null | undefined;
45
52
  top_p?: number | null | undefined;
46
- frequent_penalty?: number | null | undefined;
53
+ frequency_penalty?: number | null | undefined;
47
54
  presence_penalty?: number | null | undefined;
48
55
  }>]>>>, {
49
56
  name?: string | null | undefined;
50
57
  temperature?: number | null | undefined;
51
58
  provider?: string | null | undefined;
52
59
  top_p?: number | null | undefined;
53
- frequent_penalty?: number | null | undefined;
60
+ frequency_penalty?: number | null | undefined;
54
61
  presence_penalty?: number | null | undefined;
55
62
  } | null | undefined, string | {
56
63
  name?: string | null | undefined;
57
64
  temperature?: number | null | undefined;
58
65
  provider?: string | null | undefined;
59
66
  top_p?: number | null | undefined;
60
- frequent_penalty?: number | null | undefined;
67
+ frequency_penalty?: number | null | undefined;
61
68
  presence_penalty?: number | null | undefined;
62
69
  } | null | undefined>;
63
70
  agents: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
@@ -71,7 +78,7 @@ declare const aigneFileSchema: z.ZodObject<{
71
78
  temperature?: number | null | undefined;
72
79
  provider?: string | null | undefined;
73
80
  top_p?: number | null | undefined;
74
- frequent_penalty?: number | null | undefined;
81
+ frequency_penalty?: number | null | undefined;
75
82
  presence_penalty?: number | null | undefined;
76
83
  } | null | undefined;
77
84
  agents?: string[] | null | undefined;
@@ -84,7 +91,7 @@ declare const aigneFileSchema: z.ZodObject<{
84
91
  temperature?: number | null | undefined;
85
92
  provider?: string | null | undefined;
86
93
  top_p?: number | null | undefined;
87
- frequent_penalty?: number | null | undefined;
94
+ frequency_penalty?: number | null | undefined;
88
95
  presence_penalty?: number | null | undefined;
89
96
  } | null | undefined;
90
97
  agents?: string[] | null | undefined;
@@ -98,7 +105,7 @@ export declare function loadAIGNEFile(path: string): Promise<{
98
105
  temperature?: number | null | undefined;
99
106
  provider?: string | null | undefined;
100
107
  top_p?: number | null | undefined;
101
- frequent_penalty?: number | null | undefined;
108
+ frequency_penalty?: number | null | undefined;
102
109
  presence_penalty?: number | null | undefined;
103
110
  } | null | undefined;
104
111
  agents?: string[] | null | undefined;
@@ -39,11 +39,11 @@ export declare const memoryRetrieverInputSchema: z.ZodObject<{
39
39
  limit: z.ZodOptional<z.ZodNumber>;
40
40
  search: z.ZodOptional<z.ZodString>;
41
41
  }, "strip", z.ZodTypeAny, {
42
- limit?: number | undefined;
43
42
  search?: string | undefined;
44
- }, {
45
43
  limit?: number | undefined;
44
+ }, {
46
45
  search?: string | undefined;
46
+ limit?: number | undefined;
47
47
  }>;
48
48
  /**
49
49
  * @hidden
@@ -1,9 +1,9 @@
1
1
  import type { GetPromptResult } from "@modelcontextprotocol/sdk/types.js";
2
2
  import { Agent, type Message } from "../agents/agent.js";
3
3
  import type { AIAgent } from "../agents/ai-agent.js";
4
+ import type { ChatModel, ChatModelInput } from "../agents/chat-model.js";
4
5
  import type { Context } from "../aigne/context.js";
5
6
  import type { MemoryAgent } from "../memory/memory.js";
6
- import type { ChatModel, ChatModelInput } from "../models/chat-model.js";
7
7
  import { ChatMessagesTemplate } from "./template.js";
8
8
  export declare const MESSAGE_KEY = "$message";
9
9
  export declare function createMessage<I extends Message>(message: string | I): I;
@@ -11,7 +11,7 @@ export declare function getMessage(input: Message): string | undefined;
11
11
  export interface PromptBuilderOptions {
12
12
  instructions?: string | ChatMessagesTemplate;
13
13
  }
14
- export interface PromptBuilderBuildOptions {
14
+ export interface PromptBuildOptions {
15
15
  memory?: MemoryAgent | MemoryAgent[];
16
16
  context: Context;
17
17
  agent?: AIAgent;
@@ -32,7 +32,7 @@ export declare class PromptBuilder {
32
32
  private static fromMCPPromptResult;
33
33
  constructor(options?: PromptBuilderOptions);
34
34
  instructions?: string | ChatMessagesTemplate;
35
- build(options: PromptBuilderBuildOptions): Promise<ChatModelInput & {
35
+ build(options: PromptBuildOptions): Promise<ChatModelInput & {
36
36
  toolAgents?: Agent[];
37
37
  }>;
38
38
  private buildMessages;
@@ -1,4 +1,4 @@
1
- import type { ChatModelInputMessage, ChatModelInputMessageContent, ChatModelOutputToolCall } from "../models/chat-model.js";
1
+ import type { ChatModelInputMessage, ChatModelInputMessageContent, ChatModelOutputToolCall } from "../agents/chat-model.js";
2
2
  export declare class PromptTemplate {
3
3
  template: string;
4
4
  static from(template: string): PromptTemplate;
@@ -24,7 +24,7 @@ export declare class AgentMessageTemplate extends ChatMessageTemplate {
24
24
  constructor(content?: ChatModelInputMessage["content"], toolCalls?: ChatModelOutputToolCall[] | undefined, name?: string);
25
25
  format(variables?: Record<string, unknown>): {
26
26
  toolCalls: ChatModelOutputToolCall[] | undefined;
27
- role: import("../models/chat-model.js").Role;
27
+ role: import("../agents/chat-model.js").Role;
28
28
  content?: ChatModelInputMessageContent;
29
29
  toolCallId?: string;
30
30
  name?: string;
@@ -36,7 +36,7 @@ export declare class ToolMessageTemplate extends ChatMessageTemplate {
36
36
  constructor(content: object | string, toolCallId: string, name?: string);
37
37
  format(variables?: Record<string, unknown>): {
38
38
  toolCallId: string;
39
- role: import("../models/chat-model.js").Role;
39
+ role: import("../agents/chat-model.js").Role;
40
40
  content?: ChatModelInputMessageContent;
41
41
  toolCalls?: {
42
42
  id: string;
@@ -1,8 +1,33 @@
1
- import debug from "debug";
2
- export declare const logger: debug.Debug & {
3
- debug: debug.Debug;
4
- default: debug.Debug;
5
- } & {
6
- core: debug.Debugger;
7
- mcp: debug.Debugger;
8
- };
1
+ export declare enum LogLevel {
2
+ ERROR = "error",
3
+ WARN = "warn",
4
+ INFO = "info",
5
+ DEBUG = "debug"
6
+ }
7
+ export declare class Logger {
8
+ constructor(options: {
9
+ level: LogLevel;
10
+ ns: string;
11
+ });
12
+ level: LogLevel;
13
+ private debugLogger;
14
+ private infoLogger;
15
+ private warnLogger;
16
+ private errorLogger;
17
+ logMessage: {
18
+ (...data: any[]): void;
19
+ (...data: any[]): void;
20
+ (message?: any, ...optionalParams: any[]): void;
21
+ };
22
+ logError: {
23
+ (...data: any[]): void;
24
+ (...data: any[]): void;
25
+ (message?: any, ...optionalParams: any[]): void;
26
+ };
27
+ debug(message: string, ...args: unknown[]): void;
28
+ info(message: string, ...args: unknown[]): void;
29
+ warn(message: string, ...args: unknown[]): void;
30
+ error(message: string, ...args: unknown[]): void;
31
+ enabled(level: LogLevel): boolean;
32
+ }
33
+ export declare const logger: Logger;
@@ -1,3 +1,3 @@
1
- import type { ChatModelOutputUsage } from "../models/chat-model.js";
1
+ import type { ChatModelOutputUsage } from "../agents/chat-model.js";
2
2
  import type { Nullish } from "./type-utils.js";
3
3
  export declare function mergeUsage(...usages: Nullish<ChatModelOutputUsage>[]): ChatModelOutputUsage;
@@ -6,7 +6,7 @@ export declare function mergeAgentResponseChunk<T extends Message>(output: T, ch
6
6
  export declare function agentResponseStreamToObject<T extends Message>(stream: AgentResponseStream<T> | AgentProcessAsyncGenerator<T>): Promise<T>;
7
7
  export declare function asyncGeneratorToReadableStream<T extends Message>(generator: AgentProcessAsyncGenerator<T>): AgentResponseStream<T>;
8
8
  export declare function onAgentResponseStreamEnd<T extends Message>(stream: AgentResponseStream<T>, callback: (result: T) => PromiseOrValue<Partial<T> | void>, options?: {
9
- errorCallback?: (error: Error) => Error;
9
+ errorCallback?: (error: Error) => PromiseOrValue<Error>;
10
10
  processChunk?: (chunk: AgentResponseChunk<T>) => AgentResponseChunk<T>;
11
11
  }): ReadableStream<any>;
12
12
  export declare function isAsyncGenerator<T extends AsyncGenerator>(value: AsyncGenerator | unknown): value is T;
@@ -19,3 +19,5 @@ export declare function readableStreamToArray<T>(stream: ReadableStream<T>, opti
19
19
  catchError?: false;
20
20
  }): Promise<T[]>;
21
21
  export declare function stringToAgentResponseStream(str: string, key?: "text" | typeof MESSAGE_KEY | string): AgentResponseStream<Message>;
22
+ export declare function toReadableStream(stream: NodeJS.ReadStream): ReadableStream<Uint8Array<ArrayBufferLike>>;
23
+ export declare function readAllString(stream: NodeJS.ReadStream | ReadableStream): Promise<string>;
@@ -2,6 +2,11 @@ import { type ZodType } from "zod";
2
2
  export type PromiseOrValue<T> = T | Promise<T>;
3
3
  export type Nullish<T> = T | null | undefined | void;
4
4
  export type OmitPropertiesFromArrayFirstElement<T extends unknown[], K extends string | number | symbol> = T extends [infer U, ...infer Rest] ? [Omit<U, K>, ...Rest] : never;
5
+ export type XOr<T, K extends keyof T, O extends keyof T> = (Omit<T, O> & {
6
+ [key in O]?: undefined;
7
+ }) | (Omit<T, K> & {
8
+ [key in K]?: undefined;
9
+ });
5
10
  export declare function isNil(value: unknown): value is null | undefined;
6
11
  export declare function isRecord<T>(value: unknown): value is Record<string, T>;
7
12
  export declare function isEmpty(obj: unknown): boolean;
@@ -3,7 +3,8 @@ import { ZodObject, type ZodType } from "zod";
3
3
  import type { Context } from "../aigne/context.js";
4
4
  import type { MessagePayload } from "../aigne/message-queue.js";
5
5
  import type { MemoryAgent } from "../memory/memory.js";
6
- import { type Nullish, type PromiseOrValue } from "../utils/type-utils.js";
6
+ import { type Nullish, type PromiseOrValue, type XOr } from "../utils/type-utils.js";
7
+ import type { GuideRailAgent, GuideRailAgentOutput } from "./guide-rail-agent.js";
7
8
  import { type TransferAgentOutput } from "./types.js";
8
9
  export * from "./types.js";
9
10
  /**
@@ -29,7 +30,7 @@ export type PublishTopic<O extends Message> = string | string[] | ((output: O) =
29
30
  * @template I The agent input message type
30
31
  * @template O The agent output message type
31
32
  */
32
- export interface AgentOptions<I extends Message = Message, O extends Message = Message> {
33
+ export interface AgentOptions<I extends Message = Message, O extends Message = Message> extends Partial<Pick<Agent, "guideRails" | "hooks">> {
33
34
  /**
34
35
  * Topics the agent should subscribe to
35
36
  *
@@ -139,6 +140,35 @@ export declare abstract class Agent<I extends Message = Message, O extends Messa
139
140
  * List of memories this agent can use
140
141
  */
141
142
  readonly memories: MemoryAgent[];
143
+ /**
144
+ * Lifecycle hooks for agent processing.
145
+ *
146
+ * Hooks enable tracing, logging, monitoring, and custom behavior
147
+ * without modifying the core agent implementation
148
+ *
149
+ * @example
150
+ * Here's an example of using hooks:
151
+ * {@includeCode ../../test/agents/agent.test.ts#example-agent-hooks}
152
+ */
153
+ readonly hooks: AgentHooks;
154
+ /**
155
+ * List of GuideRail agents applied to this agent
156
+ *
157
+ * GuideRail agents validate, transform, or control the message flow by:
158
+ * - Enforcing rules and safety policies
159
+ * - Validating inputs/outputs against specific criteria
160
+ * - Implementing business logic validations
161
+ * - Monitoring and auditing agent behavior
162
+ *
163
+ * Each GuideRail agent can examine both input and expected output,
164
+ * and has the ability to abort the process with an explanation
165
+ *
166
+ * @example
167
+ * Here's an example of using GuideRail agents:
168
+ *
169
+ * {@includeCode ../../test/agents/agent.test.ts#example-agent-guide-rails}
170
+ */
171
+ readonly guideRails?: GuideRailAgent[];
142
172
  /**
143
173
  * Name of the agent, used for identification and logging
144
174
  *
@@ -301,6 +331,7 @@ export declare abstract class Agent<I extends Message = Message, O extends Messa
301
331
  * @returns Agent response (streaming or regular)
302
332
  */
303
333
  invoke(input: I | string, context?: Context, options?: AgentInvokeOptions): Promise<AgentResponse<O>>;
334
+ protected invokeSkill<I extends Message, O extends Message>(skill: Agent<I, O>, input: I, context: Context): Promise<O>;
304
335
  /**
305
336
  * Process agent output
306
337
  *
@@ -319,7 +350,6 @@ export declare abstract class Agent<I extends Message = Message, O extends Messa
319
350
  *
320
351
  * @param error Caught error
321
352
  * @param context Execution context
322
- * @throws Always throws the received error
323
353
  */
324
354
  private processAgentError;
325
355
  /**
@@ -342,7 +372,25 @@ export declare abstract class Agent<I extends Message = Message, O extends Messa
342
372
  * @param _ Input message (unused)
343
373
  * @param context Execution context
344
374
  */
345
- protected preprocess(_: I, context: Context): void;
375
+ protected preprocess(_: I, context: Context): PromiseOrValue<void>;
376
+ private checkResponseByGuideRails;
377
+ private runGuideRails;
378
+ /**
379
+ * Handle errors detected by GuideRail agents
380
+ *
381
+ * This method is called when a GuideRail agent aborts the process, providing
382
+ * a way for agents to customize error handling behavior. By default, it simply
383
+ * returns the original error, but subclasses can override this method to:
384
+ * - Transform the error into a more specific response
385
+ * - Apply recovery strategies
386
+ * - Log or report the error in a custom format
387
+ * - Return a fallback output instead of an error
388
+ *
389
+ * @param error The GuideRail agent output containing abort=true and a reason
390
+ * @returns Either the original/modified error or a substitute output object
391
+ * which will be tagged with $status: "GuideRailError"
392
+ */
393
+ protected onGuideRailError(error: GuideRailAgentOutput): Promise<O | GuideRailAgentOutput>;
346
394
  /**
347
395
  * Post-processing operations after handling output
348
396
  *
@@ -354,7 +402,7 @@ export declare abstract class Agent<I extends Message = Message, O extends Messa
354
402
  * @param output Output message
355
403
  * @param context Execution context
356
404
  */
357
- protected postprocess(input: I, output: O, context: Context): void;
405
+ protected postprocess(input: I, output: O, context: Context): PromiseOrValue<void>;
358
406
  protected publishToTopics(output: Message, context: Context): Promise<void>;
359
407
  /**
360
408
  * 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
419
467
  */
420
468
  [Symbol.asyncDispose](): Promise<void>;
421
469
  }
470
+ /**
471
+ * Lifecycle hooks for agent execution
472
+ *
473
+ * Hooks provide a way to intercept and extend agent behavior at key points during
474
+ * the agent's lifecycle, enabling custom functionality like logging, monitoring,
475
+ * tracing, error handling, and more.
476
+ */
477
+ export interface AgentHooks<I extends Message = Message, O extends Message = Message> {
478
+ /**
479
+ * Called when agent processing begins
480
+ *
481
+ * This hook runs before the agent processes input, allowing for
482
+ * setup operations, logging, or input transformations.
483
+ *
484
+ * @param event Object containing the input message
485
+ */
486
+ onStart?: (event: {
487
+ input: I;
488
+ }) => PromiseOrValue<void>;
489
+ /**
490
+ * Called when agent processing completes or fails
491
+ *
492
+ * This hook runs after processing finishes, receiving either the output
493
+ * or an error if processing failed. Useful for cleanup operations,
494
+ * logging results, or error handling.
495
+ *
496
+ * @param event Object containing the input message and either output or error
497
+ */
498
+ onEnd?: (event: XOr<{
499
+ input: I;
500
+ output: O;
501
+ error: Error;
502
+ }, "output", "error">) => PromiseOrValue<void>;
503
+ /**
504
+ * Called before a skill (sub-agent) is invoked
505
+ *
506
+ * This hook runs when the agent delegates work to a skill,
507
+ * allowing for tracking skill usage or transforming input to the skill.
508
+ *
509
+ * @param event Object containing the skill being used and input message
510
+ */
511
+ onSkillStart?: (event: {
512
+ skill: Agent;
513
+ input: I;
514
+ }) => PromiseOrValue<void>;
515
+ /**
516
+ * Called after a skill (sub-agent) completes or fails
517
+ *
518
+ * This hook runs when a skill finishes execution, receiving either the output
519
+ * or an error if the skill failed. Useful for monitoring skill performance
520
+ * or handling skill-specific errors.
521
+ *
522
+ * @param event Object containing the skill used, input message, and either output or error
523
+ */
524
+ onSkillEnd?: (event: XOr<{
525
+ skill: Agent;
526
+ input: I;
527
+ output: O;
528
+ error: Error;
529
+ }, "output", "error">) => PromiseOrValue<void>;
530
+ /**
531
+ * Called when an agent hands off processing to another agent
532
+ *
533
+ * This hook runs when a source agent transfers control to a target agent,
534
+ * allowing for tracking of handoffs between agents and monitoring the flow
535
+ * of processing in multi-agent systems.
536
+ *
537
+ * @param event Object containing the source agent, target agent, and input message
538
+ */
539
+ onHandoff?: (event: {
540
+ source: Agent;
541
+ target: Agent;
542
+ input: I;
543
+ }) => PromiseOrValue<void>;
544
+ }
422
545
  /**
423
546
  * Response type for an agent, can be:
424
547
  * - Direct response object
@@ -427,7 +550,7 @@ export declare abstract class Agent<I extends Message = Message, O extends Messa
427
550
  *
428
551
  * @template T Response data type
429
552
  */
430
- export type AgentResponse<T> = T | TransferAgentOutput | AgentResponseStream<T>;
553
+ export type AgentResponse<T> = T | AgentResponseStream<T> | TransferAgentOutput | GuideRailAgentOutput;
431
554
  /**
432
555
  * Streaming response type for an agent
433
556
  *
@@ -19,6 +19,16 @@ export const agentOptionsSchema = z.object({
19
19
  skills: z.array(z.union([z.custom(), z.custom()])).optional(),
20
20
  disableEvents: z.boolean().optional(),
21
21
  memory: z.union([z.custom(), z.array(z.custom())]).optional(),
22
+ hooks: z
23
+ .object({
24
+ onStart: z.custom().optional(),
25
+ onEnd: z.custom().optional(),
26
+ onSkillStart: z.custom().optional(),
27
+ onSkillEnd: z.custom().optional(),
28
+ onHandoff: z.custom().optional(),
29
+ })
30
+ .optional(),
31
+ guideRails: z.array(z.custom()).optional(),
22
32
  });
23
33
  /**
24
34
  * Agent is the base class for all agents.
@@ -65,11 +75,42 @@ export class Agent {
65
75
  else if (options.memory) {
66
76
  this.memories.push(options.memory);
67
77
  }
78
+ this.hooks = options.hooks ?? {};
79
+ this.guideRails = options.guideRails;
68
80
  }
69
81
  /**
70
82
  * List of memories this agent can use
71
83
  */
72
84
  memories = [];
85
+ /**
86
+ * Lifecycle hooks for agent processing.
87
+ *
88
+ * Hooks enable tracing, logging, monitoring, and custom behavior
89
+ * without modifying the core agent implementation
90
+ *
91
+ * @example
92
+ * Here's an example of using hooks:
93
+ * {@includeCode ../../test/agents/agent.test.ts#example-agent-hooks}
94
+ */
95
+ hooks;
96
+ /**
97
+ * List of GuideRail agents applied to this agent
98
+ *
99
+ * GuideRail agents validate, transform, or control the message flow by:
100
+ * - Enforcing rules and safety policies
101
+ * - Validating inputs/outputs against specific criteria
102
+ * - Implementing business logic validations
103
+ * - Monitoring and auditing agent behavior
104
+ *
105
+ * Each GuideRail agent can examine both input and expected output,
106
+ * and has the ability to abort the process with an explanation
107
+ *
108
+ * @example
109
+ * Here's an example of using GuideRail agents:
110
+ *
111
+ * {@includeCode ../../test/agents/agent.test.ts#example-agent-guide-rails}
112
+ */
113
+ guideRails;
73
114
  /**
74
115
  * Name of the agent, used for identification and logging
75
116
  *
@@ -226,12 +267,13 @@ export class Agent {
226
267
  async invoke(input, context, options) {
227
268
  const ctx = context ?? (await this.newDefaultContext());
228
269
  const message = typeof input === "string" ? createMessage(input) : input;
229
- logger.core("Invoke agent %s started with input: %O", this.name, input);
270
+ logger.debug("Invoke agent %s started with input: %O", this.name, input);
230
271
  if (!this.disableEvents)
231
272
  ctx.emit("agentStarted", { agent: this, input: message });
232
273
  try {
274
+ await this.hooks.onStart?.({ input: message });
233
275
  const parsedInput = checkArguments(`Agent ${this.name} input`, this.inputSchema, message);
234
- this.preprocess(parsedInput, ctx);
276
+ await this.preprocess(parsedInput, ctx);
235
277
  this.checkContextStatus(ctx);
236
278
  let response = await this.process(parsedInput, ctx);
237
279
  if (response instanceof Agent) {
@@ -243,27 +285,34 @@ export class Agent {
243
285
  : isAsyncGenerator(response)
244
286
  ? asyncGeneratorToReadableStream(response)
245
287
  : objectToAgentResponseStream(response);
246
- return onAgentResponseStreamEnd(stream, async (result) => {
288
+ return this.checkResponseByGuideRails(message, onAgentResponseStreamEnd(stream, async (result) => {
247
289
  return await this.processAgentOutput(parsedInput, result, ctx);
248
290
  }, {
249
- errorCallback: (error) => {
250
- try {
251
- this.processAgentError(error, ctx);
252
- }
253
- catch (error) {
254
- return error;
255
- }
291
+ errorCallback: async (error) => {
292
+ return await this.processAgentError(message, error, ctx);
256
293
  },
257
- });
294
+ }), ctx);
258
295
  }
259
- return await this.processAgentOutput(parsedInput, response instanceof ReadableStream
296
+ return await this.checkResponseByGuideRails(message, this.processAgentOutput(parsedInput, response instanceof ReadableStream
260
297
  ? await agentResponseStreamToObject(response)
261
298
  : isAsyncGenerator(response)
262
299
  ? await agentResponseStreamToObject(response)
263
- : response, ctx);
300
+ : response, ctx), ctx);
264
301
  }
265
302
  catch (error) {
266
- this.processAgentError(error, ctx);
303
+ throw await this.processAgentError(message, error, ctx);
304
+ }
305
+ }
306
+ async invokeSkill(skill, input, context) {
307
+ await this.hooks.onSkillStart?.({ skill, input });
308
+ try {
309
+ const output = await context.invoke(skill, input);
310
+ await this.hooks.onSkillEnd?.({ skill, input, output });
311
+ return output;
312
+ }
313
+ catch (error) {
314
+ await this.hooks.onSkillEnd?.({ skill, input, error });
315
+ throw error;
267
316
  }
268
317
  }
269
318
  /**
@@ -279,10 +328,11 @@ export class Agent {
279
328
  async processAgentOutput(input, output, context) {
280
329
  const parsedOutput = checkArguments(`Agent ${this.name} output`, this.outputSchema, output);
281
330
  const finalOutput = this.includeInputInOutput ? { ...input, ...parsedOutput } : parsedOutput;
282
- this.postprocess(input, finalOutput, context);
283
- logger.core("Invoke agent %s succeed with output: %O", this.name, finalOutput);
331
+ await this.postprocess(input, finalOutput, context);
332
+ logger.debug("Invoke agent %s succeed with output: %O", this.name, finalOutput);
284
333
  if (!this.disableEvents)
285
334
  context.emit("agentSucceed", { agent: this, output: finalOutput });
335
+ await this.hooks.onEnd?.({ input, output: finalOutput });
286
336
  return finalOutput;
287
337
  }
288
338
  /**
@@ -292,13 +342,13 @@ export class Agent {
292
342
  *
293
343
  * @param error Caught error
294
344
  * @param context Execution context
295
- * @throws Always throws the received error
296
345
  */
297
- processAgentError(error, context) {
298
- logger.core("Invoke agent %s failed with error: %O", this.name, error);
346
+ async processAgentError(input, error, context) {
347
+ logger.error("Invoke agent %s failed with error: %O", this.name, error);
299
348
  if (!this.disableEvents)
300
349
  context.emit("agentFailed", { agent: this, error });
301
- throw error;
350
+ await this.hooks.onEnd?.({ input, error });
351
+ return error;
302
352
  }
303
353
  /**
304
354
  * Check agent invocation usage to prevent exceeding limits
@@ -330,6 +380,48 @@ export class Agent {
330
380
  this.checkContextStatus(context);
331
381
  this.checkAgentInvokesUsage(context);
332
382
  }
383
+ async checkResponseByGuideRails(input, output, context) {
384
+ if (!this.guideRails?.length)
385
+ return output;
386
+ const result = await output;
387
+ if (result instanceof ReadableStream) {
388
+ return onAgentResponseStreamEnd(result, async (result) => {
389
+ const error = await this.runGuideRails(input, result, context);
390
+ if (error) {
391
+ return {
392
+ ...(await this.onGuideRailError(error)),
393
+ $status: "GuideRailError",
394
+ };
395
+ }
396
+ });
397
+ }
398
+ const error = await this.runGuideRails(input, result, context);
399
+ if (!error)
400
+ return output;
401
+ return { ...(await this.onGuideRailError(error)), $status: "GuideRailError" };
402
+ }
403
+ async runGuideRails(input, output, context) {
404
+ const result = await Promise.all((this.guideRails ?? []).map((i) => context.invoke(i, { input, output })));
405
+ return result.find((i) => !!i.abort);
406
+ }
407
+ /**
408
+ * Handle errors detected by GuideRail agents
409
+ *
410
+ * This method is called when a GuideRail agent aborts the process, providing
411
+ * a way for agents to customize error handling behavior. By default, it simply
412
+ * returns the original error, but subclasses can override this method to:
413
+ * - Transform the error into a more specific response
414
+ * - Apply recovery strategies
415
+ * - Log or report the error in a custom format
416
+ * - Return a fallback output instead of an error
417
+ *
418
+ * @param error The GuideRail agent output containing abort=true and a reason
419
+ * @returns Either the original/modified error or a substitute output object
420
+ * which will be tagged with $status: "GuideRailError"
421
+ */
422
+ async onGuideRailError(error) {
423
+ return error;
424
+ }
333
425
  /**
334
426
  * Post-processing operations after handling output
335
427
  *
@@ -1,10 +1,10 @@
1
1
  import { type ZodObject, type ZodType, z } from "zod";
2
2
  import type { Context } from "../aigne/context.js";
3
3
  import { type DefaultMemoryOptions } from "../memory/default-memory.js";
4
- import { ChatModel } from "../models/chat-model.js";
5
- import type { ChatModelInput } from "../models/chat-model.js";
6
4
  import { PromptBuilder } from "../prompt/prompt-builder.js";
7
5
  import { Agent, type AgentOptions, type AgentProcessAsyncGenerator, type Message } from "./agent.js";
6
+ import { ChatModel, type ChatModelInput } from "./chat-model.js";
7
+ import type { GuideRailAgentOutput } from "./guide-rail-agent.js";
8
8
  /**
9
9
  * Configuration options for an AI Agent
10
10
  *
@@ -216,6 +216,7 @@ export declare class AIAgent<I extends Message = Message, O extends Message = Me
216
216
  * @protected
217
217
  */
218
218
  process(input: I, context: Context): AgentProcessAsyncGenerator<O>;
219
+ protected onGuideRailError(error: GuideRailAgentOutput): Promise<O | GuideRailAgentOutput>;
219
220
  /**
220
221
  * Process router mode requests
221
222
  *