beeai-framework 0.1.20 → 0.1.22

package/dist/agents/requirement/runner.cjs

@@ -0,0 +1,252 @@
+'use strict';
+
+var uuid = require('uuid');
+var base_cjs = require('../base.cjs');
+var message_cjs = require('../../backend/message.cjs');
+var unconstrainedMemory_cjs = require('../../memory/unconstrainedMemory.cjs');
+var counter_cjs = require('../../internals/helpers/counter.cjs');
+var llm_cjs = require('./utils/llm.cjs');
+var tool_cjs = require('./utils/tool.cjs');
+var schema_cjs = require('../../internals/helpers/schema.cjs');
+var utils_cjs = require('../../adapters/vercel/backend/utils.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+const TEMP_MESSAGE_KEY = "tempMessage";
+class RequirementAgentRunner {
+  static {
+    __name(this, "RequirementAgentRunner");
+  }
+  llm;
+  runConfig;
+  requirements;
+  toolCallCycleChecker;
+  ctx;
+  forceFinalAnswerAsTool;
+  templates;
+  state;
+  reasoner;
+  iterationErrorCounter;
+  globalErrorCounter;
+  constructor(llm, runConfig, tools, requirements, expectedOutput, toolCallCycleChecker, ctx, forceFinalAnswerAsTool, templates) {
+    this.llm = llm;
+    this.runConfig = runConfig;
+    this.requirements = requirements;
+    this.toolCallCycleChecker = toolCallCycleChecker;
+    this.ctx = ctx;
+    this.forceFinalAnswerAsTool = forceFinalAnswerAsTool;
+    this.templates = templates;
+    this.state = {
+      answer: null,
+      result: null,
+      memory: new unconstrainedMemory_cjs.UnconstrainedMemory(),
+      steps: [],
+      iteration: 0,
+      usage: {
+        totalTokens: 0,
+        promptTokens: 0,
+        completionTokens: 0,
+        reasoningTokens: 0,
+        cachedPromptTokens: void 0
+      }
+    };
+    this.requirements = requirements;
+    const finalAnswer = new tool_cjs.FinalAnswerTool(expectedOutput, this.state);
+    this.reasoner = new llm_cjs.RequirementsReasoner(tools, finalAnswer, ctx);
+    const maxRetriesPerIteration = runConfig.maxRetriesPerStep ?? 0;
+    this.iterationErrorCounter = new counter_cjs.RetryCounter(maxRetriesPerIteration, base_cjs.AgentError);
+    const maxRetries = Math.max(maxRetriesPerIteration, runConfig.totalMaxRetries ?? 0);
+    this.globalErrorCounter = new counter_cjs.RetryCounter(maxRetries, base_cjs.AgentError);
+  }
+  incrementIteration() {
+    this.state.iteration++;
+    if (this.runConfig.maxIterations && this.state.iteration > this.runConfig.maxIterations) {
+      throw new base_cjs.AgentError(`Agent was not able to resolve the task in ${this.state.iteration} iterations.`);
+    }
+  }
+  async runLLM(request) {
+    const { messages, options } = await this.prepareLLMRequest(request);
+    const response = await this.llm.create({
+      ...options,
+      messages
+    });
+    if (response.usage) {
+      utils_cjs.mergeTokenUsage(this.state.usage, response.usage);
+    }
+    return response;
+  }
+  async prepareLLMRequest(request) {
+    const messages = [
+      await llm_cjs.createSystemMessage(this.templates.system, request),
+      ...this.state.memory.messages
+    ];
+    const options = {
+      maxRetries: this.runConfig.maxRetriesPerStep,
+      tools: request.allowedTools,
+      toolChoice: request.toolChoice,
+      stream: false
+    };
+    return {
+      messages,
+      options
+    };
+  }
+  async createFinalAnswerToolCall(fullText) {
+    const parsed = schema_cjs.parseBrokenJson(fullText, {
+      pair: [
+        "{",
+        "}"
+      ]
+    });
+    if (!parsed) {
+      if (!this.reasoner.finalAnswer.customSchema) {
+        return new message_cjs.AssistantMessage([
+          {
+            type: "tool-call",
+            toolCallId: `call_${uuid.v4().substring(0, 8)}`,
+            toolName: this.reasoner.finalAnswer.name,
+            input: this.reasoner.finalAnswer.inputSchema().parse({
+              response: fullText
+            })
+          }
+        ]);
+      }
+      return null;
+    }
+    return new message_cjs.AssistantMessage([
+      {
+        type: "tool-call",
+        toolCallId: `call_${uuid.v4().substring(0, 8)}`,
+        toolName: this.reasoner.finalAnswer.name,
+        input: parsed
+      }
+    ]);
+  }
+  async createRequest(extraRules = []) {
+    return await this.reasoner.createRequest(this.state, this.forceFinalAnswerAsTool, extraRules);
+  }
+  async invokeToolCalls(tools, toolCalls) {
+    const toolResults = [];
+    const results = await Promise.all(toolCalls.map((msg) => tool_cjs.runTool(tools, msg, {
+      state: this.state
+    })));
+    for (const toolCall of results) {
+      this.state.steps.push({
+        id: uuid.v4(),
+        iteration: this.state.iteration,
+        input: toolCall.input,
+        output: toolCall.output,
+        tool: toolCall.tool,
+        error: toolCall.error
+      });
+      let result;
+      if (toolCall.error) {
+        result = this.templates.toolError.render({
+          reason: toolCall.error.explain()
+        });
+      } else {
+        result = !toolCall.output.isEmpty() ? toolCall.output.getTextContent() : this.templates.toolNoResult.render({
+          toolCall: {
+            tool: toolCall.tool,
+            input: toolCall.input
+          }
+        });
+      }
+      toolResults.push(new message_cjs.ToolMessage({
+        type: "tool-result",
+        toolName: toolCall.tool?.name || toolCall.msg.toolName,
+        toolCallId: toolCall.msg.toolCallId,
+        output: {
+          type: "text",
+          value: result
+        }
+      }));
+      if (toolCall.error) {
+        this.iterationErrorCounter.use(toolCall.error);
+        this.globalErrorCounter.use(toolCall.error);
+      }
+    }
+    return toolResults;
+  }
+  async addMessages(messages) {
+    await this.state.memory.addMany(messages);
+  }
+  async run() {
+    if (this.state.answer) {
+      return this.state;
+    }
+    await this.reasoner.update(this.requirements);
+    while (!this.state.answer) {
+      this.incrementIteration();
+      const request = await this.createRequest();
+      await this.ctx.emitter.emit("start", {
+        state: this.state,
+        request
+      });
+      const response = await this.runIteration(request);
+      await this.ctx.emitter.emit("success", {
+        state: this.state,
+        response
+      });
+    }
+    return this.state;
+  }
+  async runIteration(request) {
+    const response = await this.runLLM(request);
+    const toolCalls = response.getToolCalls();
+    if (toolCalls.length === 0) {
+      const textMessages = response.getTextMessages();
+      const text = textMessages.map((m) => m.text).join("\n");
+      if (!text || request.canStop) {
+        throw new base_cjs.AgentError("Model produced an empty response.");
+      }
+      const finalAnswerToolCall = await this.createFinalAnswerToolCall(text);
+      if (!finalAnswerToolCall) {
+        const err = new base_cjs.AgentError("Model produced an invalid final answer tool call.");
+        this.iterationErrorCounter.use(err);
+        this.globalErrorCounter.use(err);
+        await this.reasoner.update([]);
+        const updatedRequest = await this.createRequest([
+          {
+            target: this.reasoner.finalAnswer.name,
+            allowed: true,
+            hidden: false,
+            forced: false,
+            preventStop: false
+          }
+        ]);
+        this.forceFinalAnswerAsTool = true;
+        return await this.runIteration(updatedRequest);
+      }
+      await this.state.memory.add(finalAnswerToolCall);
+      toolCalls.push(...finalAnswerToolCall.getToolCalls());
+    } else {
+      await this.state.memory.addMany(response.messages);
+    }
+    for (const toolCallMsg of toolCalls) {
+      this.toolCallCycleChecker.register(toolCallMsg);
+      if (this.toolCallCycleChecker.cycleFound) {
+        this.toolCallCycleChecker.reset();
+        const updatedRequest = await this.createRequest([
+          {
+            target: toolCallMsg.toolName,
+            allowed: false,
+            hidden: false,
+            forced: true,
+            preventStop: false
+          }
+        ]);
+        return await this.runIteration(updatedRequest);
+      }
+    }
+    const toolResults = await this.invokeToolCalls(request.allowedTools, toolCalls);
+    await this.state.memory.addMany(toolResults);
+    const tempMessages = this.state.memory.messages.filter((msg) => msg.meta[TEMP_MESSAGE_KEY]);
+    await this.state.memory.deleteMany(tempMessages);
+    return response;
+  }
+}
+
+exports.RequirementAgentRunner = RequirementAgentRunner;
+//# sourceMappingURL=runner.cjs.map
+//# sourceMappingURL=runner.cjs.map

package/dist/agents/requirement/runner.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/agents/requirement/runner.ts"],"names":["TEMP_MESSAGE_KEY","RequirementAgentRunner","state","reasoner","iterationErrorCounter","globalErrorCounter","llm","runConfig","tools","requirements","expectedOutput","toolCallCycleChecker","ctx","forceFinalAnswerAsTool","templates","answer","result","memory","UnconstrainedMemory","steps","iteration","usage","totalTokens","promptTokens","completionTokens","reasoningTokens","cachedPromptTokens","undefined","finalAnswer","FinalAnswerTool","RequirementsReasoner","maxRetriesPerIteration","maxRetriesPerStep","RetryCounter","AgentError","maxRetries","Math","max","totalMaxRetries","incrementIteration","maxIterations","runLLM","request","messages","options","prepareLLMRequest","response","create","mergeTokenUsage","createSystemMessage","system","allowedTools","toolChoice","stream","createFinalAnswerToolCall","fullText","parsed","parseBrokenJson","pair","customSchema","AssistantMessage","type","toolCallId","uuidv4","substring","toolName","name","input","inputSchema","parse","createRequest","extraRules","invokeToolCalls","toolCalls","toolResults","results","Promise","all","map","msg","runTool","toolCall","push","id","output","tool","error","toolError","render","reason","explain","isEmpty","getTextContent","toolNoResult","ToolMessage","value","use","addMessages","addMany","run","update","emitter","emit","runIteration","getToolCalls","length","textMessages","getTextMessages","text","m","join","canStop","finalAnswerToolCall","err","updatedRequest","target","allowed","hidden","forced","preventStop","add","toolCallMsg","register","cycleFound","reset","tempMessages","filter","meta","deleteMany"],"mappings":";;;;;;;;;;;;;;AA6BA,MAAMA,gBAAAA,GAAmB,aAAA;AAKlB,MAAMC,sBAAAA,CAAAA;EAlCb;;;;;;;;;;AAmCqBC,EAAAA,KAAAA;AACAC,EAAAA,QAAAA;AACAC,EAAAA,qBAAAA;AACAC,EAAAA,kBAAAA;EAEnB,WAAA,CACqBC,GAAAA,EACAC,WACnBC,KAAAA,EACmBC,YAAAA,EACnBC,gBACmBC,oBAAAA,EACAC,GAAAA,EACTC,wBACSC,SAAAA,EACnB;SATmBR,GAAAA,GAAAA,GAAAA;SACAC,SAAAA,GAAAA,SAAAA;SAEAE,YAAAA,GAAAA,YAAAA;SAEAE,oBAAAA,GAAAA,oBAAAA;SACAC,GAAAA,GAAAA,GAAAA;SACTC,sBAAAA,GAAAA,sBAAAA;SACSC,SAAAA,GAAAA,SAAAA;AAEnB,IAAA,IAAA,CAAKZ,KAAAA,GAAQ;MACXa,MAAAA,EAAQ,IAAA;MACRC,MAAAA,EAAQ,IAAA;AACRC,MAAAA,MAAAA,EAAQ,IAAIC,2CAAAA,EAAAA;AACZC,MAAAA,KAAAA,EAAO,EAAA;MACPC,SAAAA,EAAW,CAAA;MACXC,KAAAA,EAAO;QACLC,WAAAA,EAAa,CAAA;QACbC,YAAAA,EAAc,CAAA;QACdC,gBAAAA,EAAkB,CAAA;QAClBC,eAAAA,EAAiB,CAAA;QACjBC,kBAAAA,EAAoBC;AACtB;AACF,KAAA;AAEA,IAAA,IAAA,CAAKlB,YAAAA,GAAeA,YAAAA;AACpB,IAAA,MAAMmB,WAAAA,GAAc,IAAIC,wBAAAA,CAAgBnB,cAAAA,EAAgB,KAAKR,KAAK,CAAA;AAClE,IAAA,IAAA,CAAKC,QAAAA,GAAW,IAAI2B,4BAAAA,CAAqBtB,KAAAA,EAAOoB,aAAahB,GAAAA,CAAAA;AAE7D,IAAA,MAAMmB,sBAAAA,GAAyBxB,UAAUyB,iBAAAA,IAAqB,CAAA;AAC9D,IAAA,IAAA,CAAK5B,qBAAAA,GAAwB,IAAI6B,wBAAAA,CAAaF,sBAAAA,EAAwBG,mBAAAA,CAAAA;AAEtE,IAAA,MAAMC,aAAaC,IAAAA,CAAKC,GAAAA,CAAIN,sBAAAA,EAAwBxB,SAAAA,CAAU+B,mBAAmB,CAAA,CAAA;AACjF,IAAA,IAAA,CAAKjC,kBAAAA,GAAqB,IAAI4B,wBAAAA,CAAaE,UAAAA,EAAYD,mBAAAA,CAAAA;AACzD;EAEUK,kBAAAA,GAA2B;AACnC,IAAA,IAAA,CAAKrC,KAAAA,CAAMkB,SAAAA,EAAAA;AAEX,IAAA,IAAI,IAAA,CAAKb,UAAUiC,aAAAA,IAAiB,IAAA,CAAKtC,MAAMkB,SAAAA,GAAY,IAAA,CAAKb,UAAUiC,aAAAA,EAAe;AACvF,MAAA,MAAM,IAAIN,mBAAAA,CACR,CAAA,0CAAA,EAA6C,IAAA,CAAKhC,KAAAA,CAAMkB,SAAS,CAAA,YAAA,CAAc,CAAA;AAEnF;AACF;AAEA,EAAA,MAAgBqB,OAAOC,OAAAA,EAA4D;AACjF,IAAA,MAAM,EAAEC,QAAAA,EAAUC,OAAAA,KAAY,MAAM,IAAA,CAAKC,kBAAkBH,OAAAA,CAAAA;AAC3D,IAAA,MAAMI,QAAAA,GAAW,MAAM,IAAA,CAAKxC,GAAAA,CAAIyC,MAAAA,CAAO;MAAE,GAAGH,OAAAA;AAASD,MAAAA;KAAS,CAAA;AAE9D,IAAA,IAAIG,SAASzB,KAAAA,EAAO;AAClB2B,MAAAA,yBAAAA,CAAgB,IAAA,CAAK9C,KAAAA,CAAMmB,KAAAA,EAAOyB,QAAAA,CAASzB,KAAK,CAAA;AAClD;AAEA,IAAA,OAAOyB,QAAAA;AACT;AAEA,EAAA,MAAgBD,kBAAkBH,OAAAA,EAAkC;AAClE,IAAA,MAAMC,QAAAA,GAAsB;AAC1B,MAAA,MAAMM,2BAAAA,CAAoB,IAAA,CAAKnC,SAAAA,CAAUoC,MAAAA,EAAQR,OAAAA,CAAAA;AAC9C,MAAA,GAAA,IAAA,CAAKxC,MAAMe,MAAAA,CAAO0B;;AAGvB,IAAA,MAAMC,OAAAA,GAAU;AACdT,MAAAA,UAAAA,EAAY,KAAK5B,SAAAA,CAAUyB,iBAAAA;AAC3BxB,MAAAA,KAAAA,EAAOkC,OAAAA,CAAQS,YAAAA;AACfC,MAAAA,UAAAA,EAAYV,OAAAA,CAAQU,UAAAA;MACpBC,MAAAA,EAAQ;AACV,KAAA;AAEA,IAAA,OAAO;AAAEV,MAAAA,QAAAA;AAAUC,MAAAA;AAAQ,KAAA;AAC7B;AAEA,EAAA,MAAgBU,0BAA0BC,QAAAA,EAAoD;AAE5F,IAAA,MAAMC,MAAAA,GAASC,2BAAgBF,QAAAA,EAAU;MAAEG,IAAAA,EAAM;AAAC,QAAA,GAAA;AAAK,QAAA;;KAAK,CAAA;AAC5D,IAAA,IAAI,CAACF,MAAAA,EAAQ;AAEX,MAAA,IAAI,CAAC,IAAA,CAAKrD,QAAAA,CAASyB,WAAAA,CAAY+B,YAAAA,EAAc;AAC3C,QAAA,OAAO,IAAIC,4BAAAA,CAAiB;AAC1B,UAAA;YACEC,IAAAA,EAAM,WAAA;AACNC,YAAAA,UAAAA,EAAY,QAAQC,OAAAA,EAAAA,CAASC,SAAAA,CAAU,CAAA,EAAG,CAAA,CAAA,CAAA,CAAA;YAC1CC,QAAAA,EAAU,IAAA,CAAK9D,SAASyB,WAAAA,CAAYsC,IAAAA;AACpCC,YAAAA,KAAAA,EAAO,IAAA,CAAKhE,QAAAA,CAASyB,WAAAA,CAAYwC,WAAAA,GAAcC,KAAAA,CAAM;cAAEvB,QAAAA,EAAUS;aAAS;AAC5E;AACD,SAAA,CAAA;AACH;AACA,MAAA,OAAO,IAAA;AACT;AAEA,IAAA,OAAO,IAAIK,4BAAAA,CAAiB;AAC1B,MAAA;QACEC,IAAAA,EAAM,WAAA;AACNC,QAAAA,UAAAA,EAAY,QAAQC,OAAAA,EAAAA,CAASC,SAAAA,CAAU,CAAA,EAAG,CAAA,CAAA,CAAA,CAAA;QAC1CC,QAAAA,EAAU,IAAA,CAAK9D,SAASyB,WAAAA,CAAYsC,IAAAA;QACpCC,KAAAA,EAAOX;AACT;AACD,KAAA,CAAA;AACH;EAEA,MAAgBc,aAAAA,CAAcC,UAAAA,GAAqB,EAAA,EAAsC;AACvF,IAAA,OAAO,MAAM,KAAKpE,QAAAA,CAASmE,aAAAA,CAAc,KAAKpE,KAAAA,EAAO,IAAA,CAAKW,wBAAwB0D,UAAAA,CAAAA;AACpF;EAEA,MAAgBC,eAAAA,CACdhE,OACAiE,SAAAA,EACwB;AACxB,IAAA,MAAMC,cAA6B,EAAA;AAEnC,IAAA,MAAMC,OAAAA,GAAU,MAAMC,OAAAA,CAAQC,GAAAA,CAC5BJ,SAAAA,CAAUK,IAAI,CAACC,GAAAA,KAAQC,gBAAAA,CAAQxE,KAAAA,EAAOuE,GAAAA,EAAK;AAAE7E,MAAAA,KAAAA,EAAO,IAAA,CAAKA;AAAM,KAAA,CAAA,CAAA,CAAA;AAGjE,IAAA,KAAA,MAAW+E,YAAYN,OAAAA,EAAS;AAC9B,MAAA,IAAA,CAAKzE,KAAAA,CAAMiB,MAAM+D,IAAAA,CAAK;AACpBC,QAAAA,EAAAA,EAAIpB,OAAAA,EAAAA;AACJ3C,QAAAA,SAAAA,EAAW,KAAKlB,KAAAA,CAAMkB,SAAAA;AACtB+C,QAAAA,KAAAA,EAAOc,QAAAA,CAASd,KAAAA;AAChBiB,QAAAA,MAAAA,EAAQH,QAAAA,CAASG,MAAAA;AACjBC,QAAAA,IAAAA,EAAMJ,QAAAA,CAASI,IAAAA;AACfC,QAAAA,KAAAA,EAAOL,QAAAA,CAASK;OAClB,CAAA;AAEA,MAAA,IAAItE,MAAAA;AACJ,MAAA,IAAIiE,SAASK,KAAAA,EAAO;AAClBtE,QAAAA,MAAAA,GAAS,IAAA,CAAKF,SAAAA,CAAUyE,SAAAA,CAAUC,MAAAA,CAAO;UACvCC,MAAAA,EAAQR,QAAAA,CAASK,MAAMI,OAAAA;SACzB,CAAA;OACF,MAAO;AACL1E,QAAAA,MAAAA,GAAS,CAACiE,QAAAA,CAASG,MAAAA,CAAOO,OAAAA,EAAO,GAC7BV,QAAAA,CAASG,MAAAA,CAAOQ,cAAAA,EAAc,GAC9B,IAAA,CAAK9E,SAAAA,CAAU+E,YAAAA,CAAaL,MAAAA,CAAO;UACjCP,QAAAA,EAAU;AAAEI,YAAAA,IAAAA,EAAMJ,QAAAA,CAASI,IAAAA;AAAMlB,YAAAA,KAAAA,EAAOc,QAAAA,CAASd;AAAM;SACzD,CAAA;AACN;AAEAO,MAAAA,WAAAA,CAAYQ,IAAAA,CACV,IAAIY,uBAAAA,CAAY;QACdjC,IAAAA,EAAM,aAAA;AACNI,QAAAA,QAAAA,EAAUgB,QAAAA,CAASI,IAAAA,EAAMnB,IAAAA,IAAQe,QAAAA,CAASF,GAAAA,CAAId,QAAAA;AAC9CH,QAAAA,UAAAA,EAAYmB,SAASF,GAAAA,CAAIjB,UAAAA;QACzBsB,MAAAA,EAAQ;UAAEvB,IAAAA,EAAM,MAAA;UAAQkC,KAAAA,EAAO/E;AAAO;AACxC,OAAA,CAAA,CAAA;AAGF,MAAA,IAAIiE,SAASK,KAAAA,EAAO;AAClB,QAAA,IAAA,CAAKlF,qBAAAA,CAAsB4F,GAAAA,CAAIf,QAAAA,CAASK,KAAK,CAAA;AAC7C,QAAA,IAAA,CAAKjF,kBAAAA,CAAmB2F,GAAAA,CAAIf,QAAAA,CAASK,KAAK,CAAA;AAC5C;AACF;AAEA,IAAA,OAAOZ,WAAAA;AACT;AAEA,EAAA,MAAMuB,YAAYtD,QAAAA,EAAoC;AACpD,IAAA,MAAM,IAAA,CAAKzC,KAAAA,CAAMe,MAAAA,CAAOiF,OAAAA,CAAQvD,QAAAA,CAAAA;AAClC;AAEA,EAAA,MAAMwD,GAAAA,GAAyC;AAC7C,IAAA,IAAI,IAAA,CAAKjG,MAAMa,MAAAA,EAAQ;AACrB,MAAA,OAAO,IAAA,CAAKb,KAAAA;AACd;AAGA,IAAA,MAAM,IAAA,CAAKC,QAAAA,CAASiG,MAAAA,CAAO,IAAA,CAAK3F,YAAY,CAAA;AAE5C,IAAA,OAAO,CAAC,IAAA,CAAKP,KAAAA,CAAMa,MAAAA,EAAQ;AACzB,MAAA,IAAA,CAAKwB,kBAAAA,EAAkB;AAEvB,MAAA,MAAMG,OAAAA,GAAU,MAAM,IAAA,CAAK4B,aAAAA,EAAa;AACxC,MAAA,MAAM,IAAA,CAAK1D,GAAAA,CAAIyF,OAAAA,CAAQC,IAAAA,CAAK,OAAA,EAAS;AAAEpG,QAAAA,KAAAA,EAAO,IAAA,CAAKA,KAAAA;AAAOwC,QAAAA;OAAQ,CAAA;AAClE,MAAA,MAAMI,QAAAA,GAAW,MAAM,IAAA,CAAKyD,YAAAA,CAAa7D,OAAAA,CAAAA;AACzC,MAAA,MAAM,IAAA,CAAK9B,GAAAA,CAAIyF,OAAAA,CAAQC,IAAAA,CAAK,SAAA,EAAW;AAAEpG,QAAAA,KAAAA,EAAO,IAAA,CAAKA,KAAAA;AAAO4C,QAAAA;OAAS,CAAA;AACvE;AAEA,IAAA,OAAO,IAAA,CAAK5C,KAAAA;AACd;AAEA,EAAA,MAAgBqG,aAAa7D,OAAAA,EAA4D;AACvF,IAAA,MAAMI,QAAAA,GAAW,MAAM,IAAA,CAAKL,MAAAA,CAAOC,OAAAA,CAAAA;AAGnC,IAAA,MAAM+B,SAAAA,GAAY3B,SAAS0D,YAAAA,EAAY;AACvC,IAAA,IAAI/B,SAAAA,CAAUgC,WAAW,CAAA,EAAG;AAC1B,MAAA,MAAMC,YAAAA,GAAe5D,SAAS6D,eAAAA,EAAe;AAC7C,MAAA,MAAMC,IAAAA,GAAOF,aAAa5B,GAAAA,CAAI,CAAC+B,MAAMA,CAAAA,CAAED,IAAI,CAAA,CAAEE,IAAAA,CAAK,IAAA,CAAA;AAElD,MAAA,IAAI,CAACF,IAAAA,IAAQlE,OAAAA,CAAQqE,OAAAA,EAAS;AAC5B,QAAA,MAAM,IAAI7E,oBAAW,mCAAA,CAAA;AACvB;AAEA,MAAA,MAAM8E,mBAAAA,GAAsB,MAAM,IAAA,CAAK1D,yBAAAA,CAA0BsD,IAAAA,CAAAA;AACjE,MAAA,IAAI,CAACI,mBAAAA,EAAqB;AACxB,QAAA,MAAMC,GAAAA,GAAM,IAAI/E,mBAAAA,CAAW,mDAAA,CAAA;AAC3B,QAAA,IAAA,CAAK9B,qBAAAA,CAAsB4F,IAAIiB,GAAAA,CAAAA;AAC/B,QAAA,IAAA,CAAK5G,kBAAAA,CAAmB2F,IAAIiB,GAAAA,CAAAA;AAE5B,QAAA,MAAM,IAAA,CAAK9G,QAAAA,CAASiG,MAAAA,CAAO,EAAE,CAAA;AAC7B,QAAA,MAAMc,cAAAA,GAAiB,MAAM,IAAA,CAAK5C,aAAAA,CAAc;AAC9C,UAAA;YACE6C,MAAAA,EAAQ,IAAA,CAAKhH,SAASyB,WAAAA,CAAYsC,IAAAA;YAClCkD,OAAAA,EAAS,IAAA;YACTC,MAAAA,EAAQ,KAAA;YACRC,MAAAA,EAAQ,KAAA;YACRC,WAAAA,EAAa;AACf;AACD,SAAA,CAAA;AACD,QAAA,IAAA,CAAK1G,sBAAAA,GAAyB,IAAA;AAC9B,QAAA,OAAO,MAAM,IAAA,CAAK0F,YAAAA,CAAaW,cAAAA,CAAAA;AACjC;AAEA,MAAA,MAAM,IAAA,CAAKhH,KAAAA,CAAMe,MAAAA,CAAOuG,GAAAA,CAAIR,mBAAAA,CAAAA;AAC5BvC,MAAAA,SAAAA,CAAUS,IAAAA,CAAI,GAAI8B,mBAAAA,CAAoBR,YAAAA,EAAY,CAAA;KACpD,MAAO;AACL,MAAA,MAAM,IAAA,CAAKtG,KAAAA,CAAMe,MAAAA,CAAOiF,OAAAA,CAAQpD,SAASH,QAAQ,CAAA;AACnD;AAGA,IAAA,KAAA,MAAW8E,eAAehD,SAAAA,EAAW;AACnC,MAAA,IAAA,CAAK9D,oBAAAA,CAAqB+G,SAASD,WAAAA,CAAAA;AACnC,MAAA,IAAI,IAAA,CAAK9G,qBAAqBgH,UAAAA,EAAY;AACxC,QAAA,IAAA,CAAKhH,qBAAqBiH,KAAAA,EAAK;AAC/B,QAAA,MAAMV,cAAAA,GAAiB,MAAM,IAAA,CAAK5C,aAAAA,CAAc;AAC9C,UAAA;AACE6C,YAAAA,MAAAA,EAAQM,WAAAA,CAAYxD,QAAAA;YACpBmD,OAAAA,EAAS,KAAA;YACTC,MAAAA,EAAQ,KAAA;YACRC,MAAAA,EAAQ,IAAA;YACRC,WAAAA,EAAa;AACf;AACD,SAAA,CAAA;AACD,QAAA,OAAO,MAAM,IAAA,CAAKhB,YAAAA,CAAaW,cAAAA,CAAAA;AACjC;AACF;AAEA,IAAA,MAAMxC,cAAc,MAAM,IAAA,CAAKF,eAAAA,CAAgB9B,OAAAA,CAAQS,cAAcsB,SAAAA,CAAAA;AACrE,IAAA,MAAM,IAAA,CAAKvE,KAAAA,CAAMe,MAAAA,CAAOiF,OAAAA,CAAQxB,WAAAA,CAAAA;AAGhC,IAAA,MAAMmD,YAAAA,GAAe,IAAA,CAAK3H,KAAAA,CAAMe,MAAAA,CAAO0B,QAAAA,CAASmF,MAAAA,CAAO,CAAC/C,GAAAA,KAAQA,GAAAA,CAAIgD,IAAAA,CAAK/H,gBAAAA,CAAiB,CAAA;AAC1F,IAAA,MAAM,IAAA,CAAKE,KAAAA,CAAMe,MAAAA,CAAO+G,UAAAA,CAAWH,YAAAA,CAAAA;AAEnC,IAAA,OAAO/E,QAAAA;AACT;AACF","file":"runner.cjs","sourcesContent":["/**\n * Copyright 2025 © BeeAI a Series of LF Projects, LLC\n * SPDX-License-Identifier: Apache-2.0\n */\n\nimport { v4 as uuidv4 } from \"uuid\";\nimport { AgentError } from \"@/agents/base.js\";\nimport { ChatModel, ChatModelOutput } from \"@/backend/chat.js\";\nimport { AssistantMessage, Message, ToolMessage } from \"@/backend/message.js\";\nimport { ToolCallPart } from \"ai\";\nimport { AnyTool } from \"@/tools/base.js\";\nimport { UnconstrainedMemory } from \"@/memory/unconstrainedMemory.js\";\nimport { RetryCounter } from \"@/internals/helpers/counter.js\";\nimport { RunContext } from \"@/context.js\";\nimport {\n  RequirementAgentExecutionConfig,\n  RequirementAgentRequest,\n  RequirementAgentRunState,\n  RequirementAgentTemplates,\n} from \"./types.js\";\nimport { Requirement, Rule } from \"./requirements/requirement.js\";\nimport { RequirementsReasoner, createSystemMessage } from \"./utils/llm.js\";\nimport { FinalAnswerTool, runTool } from \"./utils/tool.js\";\nimport { ToolCallChecker } from \"./utils/toolCallChecker.js\";\nimport { z } from \"zod\";\nimport { parseBrokenJson } from \"@/internals/helpers/schema.js\";\nimport { RequirementAgent } from \"@/agents/requirement/agent.js\";\nimport { mergeTokenUsage } from \"@/adapters/vercel/backend/utils.js\";\n\nconst TEMP_MESSAGE_KEY = \"tempMessage\";\n\n/**\n * Runner for RequirementAgent execution\n */\nexport class RequirementAgentRunner {\n  protected readonly state: RequirementAgentRunState;\n  protected readonly reasoner: RequirementsReasoner;\n  protected readonly iterationErrorCounter: RetryCounter;\n  protected readonly globalErrorCounter: RetryCounter;\n\n  constructor(\n    protected readonly llm: ChatModel,\n    protected readonly runConfig: RequirementAgentExecutionConfig,\n    tools: AnyTool[],\n    protected readonly requirements: Requirement[],\n    expectedOutput: string | z.ZodSchema | null,\n    protected readonly toolCallCycleChecker: ToolCallChecker,\n    protected readonly ctx: RunContext<RequirementAgent>,\n    protected forceFinalAnswerAsTool: boolean,\n    protected readonly templates: RequirementAgentTemplates,\n  ) {\n    this.state = {\n      answer: null,\n      result: null,\n      memory: new UnconstrainedMemory(),\n      steps: [],\n      iteration: 0,\n      usage: {\n        totalTokens: 0,\n        promptTokens: 0,\n        completionTokens: 0,\n        reasoningTokens: 0,\n        cachedPromptTokens: undefined,\n      },\n    };\n\n    this.requirements = requirements;\n    const finalAnswer = new FinalAnswerTool(expectedOutput, this.state);\n    this.reasoner = new RequirementsReasoner(tools, finalAnswer, ctx);\n\n    const maxRetriesPerIteration = runConfig.maxRetriesPerStep ?? 0;\n    this.iterationErrorCounter = new RetryCounter(maxRetriesPerIteration, AgentError);\n\n    const maxRetries = Math.max(maxRetriesPerIteration, runConfig.totalMaxRetries ?? 0);\n    this.globalErrorCounter = new RetryCounter(maxRetries, AgentError);\n  }\n\n  protected incrementIteration(): void {\n    this.state.iteration++;\n\n    if (this.runConfig.maxIterations && this.state.iteration > this.runConfig.maxIterations) {\n      throw new AgentError(\n        `Agent was not able to resolve the task in ${this.state.iteration} iterations.`,\n      );\n    }\n  }\n\n  protected async runLLM(request: RequirementAgentRequest): Promise<ChatModelOutput> {\n    const { messages, options } = await this.prepareLLMRequest(request);\n    const response = await this.llm.create({ ...options, messages });\n\n    if (response.usage) {\n      mergeTokenUsage(this.state.usage, response.usage);\n    }\n\n    return response;\n  }\n\n  protected async prepareLLMRequest(request: RequirementAgentRequest) {\n    const messages: Message[] = [\n      await createSystemMessage(this.templates.system, request),\n      ...this.state.memory.messages,\n    ];\n\n    const options = {\n      maxRetries: this.runConfig.maxRetriesPerStep,\n      tools: request.allowedTools,\n      toolChoice: request.toolChoice,\n      stream: false,\n    };\n\n    return { messages, options };\n  }\n\n  protected async createFinalAnswerToolCall(fullText: string): Promise<AssistantMessage | null> {\n    // Try to extract JSON from text\n    const parsed = parseBrokenJson(fullText, { pair: [\"{\", \"}\"] });\n    if (!parsed) {\n      // If no JSON and no custom schema, wrap in default schema\n      if (!this.reasoner.finalAnswer.customSchema) {\n        return new AssistantMessage([\n          {\n            type: \"tool-call\",\n            toolCallId: `call_${uuidv4().substring(0, 8)}`,\n            toolName: this.reasoner.finalAnswer.name,\n            input: this.reasoner.finalAnswer.inputSchema().parse({ response: fullText }),\n          },\n        ]);\n      }\n      return null;\n    }\n\n    return new AssistantMessage([\n      {\n        type: \"tool-call\",\n        toolCallId: `call_${uuidv4().substring(0, 8)}`,\n        toolName: this.reasoner.finalAnswer.name,\n        input: parsed,\n      },\n    ]);\n  }\n\n  protected async createRequest(extraRules: Rule[] = []): Promise<RequirementAgentRequest> {\n    return await this.reasoner.createRequest(this.state, this.forceFinalAnswerAsTool, extraRules);\n  }\n\n  protected async invokeToolCalls(\n    tools: AnyTool[],\n    toolCalls: ToolCallPart[],\n  ): Promise<ToolMessage[]> {\n    const toolResults: ToolMessage[] = [];\n\n    const results = await Promise.all(\n      toolCalls.map((msg) => runTool(tools, msg, { state: this.state })),\n    );\n\n    for (const toolCall of results) {\n      this.state.steps.push({\n        id: uuidv4(),\n        iteration: this.state.iteration,\n        input: toolCall.input,\n        output: toolCall.output,\n        tool: toolCall.tool,\n        error: toolCall.error,\n      });\n\n      let result: string;\n      if (toolCall.error) {\n        result = this.templates.toolError.render({\n          reason: toolCall.error.explain(),\n        });\n      } else {\n        result = !toolCall.output.isEmpty()\n          ? toolCall.output.getTextContent()\n          : this.templates.toolNoResult.render({\n              toolCall: { tool: toolCall.tool, input: toolCall.input },\n            });\n      }\n\n      toolResults.push(\n        new ToolMessage({\n          type: \"tool-result\",\n          toolName: toolCall.tool?.name || toolCall.msg.toolName,\n          toolCallId: toolCall.msg.toolCallId,\n          output: { type: \"text\", value: result },\n        }),\n      );\n\n      if (toolCall.error) {\n        this.iterationErrorCounter.use(toolCall.error);\n        this.globalErrorCounter.use(toolCall.error);\n      }\n    }\n\n    return toolResults;\n  }\n\n  async addMessages(messages: Message[]): Promise<void> {\n    await this.state.memory.addMany(messages);\n  }\n\n  async run(): Promise<RequirementAgentRunState> {\n    if (this.state.answer) {\n      return this.state;\n    }\n\n    // Initialize requirements\n    await this.reasoner.update(this.requirements);\n\n    while (!this.state.answer) {\n      this.incrementIteration();\n\n      const request = await this.createRequest();\n      await this.ctx.emitter.emit(\"start\", { state: this.state, request });\n      const response = await this.runIteration(request);\n      await this.ctx.emitter.emit(\"success\", { state: this.state, response });\n    }\n\n    return this.state;\n  }\n\n  protected async runIteration(request: RequirementAgentRequest): Promise<ChatModelOutput> {\n    const response = await this.runLLM(request);\n\n    // Try to cast text message to final answer tool call if allowed\n    const toolCalls = response.getToolCalls();\n    if (toolCalls.length === 0) {\n      const textMessages = response.getTextMessages();\n      const text = textMessages.map((m) => m.text).join(\"\\n\");\n\n      if (!text || request.canStop) {\n        throw new AgentError(\"Model produced an empty response.\");\n      }\n\n      const finalAnswerToolCall = await this.createFinalAnswerToolCall(text);\n      if (!finalAnswerToolCall) {\n        const err = new AgentError(\"Model produced an invalid final answer tool call.\");\n        this.iterationErrorCounter.use(err);\n        this.globalErrorCounter.use(err);\n\n        await this.reasoner.update([]);\n        const updatedRequest = await this.createRequest([\n          {\n            target: this.reasoner.finalAnswer.name,\n            allowed: true,\n            hidden: false,\n            forced: false,\n            preventStop: false,\n          },\n        ]);\n        this.forceFinalAnswerAsTool = true;\n        return await this.runIteration(updatedRequest);\n      }\n\n      await this.state.memory.add(finalAnswerToolCall);\n      toolCalls.push(...finalAnswerToolCall.getToolCalls());\n    } else {\n      await this.state.memory.addMany(response.messages);\n    }\n\n    // Check for cycles\n    for (const toolCallMsg of toolCalls) {\n      this.toolCallCycleChecker.register(toolCallMsg);\n      if (this.toolCallCycleChecker.cycleFound) {\n        this.toolCallCycleChecker.reset();\n        const updatedRequest = await this.createRequest([\n          {\n            target: toolCallMsg.toolName,\n            allowed: false,\n            hidden: false,\n            forced: true,\n            preventStop: false,\n          },\n        ]);\n        return await this.runIteration(updatedRequest);\n      }\n    }\n\n    const toolResults = await this.invokeToolCalls(request.allowedTools, toolCalls);\n    await this.state.memory.addMany(toolResults);\n\n    // Delete temporary messages\n    const tempMessages = this.state.memory.messages.filter((msg) => msg.meta[TEMP_MESSAGE_KEY]);\n    await this.state.memory.deleteMany(tempMessages);\n\n    return response;\n  }\n}\n"]}

