nestjs-langchain 2.0.0 → 2.2.0

package/dist/run/answered-calls.util.js

@@ -0,0 +1,12 @@
+/**
+ * The ids of the tool calls the messages answer: the tool node answers every
+ * call it runs. Structural rather than `BaseMessage`. See #52.
+ *
+ * @internal
+ * @param messages A run's messages.
+ * @returns The ids their `tool_call_id`s answer.
+ */
+export const answeredCalls = (messages) => new Set(messages.flatMap((message) => 'tool_call_id' in message && typeof message.tool_call_id === 'string'
+    ? [message.tool_call_id]
+    : []));
+//# sourceMappingURL=answered-calls.util.js.map

package/dist/run/answered-calls.util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"answered-calls.util.js","sourceRoot":"","sources":["../../lib/run/answered-calls.util.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,QAA2B,EAAe,EAAE,CACxE,IAAI,GAAG,CACL,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAC3B,cAAc,IAAI,OAAO,IAAI,OAAO,OAAO,CAAC,YAAY,KAAK,QAAQ;IACnE,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;IACxB,CAAC,CAAC,EAAE,CACP,CACF,CAAC"}

package/dist/run/index.d.ts

@@ -1,3 +1,6 @@
+export { answeredCalls } from './answered-calls.util.js';
+export { isRecursionLimit } from './recursion-limit.util.js';
 export { summariseRun } from './run-summary.util.js';
+export { UsageAside } from './usage-aside.js';
 export type { RunSummary } from './run-summary.util.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/run/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/run/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,YAAY,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/run/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,YAAY,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/run/index.js

@@ -1,2 +1,5 @@
+export { answeredCalls } from './answered-calls.util.js';
+export { isRecursionLimit } from './recursion-limit.util.js';
 export { summariseRun } from './run-summary.util.js';
+export { UsageAside } from './usage-aside.js';
 //# sourceMappingURL=index.js.map

package/dist/run/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/run/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/run/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/run/recursion-limit.util.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Whether a `recursionLimit` is one LangGraph applies: it rejects a limit
+ * below 1, but runs on with `NaN`. See #194.
+ *
+ * @internal
+ * @param limit The option as given, from untyped JavaScript too.
+ * @returns `true` for an integer of at least 1, or no limit.
+ */
+export declare const isRecursionLimit: (limit: unknown) => boolean;
+//# sourceMappingURL=recursion-limit.util.d.ts.map

package/dist/run/recursion-limit.util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recursion-limit.util.d.ts","sourceRoot":"","sources":["../../lib/run/recursion-limit.util.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAO,OAAO,KAAG,OAEoB,CAAC"}

package/dist/run/recursion-limit.util.js

@@ -0,0 +1,11 @@
+/**
+ * Whether a `recursionLimit` is one LangGraph applies: it rejects a limit
+ * below 1, but runs on with `NaN`. See #194.
+ *
+ * @internal
+ * @param limit The option as given, from untyped JavaScript too.
+ * @returns `true` for an integer of at least 1, or no limit.
+ */
+export const isRecursionLimit = (limit) => limit === undefined ||
+    (typeof limit === 'number' && Number.isInteger(limit) && limit >= 1);
+//# sourceMappingURL=recursion-limit.util.js.map

package/dist/run/recursion-limit.util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recursion-limit.util.js","sourceRoot":"","sources":["../../lib/run/recursion-limit.util.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAW,EAAE,CAC1D,KAAK,KAAK,SAAS;IACnB,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC"}

package/dist/run/run-summary.util.d.ts