package/dist/agents/requirement/runner.d.cts

@@ -0,0 +1,117 @@
+import { RunContext, MiddlewareType, GetRunContext } from '../../context.cjs';
+import * as zod from 'zod';
+import { z } from 'zod';
+import { a as BaseAgent, b as AgentMeta } from '../../base-v-PYIq5G.cjs';
+import { AnyTool } from '../../tools/base.cjs';
+import { BaseMemory } from '../../memory/base.cjs';
+import { E as Emitter } from '../../emitter-CGKd_-kK.cjs';
+import { m as ChatModel, n as ChatModelOutput, c as ChatModelToolChoice } from '../../chat-DB_cf15S.cjs';
+import { Message, MessageContentPart, AssistantMessage, ToolMessage } from '../../backend/message.cjs';
+import { c as RequirementAgentExecutionConfig, d as RequirementAgentTemplates, R as RequirementAgentRunState, a as RequirementAgentRequest, e as RequirementAgentRunInput, f as RequirementAgentOutput, g as RequirementAgentRunOptions, h as RequirementAgentCallbacks } from '../../types-Cx6f43du.cjs';
+import { Requirement, Rule } from './requirements/requirement.cjs';
+import { ToolCallPart } from 'ai';
+import { RetryCounter } from '../../internals/helpers/counter.cjs';
+import { RequirementsReasoner } from './utils/llm.cjs';
+import { ToolCallChecker, ToolCallCheckerConfig } from './utils/toolCallChecker.cjs';
+import { RequiredExcept } from '../../internals/types.cjs';
+import '../../internals/serializable.cjs';
+import '../../internals/helpers/guards.cjs';
+import '../../internals/helpers/promise.cjs';
+import '../../errors.cjs';
+import 'ajv';
+import 'promise-based-task';
+import '../../cache/base.cjs';
+import '../../internals/helpers/schema.cjs';
+import 'zod-to-json-schema';
+import '../../backend/constants.cjs';
+import '../../template.cjs';
+import '../../logger/logger.cjs';
+import 'pino';
+
+/**
+ * Runner for RequirementAgent execution
+ */
+declare class RequirementAgentRunner {
+    protected readonly llm: ChatModel;
+    protected readonly runConfig: RequirementAgentExecutionConfig;
+    protected readonly requirements: Requirement[];
+    protected readonly toolCallCycleChecker: ToolCallChecker;
+    protected readonly ctx: RunContext<RequirementAgent>;
+    protected forceFinalAnswerAsTool: boolean;
+    protected readonly templates: RequirementAgentTemplates;
+    protected readonly state: RequirementAgentRunState;
+    protected readonly reasoner: RequirementsReasoner;
+    protected readonly iterationErrorCounter: RetryCounter;
+    protected readonly globalErrorCounter: RetryCounter;
+    constructor(llm: ChatModel, runConfig: RequirementAgentExecutionConfig, tools: AnyTool[], requirements: Requirement[], expectedOutput: string | z.ZodSchema | null, toolCallCycleChecker: ToolCallChecker, ctx: RunContext<RequirementAgent>, forceFinalAnswerAsTool: boolean, templates: RequirementAgentTemplates);
+    protected incrementIteration(): void;
+    protected runLLM(request: RequirementAgentRequest): Promise<ChatModelOutput>;
+    protected prepareLLMRequest(request: RequirementAgentRequest): Promise<{
+        messages: Message<MessageContentPart, string>[];
+        options: {
+            maxRetries: number | undefined;
+            tools: AnyTool[];
+            toolChoice: ChatModelToolChoice;
+            stream: boolean;
+        };
+    }>;
+    protected createFinalAnswerToolCall(fullText: string): Promise<AssistantMessage | null>;
+    protected createRequest(extraRules?: Rule[]): Promise<RequirementAgentRequest>;
+    protected invokeToolCalls(tools: AnyTool[], toolCalls: ToolCallPart[]): Promise<ToolMessage[]>;
+    addMessages(messages: Message[]): Promise<void>;
+    run(): Promise<RequirementAgentRunState>;
+    protected runIteration(request: RequirementAgentRequest): Promise<ChatModelOutput>;
+}
+
+type RequirementAgentTemplateFactory<K extends keyof RequirementAgentTemplates> = (template: RequirementAgentTemplates[K]) => RequirementAgentTemplates[K];
+interface RequirementAgentInput {
+    llm: ChatModel;
+    memory?: BaseMemory;
+    tools?: AnyTool[];
+    requirements?: Requirement[];
+    name?: string;
+    description?: string;
+    role?: string;
+    instructions?: string | string[];
+    notes?: string | string[];
+    toolCallChecker?: boolean | ToolCallCheckerConfig;
+    finalAnswerAsTool?: boolean;
+    saveIntermediateSteps?: boolean;
+    execution?: RequirementAgentExecutionConfig;
+    templates?: Partial<{
+        [K in keyof RequirementAgentTemplates]: RequirementAgentTemplates[K] | RequirementAgentTemplateFactory<K>;
+    }>;
+    middlewares?: MiddlewareType<RequirementAgent>[];
+}
+type InternalRequirementAgentInput = RequiredExcept<RequirementAgentInput, "role" | "instructions" | "name" | "description" | "templates" | "notes" | "execution" | "middlewares">;
+/**
+ * RequirementAgent - A declarative AI agent with rule-based constraints
+ *
+ * The RequirementAgent provides predictable, controlled execution behavior across
+ * different language models through rule-based constraints (Requirements).
+ * Requirements can be configured as strict or flexible as necessary, adapting to
+ * task requirements while ensuring consistent execution regardless of the underlying
+ * model's reasoning or tool-calling capabilities.
+ */
+declare class RequirementAgent extends BaseAgent<RequirementAgentRunInput, RequirementAgentOutput, RequirementAgentRunOptions> {
+    readonly emitter: Emitter<RequirementAgentCallbacks>;
+    protected readonly input: InternalRequirementAgentInput;
+    protected runner: new (...args: ConstructorParameters<typeof RequirementAgentRunner>) => RequirementAgentRunner;
+    constructor(input: RequirementAgentInput);
+    protected _run(input: RequirementAgentRunInput, options: RequirementAgentRunOptions | undefined, run: GetRunContext<typeof this>): Promise<RequirementAgentOutput>;
+    protected processInput(input: RequirementAgentRunInput): Message[];
+    protected createToolCallChecker(): ToolCallChecker;
+    get meta(): AgentMeta;
+    protected get templates(): RequirementAgentTemplates;
+    createSnapshot(): {
+        input: InternalRequirementAgentInput;
+        emitter: Emitter<RequirementAgentCallbacks>;
+        runnerClass: new (llm: ChatModel, runConfig: RequirementAgentExecutionConfig, tools: AnyTool[], requirements: Requirement[], expectedOutput: string | zod.ZodType<any, zod.ZodTypeDef, any> | null, toolCallCycleChecker: ToolCallChecker, ctx: RunContext<RequirementAgent, any>, forceFinalAnswerAsTool: boolean, templates: RequirementAgentTemplates) => RequirementAgentRunner;
+        isRunning: boolean;
+        middlewares: MiddlewareType<any>[];
+    };
+    set memory(memory: BaseMemory);
+    get memory(): BaseMemory;
+}
+
+export { type RequirementAgentTemplateFactory as R, RequirementAgentRunner, type RequirementAgentInput as a, RequirementAgent as b };

package/dist/agents/requirement/runner.d.ts

@@ -0,0 +1,117 @@
+import { RunContext, MiddlewareType, GetRunContext } from '../../context.js';
+import * as zod from 'zod';
+import { z } from 'zod';
+import { a as BaseAgent, b as AgentMeta } from '../../base-BurRTBA7.js';
+import { AnyTool } from '../../tools/base.js';
+import { BaseMemory } from '../../memory/base.js';
+import { E as Emitter } from '../../emitter-CN7I4uSV.js';
+import { m as ChatModel, n as ChatModelOutput, c as ChatModelToolChoice } from '../../chat-BbCYMAdE.js';
+import { Message, MessageContentPart, AssistantMessage, ToolMessage } from '../../backend/message.js';
+import { c as RequirementAgentExecutionConfig, d as RequirementAgentTemplates, R as RequirementAgentRunState, a as RequirementAgentRequest, e as RequirementAgentRunInput, f as RequirementAgentOutput, g as RequirementAgentRunOptions, h as RequirementAgentCallbacks } from '../../types-BXkkbABd.js';
+import { Requirement, Rule } from './requirements/requirement.js';
+import { ToolCallPart } from 'ai';
+import { RetryCounter } from '../../internals/helpers/counter.js';
+import { RequirementsReasoner } from './utils/llm.js';
+import { ToolCallChecker, ToolCallCheckerConfig } from './utils/toolCallChecker.js';
+import { RequiredExcept } from '../../internals/types.js';
+import '../../internals/serializable.js';
+import '../../internals/helpers/guards.js';
+import '../../internals/helpers/promise.js';
+import '../../errors.js';
+import 'ajv';
+import 'promise-based-task';
+import '../../cache/base.js';
+import '../../internals/helpers/schema.js';
+import 'zod-to-json-schema';
+import '../../backend/constants.js';
+import '../../template.js';
+import '../../logger/logger.js';
+import 'pino';
+
+/**
+ * Runner for RequirementAgent execution
+ */
+declare class RequirementAgentRunner {
+    protected readonly llm: ChatModel;
+    protected readonly runConfig: RequirementAgentExecutionConfig;
+    protected readonly requirements: Requirement[];
+    protected readonly toolCallCycleChecker: ToolCallChecker;
+    protected readonly ctx: RunContext<RequirementAgent>;
+    protected forceFinalAnswerAsTool: boolean;
+    protected readonly templates: RequirementAgentTemplates;
+    protected readonly state: RequirementAgentRunState;
+    protected readonly reasoner: RequirementsReasoner;
+    protected readonly iterationErrorCounter: RetryCounter;
+    protected readonly globalErrorCounter: RetryCounter;
+    constructor(llm: ChatModel, runConfig: RequirementAgentExecutionConfig, tools: AnyTool[], requirements: Requirement[], expectedOutput: string | z.ZodSchema | null, toolCallCycleChecker: ToolCallChecker, ctx: RunContext<RequirementAgent>, forceFinalAnswerAsTool: boolean, templates: RequirementAgentTemplates);
+    protected incrementIteration(): void;
+    protected runLLM(request: RequirementAgentRequest): Promise<ChatModelOutput>;
+    protected prepareLLMRequest(request: RequirementAgentRequest): Promise<{
+        messages: Message<MessageContentPart, string>[];
+        options: {
+            maxRetries: number | undefined;
+            tools: AnyTool[];
+            toolChoice: ChatModelToolChoice;
+            stream: boolean;
+        };
+    }>;
+    protected createFinalAnswerToolCall(fullText: string): Promise<AssistantMessage | null>;
+    protected createRequest(extraRules?: Rule[]): Promise<RequirementAgentRequest>;
+    protected invokeToolCalls(tools: AnyTool[], toolCalls: ToolCallPart[]): Promise<ToolMessage[]>;
+    addMessages(messages: Message[]): Promise<void>;
+    run(): Promise<RequirementAgentRunState>;
+    protected runIteration(request: RequirementAgentRequest): Promise<ChatModelOutput>;
+}
+
+type RequirementAgentTemplateFactory<K extends keyof RequirementAgentTemplates> = (template: RequirementAgentTemplates[K]) => RequirementAgentTemplates[K];
+interface RequirementAgentInput {
+    llm: ChatModel;
+    memory?: BaseMemory;
+    tools?: AnyTool[];
+    requirements?: Requirement[];
+    name?: string;
+    description?: string;
+    role?: string;
+    instructions?: string | string[];
+    notes?: string | string[];
+    toolCallChecker?: boolean | ToolCallCheckerConfig;
+    finalAnswerAsTool?: boolean;
+    saveIntermediateSteps?: boolean;
+    execution?: RequirementAgentExecutionConfig;
+    templates?: Partial<{
+        [K in keyof RequirementAgentTemplates]: RequirementAgentTemplates[K] | RequirementAgentTemplateFactory<K>;
+    }>;
+    middlewares?: MiddlewareType<RequirementAgent>[];
+}
+type InternalRequirementAgentInput = RequiredExcept<RequirementAgentInput, "role" | "instructions" | "name" | "description" | "templates" | "notes" | "execution" | "middlewares">;
+/**
+ * RequirementAgent - A declarative AI agent with rule-based constraints
+ *
+ * The RequirementAgent provides predictable, controlled execution behavior across
+ * different language models through rule-based constraints (Requirements).
+ * Requirements can be configured as strict or flexible as necessary, adapting to
+ * task requirements while ensuring consistent execution regardless of the underlying
+ * model's reasoning or tool-calling capabilities.
+ */
+declare class RequirementAgent extends BaseAgent<RequirementAgentRunInput, RequirementAgentOutput, RequirementAgentRunOptions> {
+    readonly emitter: Emitter<RequirementAgentCallbacks>;
+    protected readonly input: InternalRequirementAgentInput;
+    protected runner: new (...args: ConstructorParameters<typeof RequirementAgentRunner>) => RequirementAgentRunner;
+    constructor(input: RequirementAgentInput);
+    protected _run(input: RequirementAgentRunInput, options: RequirementAgentRunOptions | undefined, run: GetRunContext<typeof this>): Promise<RequirementAgentOutput>;
+    protected processInput(input: RequirementAgentRunInput): Message[];
+    protected createToolCallChecker(): ToolCallChecker;
+    get meta(): AgentMeta;
+    protected get templates(): RequirementAgentTemplates;
+    createSnapshot(): {
+        input: InternalRequirementAgentInput;
+        emitter: Emitter<RequirementAgentCallbacks>;
+        runnerClass: new (llm: ChatModel, runConfig: RequirementAgentExecutionConfig, tools: AnyTool[], requirements: Requirement[], expectedOutput: string | zod.ZodType<any, zod.ZodTypeDef, any> | null, toolCallCycleChecker: ToolCallChecker, ctx: RunContext<RequirementAgent, any>, forceFinalAnswerAsTool: boolean, templates: RequirementAgentTemplates) => RequirementAgentRunner;
+        isRunning: boolean;
+        middlewares: MiddlewareType<any>[];
+    };
+    set memory(memory: BaseMemory);
+    get memory(): BaseMemory;
+}
+
+export { type RequirementAgentTemplateFactory as R, RequirementAgentRunner, type RequirementAgentInput as a, RequirementAgent as b };