@@ -3,11 +3,16 @@ interface MessageLike {
     usage_metadata?: UsageMetadata;
     tool_calls?: {
         name: string;
+        id?: string;
     }[];
+    tool_call_id?: string;
 }
 /** What a run did and cost. */
 export interface RunSummary {
-    /** Every tool call the model made, failed and unknown ones included. */
+    /**
+     * Every tool call that reached the agent's tools, failed and unknown ones
+     * included, but not the one returning a structured output.
+     */
     tools: string[];
     /**
      * Summed over the run's model calls; absent when the provider reports no
@@ -24,8 +29,10 @@ export interface RunSummary {
  *
  * @internal
  * @param messages The messages of the finished run.
- * @returns The tool calls the model made, and the tokens if reported.
+ * @param outputTool The tool the model returned a structured output through.
+ * @param aside The usage of the replies the run left out of its messages.
+ * @returns The tool calls that reached the tools, and the tokens if reported.
  */
-export declare const summariseRun: (messages: readonly MessageLike[]) => RunSummary;
+export declare const summariseRun: (messages: readonly MessageLike[], outputTool?: string, aside?: readonly UsageMetadata[]) => RunSummary;
 export {};
 //# sourceMappingURL=run-summary.util.d.ts.map

package/dist/run/run-summary.util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run-summary.util.d.ts","sourceRoot":"","sources":["../../lib/run/run-summary.util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAG7E,UAAU,WAAW;IACnB,cAAc,CAAC,EAAE,aAAa,CAAC;IAC/B,UAAU,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CACjC;AAED,+BAA+B;AAC/B,MAAM,WAAW,UAAU;IACzB,wEAAwE;IACxE,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3D;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GAAI,UAAU,SAAS,WAAW,EAAE,KAAG,UAwB/D,CAAC"}
+{"version":3,"file":"run-summary.util.d.ts","sourceRoot":"","sources":["../../lib/run/run-summary.util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAI7E,UAAU,WAAW;IACnB,cAAc,CAAC,EAAE,aAAa,CAAC;IAC/B,UAAU,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC7C,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,+BAA+B;AAC/B,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3D;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GACvB,UAAU,SAAS,WAAW,EAAE,EAChC,aAAa,MAAM,EACnB,QAAO,SAAS,aAAa,EAAO,KACnC,UAmCF,CAAC"}

package/dist/run/run-summary.util.js

@@ -1,16 +1,28 @@
 import { mergeUsageMetadata } from '@langchain/core/messages';
+import { answeredCalls } from './answered-calls.util.js';
 /**
  * What a finished run cost, read off the messages it returned.
  *
  * @internal
  * @param messages The messages of the finished run.
- * @returns The tool calls the model made, and the tokens if reported.
+ * @param outputTool The tool the model returned a structured output through.
+ * @param aside The usage of the replies the run left out of its messages.
+ * @returns The tool calls that reached the tools, and the tokens if reported.
  */
-export const summariseRun = (messages) => {
-    const tools = messages.flatMap((message) => (message.tool_calls ?? []).map((call) => call.name));
-    const reported = messages
-        .map((message) => message.usage_metadata)
-        .filter((usage) => usage !== undefined);
+export const summariseRun = (messages, outputTool, aside = []) => {
+    // One that did not run has no answer (see #290). One with no id cannot be
+    // told, and counts (see #295).
+    const answered = answeredCalls(messages);
+    const tools = messages
+        .flatMap((message) => message.tool_calls ?? [])
+        .filter(({ name, id }) => name !== outputTool && (id === undefined || answered.has(id)))
+        .map((call) => call.name);
+    const reported = [
+        ...messages
+            .map((message) => message.usage_metadata)
+            .filter((usage) => usage !== undefined),
+        ...aside,
+    ];
     if (reported.length === 0) {
         return { tools };
     }

package/dist/run/run-summary.util.js.map

@@ -1 +1 @@
-{"version":3,"file":"run-summary.util.js","sourceRoot":"","sources":["../../lib/run/run-summary.util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAiB,MAAM,0BAA0B,CAAC;AAmB7E;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,QAAgC,EAAc,EAAE;IAC3E,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CACzC,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CACpD,CAAC;IAEF,MAAM,QAAQ,GAAG,QAAQ;SACtB,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,cAAc,CAAC;SACxC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;IAE1C,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,KAAK,EAAE,CAAC;IACnB,CAAC;IAED,oEAAoE;IACpE,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,kBAAkB,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAExE,OAAO;QACL,KAAK;QACL,MAAM,EAAE;YACN,KAAK,EAAE,KAAK,CAAC,YAAY;YACzB,MAAM,EAAE,KAAK,CAAC,aAAa;YAC3B,KAAK,EAAE,KAAK,CAAC,YAAY;SAC1B;KACF,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"run-summary.util.js","sourceRoot":"","sources":["../../lib/run/run-summary.util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAiB,MAAM,0BAA0B,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAuBzD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,QAAgC,EAChC,UAAmB,EACnB,QAAkC,EAAE,EACxB,EAAE;IACd,0EAA0E;IAC1E,+BAA+B;IAC/B,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IAEzC,MAAM,KAAK,GAAG,QAAQ;SACnB,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC;SAC9C,MAAM,CACL,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,CACf,IAAI,KAAK,UAAU,IAAI,CAAC,EAAE,KAAK,SAAS,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAChE;SACA,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE5B,MAAM,QAAQ,GAAG;QACf,GAAG,QAAQ;aACR,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,cAAc,CAAC;aACxC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC;QACzC,GAAG,KAAK;KACT,CAAC;IAEF,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,KAAK,EAAE,CAAC;IACnB,CAAC;IAED,oEAAoE;IACpE,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,kBAAkB,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAExE,OAAO;QACL,KAAK;QACL,MAAM,EAAE;YACN,KAAK,EAAE,KAAK,CAAC,YAAY;YACzB,MAAM,EAAE,KAAK,CAAC,aAAa;YAC3B,KAAK,EAAE,KAAK,CAAC,YAAY;SAC1B;KACF,CAAC;AACJ,CAAC,CAAC"}

package/dist/run/usage-aside.d.ts

@@ -0,0 +1,23 @@
+import { UsageMetadata } from '@langchain/core/messages';
+/**
+ * The usage of the model's replies a run leaves out of its messages, which its
+ * `tokens` still count: those the `unknownTools` re-ask asks again about. One
+ * per run, handed to the middlewares in `configurable`. See #296.
+ *
+ * @internal
+ */
+export declare class UsageAside {
+    readonly usage: UsageMetadata[];
+    /** The `configurable` entry that hands it to the middlewares. */
+    get config(): Record<string, UsageAside>;
+    /**
+     * @param usage A left-out reply's usage, when the provider reported it.
+     */
+    add(usage: UsageMetadata | undefined): void;
+    /**
+     * @param configurable A middleware's `runtime.configurable`.
+     * @returns The run's aside, when it set one.
+     */
+    static of(configurable: Record<string, unknown> | undefined): UsageAside | undefined;
+}
+//# sourceMappingURL=usage-aside.d.ts.map

package/dist/run/usage-aside.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage-aside.d.ts","sourceRoot":"","sources":["../../lib/run/usage-aside.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAKzD;;;;;;GAMG;AACH,qBAAa,UAAU;IACrB,QAAQ,CAAC,KAAK,EAAE,aAAa,EAAE,CAAM;IAErC,iEAAiE;IACjE,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAEvC;IAED;;OAEG;IACH,GAAG,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,GAAG,IAAI;IAM3C;;;OAGG;IACH,MAAM,CAAC,EAAE,CACP,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,GAChD,UAAU,GAAG,SAAS;CAK1B"}

package/dist/run/usage-aside.js

@@ -0,0 +1,33 @@
+// Our own key in `configurable`, like the run's output. See #296.
+const USAGE_ASIDE_KEY = 'nestjs-langchain:usage-aside';
+/**
+ * The usage of the model's replies a run leaves out of its messages, which its
+ * `tokens` still count: those the `unknownTools` re-ask asks again about. One
+ * per run, handed to the middlewares in `configurable`. See #296.
+ *
+ * @internal
+ */
+export class UsageAside {
+    usage = [];
+    /** The `configurable` entry that hands it to the middlewares. */
+    get config() {
+        return { [USAGE_ASIDE_KEY]: this };
+    }
+    /**
+     * @param usage A left-out reply's usage, when the provider reported it.
+     */
+    add(usage) {
+        if (usage) {
+            this.usage.push(usage);
+        }
+    }
+    /**
+     * @param configurable A middleware's `runtime.configurable`.
+     * @returns The run's aside, when it set one.
+     */
+    static of(configurable) {
+        const aside = configurable?.[USAGE_ASIDE_KEY];
+        return aside instanceof UsageAside ? aside : undefined;
+    }
+}
+//# sourceMappingURL=usage-aside.js.map

package/dist/run/usage-aside.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage-aside.js","sourceRoot":"","sources":["../../lib/run/usage-aside.ts"],"names":[],"mappings":"AAEA,kEAAkE;AAClE,MAAM,eAAe,GAAG,8BAA8B,CAAC;AAEvD;;;;;;GAMG;AACH,MAAM,OAAO,UAAU;IACZ,KAAK,GAAoB,EAAE,CAAC;IAErC,iEAAiE;IACjE,IAAI,MAAM;QACR,OAAO,EAAE,CAAC,eAAe,CAAC,EAAE,IAAI,EAAE,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,KAAgC;QAClC,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,EAAE,CACP,YAAiD;QAEjD,MAAM,KAAK,GAAG,YAAY,EAAE,CAAC,eAAe,CAAC,CAAC;QAE9C,OAAO,KAAK,YAAY,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACzD,CAAC;CACF"}

package/dist/tools/tool-errors.middleware.d.ts

@@ -16,6 +16,12 @@ export declare const toolErrors: (reporter: RunReporter) => import("langchain").
 /**
  * Reports a call to a tool the agent does not have. LangChain's tool node
  * answers the model itself, without throwing, so `toolErrors` never sees it.
+ * One the model invents with the `extract-` prefix never reaches the tool
+ * node: it is answered here, as the tool node answers any other, and so is
+ * any call LangChain leaves unanswered.
+ *
+ * @param reporter The agent's reporter.
+ * @param tools The names of the agent's tools, which the answer lists.
  */
-export declare const unknownTools: (reporter: RunReporter) => import("langchain").AgentMiddleware<undefined, undefined, unknown, readonly (import("@langchain/core/tools").ServerTool | import("@langchain/core/tools").ClientTool)[], readonly []>;
+export declare const unknownTools: (reporter: RunReporter, tools: string[]) => import("langchain").AgentMiddleware<undefined, undefined, unknown, readonly (import("@langchain/core/tools").ServerTool | import("@langchain/core/tools").ClientTool)[], readonly []>;
 //# sourceMappingURL=tool-errors.middleware.d.ts.map

package/dist/tools/tool-errors.middleware.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tool-errors.middleware.d.ts","sourceRoot":"","sources":["../../lib/tools/tool-errors.middleware.ts"],"names":[],"mappings":"AAMA,OAAO,EAAmB,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAEnE;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU,GAAI,UAAU,WAAW,0LAwB5C,CAAC;AAEL;;;GAGG;AACH,eAAO,MAAM,YAAY,GAAI,UAAU,WAAW,0LAgB9C,CAAC"}
+{"version":3,"file":"tool-errors.middleware.d.ts","sourceRoot":"","sources":["../../lib/tools/tool-errors.middleware.ts"],"names":[],"mappings":"AAaA,OAAO,EAAmB,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAkBnE;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU,GAAI,UAAU,WAAW,0LAwB5C,CAAC;AAEL;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,GAAI,UAAU,WAAW,EAAE,OAAO,MAAM,EAAE,0LAiFlE,CAAC"}

package/dist/tools/tool-errors.middleware.js

@@ -1,6 +1,17 @@
+import { AIMessage, ToolMessage, } from '@langchain/core/messages';
 import { createMiddleware, toolErrorMiddleware, ToolInvocationError, } from 'langchain';
-import { unknownTool } from '../errors/messages.js';
+import { OUTPUT_TOOL, STRUCTURED_OUTPUT_PREFIX } from '../constants.js';
+import { invalidTool, toolNotRun, unknownTool } from '../errors/messages.js';
 import { reportToolError } from '../logging/index.js';
+import { answeredCalls, UsageAside } from '../run/index.js';
+// The default of LangChain's own retry middlewares. See #151.
+const MAX_REASKS = 2;
+// LangChain routes every `extract-` call to structured output, never to the
+// tools: one the model invents, which is not the run's output, neither runs
+// nor gets an answer. See #264.
+const isInvented = ({ name }) => name.startsWith(STRUCTURED_OUTPUT_PREFIX) && name !== OUTPUT_TOOL;
+const invented = (calls) => calls.filter(isInvented);
+const callsOf = (message) => AIMessage.isInstance(message) ? (message.tool_calls ?? []) : [];
 /**
  * Turns a failed tool call into the text the model receives, LangChain's own,
  * without the stack (and its server paths) LangChain puts in a schema failure.
@@ -36,20 +47,74 @@ export const toolErrors = (reporter) => toolErrorMiddleware({
 /**
  * Reports a call to a tool the agent does not have. LangChain's tool node
  * answers the model itself, without throwing, so `toolErrors` never sees it.
+ * One the model invents with the `extract-` prefix never reaches the tool
+ * node: it is answered here, as the tool node answers any other, and so is
+ * any call LangChain leaves unanswered.
+ *
+ * @param reporter The agent's reporter.
+ * @param tools The names of the agent's tools, which the answer lists.
  */
-export const unknownTools = (reporter) => createMiddleware({
-    name: 'unknownTools',
-    wrapToolCall: (request, handler) => {
-        if (!request.tool) {
-            reportToolError(reporter, {
-                tool: request.toolCall.name,
-                callId: request.toolCall.id ?? '',
-                reason: 'unknown-tool',
-                error: new Error(unknownTool()),
-                durationMs: 0,
-            });
-        }
-        return handler(request);
-    },
-});
+export const unknownTools = (reporter, tools) => {
+    const report = ({ name, id }) => reportToolError(reporter, {
+        tool: name,
+        callId: id ?? '',
+        reason: 'unknown-tool',
+        error: new Error(unknownTool()),
+        durationMs: 0,
+    });
+    const answer = (call) => new ToolMessage({
+        content: isInvented(call)
+            ? invalidTool(call.name, tools)
+            : toolNotRun(call.name),
+        tool_call_id: call.id ?? '',
+        name: call.name,
+        status: 'error',
+    });
+    // Every call without an answer gets one right after its message, which
+    // providers require: an invented one (see #264), or one LangChain left out
+    // next to the output (see #290). In the request, which the output's retry
+    // reaches without `beforeModel`; rebuilt on every model call, so only the
+    // reply just made is reported. See #297.
+    const answerLeft = (messages) => {
+        const done = answeredCalls(messages);
+        const left = (message) => callsOf(message).filter(({ id }) => id !== undefined && !done.has(id));
+        invented(left(messages.findLast((m) => AIMessage.isInstance(m)))).forEach(report);
+        return messages.flatMap((message) => [
+            message,
+            ...left(message).map(answer),
+        ]);
+    };
+    return createMiddleware({
+        name: 'unknownTools',
+        // Alone, LangChain would end the run: answered, and the model asked again,
+        // as `modelRetryMiddleware` asks it again. See #264.
+        wrapModelCall: async (request, handler) => {
+            let current = { ...request, messages: answerLeft(request.messages) };
+            for (let asked = 0;; asked += 1) {
+                const reply = await handler(current);
+                const calls = callsOf(reply);
+                const left = invented(calls);
+                if (calls.length === 0 || left.length < calls.length) {
+                    return reply;
+                }
+                left.forEach(report);
+                if (asked === MAX_REASKS) {
+                    return reply;
+                }
+                // Left out of the run's messages, but paid for. See #296.
+                UsageAside.of(request.runtime.configurable)?.add(AIMessage.isInstance(reply) ? reply.usage_metadata : undefined);
+                current = {
+                    ...current,
+                    messages: [...current.messages, reply, ...left.map(answer)],
+                };
+            }
+        },
+        wrapToolCall: (request, handler) => {
+            if (!request.tool) {
+                report(request.toolCall);
+            }
+            return handler(request);
+        },
+    });
+};
 //# sourceMappingURL=tool-errors.middleware.js.map

package/dist/tools/tool-errors.middleware.js.map

@@ -1 +1 @@
-{"version":3,"file":"tool-errors.middleware.js","sourceRoot":"","sources":["../../lib/tools/tool-errors.middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAe,MAAM,qBAAqB,CAAC;AAEnE;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,QAAqB,EAAE,EAAE,CAClD,mBAAmB,CAAC;IAClB,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;QACjB,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3C,gDAAgD;YAChD,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,8BAA8B,CAAC;QACxD,CAAC;QAED,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC;QAEtC,eAAe,CAAC,QAAQ,EAAE;YACxB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,QAAQ,CAAC,EAAE,IAAI,EAAE;YACzB,MAAM,EAAE,mBAAmB;YAC3B,KAAK,EAAE,SAAS;YAChB,UAAU,EAAE,CAAC;SACd,CAAC,CAAC;QAEH,OAAO,CACL,wBAAwB,QAAQ,CAAC,IAAI,gBAAgB;YACrD,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,MAAM,CAAC,SAAS,CAAC,IAAI;YACrE,sCAAsC,CACvC,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEL;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,QAAqB,EAAE,EAAE,CACpD,gBAAgB,CAAC;IACf,IAAI,EAAE,cAAc;IACpB,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;QACjC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAClB,eAAe,CAAC,QAAQ,EAAE;gBACxB,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAC3B,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE;gBACjC,MAAM,EAAE,cAAc;gBACtB,KAAK,EAAE,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;gBAC/B,UAAU,EAAE,CAAC;aACd,CAAC,CAAC;QACL,CAAC;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;CACF,CAAC,CAAC"}
+{"version":3,"file":"tool-errors.middleware.js","sourceRoot":"","sources":["../../lib/tools/tool-errors.middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAGT,WAAW,GACZ,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAe,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE5D,8DAA8D;AAC9D,MAAM,UAAU,GAAG,CAAC,CAAC;AAErB,4EAA4E;AAC5E,4EAA4E;AAC5E,gCAAgC;AAChC,MAAM,UAAU,GAAG,CAAC,EAAE,IAAI,EAAY,EAAW,EAAE,CACjD,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC,IAAI,IAAI,KAAK,WAAW,CAAC;AAEpE,MAAM,QAAQ,GAAG,CAAC,KAA0B,EAAc,EAAE,CAC1D,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;AAE3B,MAAM,OAAO,GAAG,CAAC,OAAgC,EAAc,EAAE,CAC/D,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAElE;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,QAAqB,EAAE,EAAE,CAClD,mBAAmB,CAAC;IAClB,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;QACjB,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3C,gDAAgD;YAChD,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,8BAA8B,CAAC;QACxD,CAAC;QAED,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC;QAEtC,eAAe,CAAC,QAAQ,EAAE;YACxB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,QAAQ,CAAC,EAAE,IAAI,EAAE;YACzB,MAAM,EAAE,mBAAmB;YAC3B,KAAK,EAAE,SAAS;YAChB,UAAU,EAAE,CAAC;SACd,CAAC,CAAC;QAEH,OAAO,CACL,wBAAwB,QAAQ,CAAC,IAAI,gBAAgB;YACrD,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,MAAM,CAAC,SAAS,CAAC,IAAI;YACrE,sCAAsC,CACvC,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEL;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,QAAqB,EAAE,KAAe,EAAE,EAAE;IACrE,MAAM,MAAM,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,EAAY,EAAE,EAAE,CACxC,eAAe,CAAC,QAAQ,EAAE;QACxB,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,EAAE,IAAI,EAAE;QAChB,MAAM,EAAE,cAAc;QACtB,KAAK,EAAE,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;QAC/B,UAAU,EAAE,CAAC;KACd,CAAC,CAAC;IAEL,MAAM,MAAM,GAAG,CAAC,IAAc,EAAE,EAAE,CAChC,IAAI,WAAW,CAAC;QACd,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC;YACvB,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC;YAC/B,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;QACzB,YAAY,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE;QAC3B,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,MAAM,EAAE,OAAO;KAChB,CAAC,CAAC;IAEL,uEAAuE;IACvE,2EAA2E;IAC3E,0EAA0E;IAC1E,0EAA0E;IAC1E,yCAAyC;IACzC,MAAM,UAAU,GAAG,CAAC,QAAuB,EAAiB,EAAE;QAC5D,MAAM,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;QACrC,MAAM,IAAI,GAAG,CAAC,OAAgC,EAAE,EAAE,CAChD,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QAEzE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CACvE,MAAM,CACP,CAAC;QAEF,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;YACnC,OAAO;YACP,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;SAC7B,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,OAAO,gBAAgB,CAAC;QACtB,IAAI,EAAE,cAAc;QACpB,2EAA2E;QAC3E,qDAAqD;QACrD,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;YACxC,IAAI,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAErE,KAAK,IAAI,KAAK,GAAG,CAAC,GAAI,KAAK,IAAI,CAAC,EAAE,CAAC;gBACjC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;gBACrC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC7B,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAE7B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;oBACrD,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBAErB,IAAI,KAAK,KAAK,UAAU,EAAE,CAAC;oBACzB,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,0DAA0D;gBAC1D,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,GAAG,CAC9C,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAC/D,CAAC;gBAEF,OAAO,GAAG;oBACR,GAAG,OAAO;oBACV,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;iBAC5D,CAAC;YACJ,CAAC;QACH,CAAC;QACD,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;YACjC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;gBAClB,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC3B,CAAC;YAED,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/tools/tool-name.util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tool-name.util.d.ts","sourceRoot":"","sources":["../../lib/tools/tool-name.util.ts"],"names":[],"mappings":"AAcA,eAAO,MAAM,eAAe,GAC1B,UAAU,MAAM,GAAG,SAAS,EAC5B,QAAQ,MAAM,EACd,OAAO,MAAM,KACZ,MAcF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,sBAAsB,GACjC,OAAO;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,EAAE,KACvC,MAAM,EAgBR,CAAC"}
+{"version":3,"file":"tool-name.util.d.ts","sourceRoot":"","sources":["../../lib/tools/tool-name.util.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,eAAe,GAC1B,UAAU,MAAM,GAAG,SAAS,EAC5B,QAAQ,MAAM,EACd,OAAO,MAAM,KACZ,MAcF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,sBAAsB,GACjC,OAAO;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,EAAE,KACvC,MAAM,EAgBR,CAAC"}

package/dist/tools/tool-name.util.js

@@ -1,10 +1,8 @@
+import { STRUCTURED_OUTPUT_PREFIX } from '../constants.js';
 import { duplicateToolName, invalidToolName, reservedToolName, } from '../errors/messages.js';
 // OpenAI's limit, the strictest published, restated: no provider SDK exports
 // it. See #90.
 const TOOL_NAME = /^[a-zA-Z0-9_-]{1,64}$/;
-// The agent routes a call with this prefix to structured output, never to the
-// tool. Restated: LangChain does not export it. See #213.
-const STRUCTURED_OUTPUT_PREFIX = 'extract-';
 export const resolveToolName = (declared, method, where) => {
     const name = declared ?? method;
     if (!TOOL_NAME.test(name)) {

package/dist/tools/tool-name.util.js.map

@@ -1 +1 @@
-{"version":3,"file":"tool-name.util.js","sourceRoot":"","sources":["../../lib/tools/tool-name.util.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAE/B,6EAA6E;AAC7E,eAAe;AACf,MAAM,SAAS,GAAG,uBAAuB,CAAC;AAE1C,8EAA8E;AAC9E,0DAA0D;AAC1D,MAAM,wBAAwB,GAAG,UAAU,CAAC;AAE5C,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,QAA4B,EAC5B,MAAc,EACd,KAAa,EACL,EAAE;IACV,MAAM,IAAI,GAAG,QAAQ,IAAI,MAAM,CAAC;IAEhC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CACb,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,QAAQ,KAAK,SAAS,CAAC,CACxE,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,KAAK,EAAE,IAAI,EAAE,wBAAwB,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,KAAwC,EAC9B,EAAE;IACZ,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IACvC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAE7B,IAAI,KAAK,EAAE,CAAC;YACV,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;YACrD,OAAO;QACT,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC"}
+{"version":3,"file":"tool-name.util.js","sourceRoot":"","sources":["../../lib/tools/tool-name.util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAE/B,6EAA6E;AAC7E,eAAe;AACf,MAAM,SAAS,GAAG,uBAAuB,CAAC;AAE1C,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,QAA4B,EAC5B,MAAc,EACd,KAAa,EACL,EAAE;IACV,MAAM,IAAI,GAAG,QAAQ,IAAI,MAAM,CAAC;IAEhC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CACb,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,QAAQ,KAAK,SAAS,CAAC,CACxE,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,KAAK,EAAE,IAAI,EAAE,wBAAwB,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,KAAwC,EAC9B,EAAE;IACZ,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IACvC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAE7B,IAAI,KAAK,EAAE,CAAC;YACV,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;YACrD,OAAO;QACT,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC"}