modelfusion 0.111.0 → 0.113.0

package/model-provider/openai-compatible/OpenAICompatibleChatModel.js

@@ -55,10 +55,15 @@ export class OpenAICompatibleChatModel extends AbstractOpenAIChatModel {
         return Object.fromEntries(Object.entries(this.settings).filter(([key]) => eventSettingProperties.includes(key)));
     }
     asStructureGenerationModel(promptTemplate) {
-        return new StructureFromTextStreamingModel({
-            model: this,
-            template: promptTemplate,
-        });
+        return "adaptModel" in promptTemplate
+            ? new StructureFromTextStreamingModel({
+                model: promptTemplate.adaptModel(this),
+                template: promptTemplate,
+            })
+            : new StructureFromTextStreamingModel({
+                model: this,
+                template: promptTemplate,
+            });
     }
     /**
      * Returns this model with a text prompt template.
@@ -89,6 +94,9 @@ export class OpenAICompatibleChatModel extends AbstractOpenAIChatModel {
             promptTemplate,
         });
     }
+    withJsonOutput() {
+        return this.withSettings({ responseFormat: { type: "json_object" } });
+    }
     withSettings(additionalSettings) {
         return new OpenAICompatibleChatModel(Object.assign({}, this.settings, additionalSettings));
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "modelfusion",
-  "description": "The TypeScript library for building multi-modal AI applications.",
-  "version": "0.111.0",
+  "description": "The TypeScript library for building AI applications.",
+  "version": "0.113.0",
   "author": "Lars Grammel",
   "license": "MIT",
   "keywords": [

package/tool/Tool.cjs

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Tool = void 0;
-const InvalidToolNameError_js_1 = require("./InvalidToolNameError.cjs");
-const namePattern = /^[a-zA-Z0-9_-]{1,64}$/;
 /**
  * A tool is a function with a name, description and defined inputs that can be used
  * by agents and chatbots.
@@ -11,7 +9,6 @@ class Tool {
     constructor({ name, description, parameters, returnType, execute, }) {
         /**
          * The name of the tool.
-         * It has to be a function name that matches the regular expression pattern '^[a-zA-Z0-9_-]{1,64}$'.
          * Should be understandable for language models and unique among the tools that they know.
          */
         Object.defineProperty(this, "name", {
@@ -57,13 +54,6 @@ class Tool {
             writable: true,
             value: void 0
         });
-        // check that the name is a valid function name:
-        if (!namePattern.test(name)) {
-            throw new InvalidToolNameError_js_1.InvalidToolNameError({
-                toolName: name,
-                namePattern,
-            });
-        }
         this.name = name;
         this.description = description;
         this.parameters = parameters;

package/tool/Tool.d.ts

@@ -9,7 +9,6 @@ import { ToolDefinition } from "./ToolDefinition.js";
 export declare class Tool<NAME extends string, PARAMETERS, RESULT> implements ToolDefinition<NAME, PARAMETERS> {
     /**
      * The name of the tool.
-     * It has to be a function name that matches the regular expression pattern '^[a-zA-Z0-9_-]{1,64}$'.
      * Should be understandable for language models and unique among the tools that they know.
      */
     readonly name: NAME;

package/tool/Tool.js

@@ -1,5 +1,3 @@
-import { InvalidToolNameError } from "./InvalidToolNameError.js";
-const namePattern = /^[a-zA-Z0-9_-]{1,64}$/;
 /**
  * A tool is a function with a name, description and defined inputs that can be used
  * by agents and chatbots.
@@ -8,7 +6,6 @@ export class Tool {
     constructor({ name, description, parameters, returnType, execute, }) {
         /**
          * The name of the tool.
-         * It has to be a function name that matches the regular expression pattern '^[a-zA-Z0-9_-]{1,64}$'.
          * Should be understandable for language models and unique among the tools that they know.
          */
         Object.defineProperty(this, "name", {
@@ -54,13 +51,6 @@ export class Tool {
             writable: true,
             value: void 0
         });
-        // check that the name is a valid function name:
-        if (!namePattern.test(name)) {
-            throw new InvalidToolNameError({
-                toolName: name,
-                namePattern,
-            });
-        }
         this.name = name;
         this.description = description;
         this.parameters = parameters;

package/tool/{generate-tool-calls-or-text/TextGenerationToolCallsOrGenerateTextModel.cjs → generate-tool-calls/TextGenerationToolCallsModel.cjs}

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TextGenerationToolCallsOrGenerateTextModel = void 0;
+exports.TextGenerationToolCallsModel = void 0;
 const generateText_js_1 = require("../../model-function/generate-text/generateText.cjs");
-const ToolCallsOrTextParseError_js_1 = require("./ToolCallsOrTextParseError.cjs");
-class TextGenerationToolCallsOrGenerateTextModel {
+const ToolCallsParseError_js_1 = require("./ToolCallsParseError.cjs");
+class TextGenerationToolCallsModel {
     constructor({ model, template, }) {
         Object.defineProperty(this, "model", {
             enumerable: true,
@@ -29,7 +29,7 @@ class TextGenerationToolCallsOrGenerateTextModel {
     get settingsForEvent() {
         return this.model.settingsForEvent;
     }
-    async doGenerateToolCallsOrText(tools, prompt, options) {
+    async doGenerateToolCalls(tools, prompt, options) {
         const { response, text: generatedText, metadata, } = await (0, generateText_js_1.generateText)(this.model, this.template.createPrompt(prompt, tools), {
             ...options,
             fullResponse: true,
@@ -44,17 +44,17 @@ class TextGenerationToolCallsOrGenerateTextModel {
             };
         }
         catch (error) {
-            throw new ToolCallsOrTextParseError_js_1.ToolCallsOrTextParseError({
+            throw new ToolCallsParseError_js_1.ToolCallsParseError({
                 valueText: generatedText,
                 cause: error,
             });
         }
     }
     withSettings(additionalSettings) {
-        return new TextGenerationToolCallsOrGenerateTextModel({
+        return new TextGenerationToolCallsModel({
             model: this.model.withSettings(additionalSettings),
             template: this.template,
         });
     }
 }
-exports.TextGenerationToolCallsOrGenerateTextModel = TextGenerationToolCallsOrGenerateTextModel;
+exports.TextGenerationToolCallsModel = TextGenerationToolCallsModel;

package/tool/{generate-tool-calls-or-text/TextGenerationToolCallsOrGenerateTextModel.d.ts → generate-tool-calls/TextGenerationToolCallsModel.d.ts}

@@ -1,19 +1,19 @@
 import { FunctionOptions } from "../../core/FunctionOptions.js";
 import { TextGenerationModel } from "../../model-function/generate-text/TextGenerationModel.js";
 import { ToolDefinition } from "../ToolDefinition.js";
-import { ToolCallsOrGenerateTextPromptTemplate } from "./ToolCallsOrGenerateTextPromptTemplate.js";
-import { ToolCallsOrTextGenerationModel, ToolCallsOrTextGenerationModelSettings } from "./ToolCallsOrTextGenerationModel.js";
-export declare class TextGenerationToolCallsOrGenerateTextModel<SOURCE_PROMPT, TARGET_PROMPT, MODEL extends TextGenerationModel<TARGET_PROMPT, ToolCallsOrTextGenerationModelSettings>> implements ToolCallsOrTextGenerationModel<SOURCE_PROMPT, MODEL["settings"]> {
+import { ToolCallsGenerationModel, ToolCallsGenerationModelSettings } from "./ToolCallsGenerationModel.js";
+import { ToolCallsPromptTemplate } from "./ToolCallsPromptTemplate.js";
+export declare class TextGenerationToolCallsModel<SOURCE_PROMPT, TARGET_PROMPT, MODEL extends TextGenerationModel<TARGET_PROMPT, ToolCallsGenerationModelSettings>> implements ToolCallsGenerationModel<SOURCE_PROMPT, MODEL["settings"]> {
     private readonly model;
     private readonly template;
     constructor({ model, template, }: {
         model: MODEL;
-        template: ToolCallsOrGenerateTextPromptTemplate<SOURCE_PROMPT, TARGET_PROMPT>;
+        template: ToolCallsPromptTemplate<SOURCE_PROMPT, TARGET_PROMPT>;
     });
     get modelInformation(): import("../../index.js").ModelInformation;
-    get settings(): ToolCallsOrTextGenerationModelSettings;
+    get settings(): ToolCallsGenerationModelSettings;
     get settingsForEvent(): Partial<MODEL["settings"]>;
-    doGenerateToolCallsOrText(tools: Array<ToolDefinition<string, unknown>>, prompt: SOURCE_PROMPT, options?: FunctionOptions): Promise<{
+    doGenerateToolCalls(tools: Array<ToolDefinition<string, unknown>>, prompt: SOURCE_PROMPT, options?: FunctionOptions): Promise<{
         response: unknown;
         text: string | null;
         toolCalls: {

package/tool/{generate-tool-calls-or-text/TextGenerationToolCallsOrGenerateTextModel.js → generate-tool-calls/TextGenerationToolCallsModel.js}

@@ -1,6 +1,6 @@
 import { generateText } from "../../model-function/generate-text/generateText.js";
-import { ToolCallsOrTextParseError } from "./ToolCallsOrTextParseError.js";
-export class TextGenerationToolCallsOrGenerateTextModel {
+import { ToolCallsParseError } from "./ToolCallsParseError.js";
+export class TextGenerationToolCallsModel {
     constructor({ model, template, }) {
         Object.defineProperty(this, "model", {
             enumerable: true,
@@ -26,7 +26,7 @@ export class TextGenerationToolCallsOrGenerateTextModel {
     get settingsForEvent() {
         return this.model.settingsForEvent;
     }
-    async doGenerateToolCallsOrText(tools, prompt, options) {
+    async doGenerateToolCalls(tools, prompt, options) {
         const { response, text: generatedText, metadata, } = await generateText(this.model, this.template.createPrompt(prompt, tools), {
             ...options,
             fullResponse: true,
@@ -41,14 +41,14 @@ export class TextGenerationToolCallsOrGenerateTextModel {
             };
         }
         catch (error) {
-            throw new ToolCallsOrTextParseError({
+            throw new ToolCallsParseError({
                 valueText: generatedText,
                 cause: error,
             });
         }
     }
     withSettings(additionalSettings) {
-        return new TextGenerationToolCallsOrGenerateTextModel({
+        return new TextGenerationToolCallsModel({
             model: this.model.withSettings(additionalSettings),
             template: this.template,
         });

package/tool/generate-tool-calls/ToolCallsGenerationEvent.d.ts

@@ -0,0 +1,23 @@
+import { BaseModelCallFinishedEvent, BaseModelCallStartedEvent } from "../../model-function/ModelCallEvent.js";
+export interface ToolCallsGenerationStartedEvent extends BaseModelCallStartedEvent {
+    functionType: "generate-tool-calls";
+}
+export type ToolCallsGenerationFinishedEventResult = {
+    status: "success";
+    response: unknown;
+    value: unknown;
+    usage?: {
+        promptTokens: number;
+        completionTokens: number;
+        totalTokens: number;
+    };
+} | {
+    status: "error";
+    error: unknown;
+} | {
+    status: "abort";
+};
+export type ToolCallsGenerationFinishedEvent = BaseModelCallFinishedEvent & {
+    functionType: "generate-tool-calls";
+    result: ToolCallsGenerationFinishedEventResult;
+};

package/tool/{generate-tool-calls-or-text/ToolCallsOrTextGenerationModel.d.ts → generate-tool-calls/ToolCallsGenerationModel.d.ts}

@@ -1,10 +1,10 @@
 import { FunctionOptions } from "../../core/FunctionOptions.js";
 import { Model, ModelSettings } from "../../model-function/Model.js";
 import { ToolDefinition } from "../ToolDefinition.js";
-export interface ToolCallsOrTextGenerationModelSettings extends ModelSettings {
+export interface ToolCallsGenerationModelSettings extends ModelSettings {
 }
-export interface ToolCallsOrTextGenerationModel<PROMPT, SETTINGS extends ToolCallsOrTextGenerationModelSettings> extends Model<SETTINGS> {
-    doGenerateToolCallsOrText(tools: Array<ToolDefinition<string, unknown>>, prompt: PROMPT, options?: FunctionOptions): PromiseLike<{
+export interface ToolCallsGenerationModel<PROMPT, SETTINGS extends ToolCallsGenerationModelSettings> extends Model<SETTINGS> {
+    doGenerateToolCalls(tools: Array<ToolDefinition<string, unknown>>, prompt: PROMPT, options?: FunctionOptions): PromiseLike<{
         response: unknown;
         text: string | null;
         toolCalls: Array<{

package/tool/{generate-tool-calls-or-text/ToolCallsOrTextParseError.cjs → generate-tool-calls/ToolCallsParseError.cjs}

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ToolCallsOrTextParseError = void 0;
+exports.ToolCallsParseError = void 0;
 const getErrorMessage_js_1 = require("../../util/getErrorMessage.cjs");
-class ToolCallsOrTextParseError extends Error {
+class ToolCallsParseError extends Error {
     constructor({ valueText, cause }) {
-        super(`Tool calls or text parsing failed. ` +
+        super(`Tool calls parsing failed. ` +
             `Value: ${valueText}.\n` +
             `Error message: ${(0, getErrorMessage_js_1.getErrorMessage)(cause)}`);
         Object.defineProperty(this, "valueText", {
@@ -19,7 +19,7 @@ class ToolCallsOrTextParseError extends Error {
             writable: true,
             value: void 0
         });
-        this.name = "ToolCallsOrTextParseError";
+        this.name = "ToolCallsParseError";
         this.cause = cause;
         this.valueText = valueText;
     }
@@ -33,4 +33,4 @@ class ToolCallsOrTextParseError extends Error {
         };
     }
 }
-exports.ToolCallsOrTextParseError = ToolCallsOrTextParseError;
+exports.ToolCallsParseError = ToolCallsParseError;

package/tool/{generate-tool-calls-or-text/ToolCallsOrTextParseError.d.ts → generate-tool-calls/ToolCallsParseError.d.ts}

@@ -1,4 +1,4 @@
-export declare class ToolCallsOrTextParseError extends Error {
+export declare class ToolCallsParseError extends Error {
     readonly valueText: string;
     readonly cause: unknown;
     constructor({ valueText, cause }: {

package/tool/{generate-tool-calls-or-text/ToolCallsOrTextParseError.js → generate-tool-calls/ToolCallsParseError.js}

@@ -1,7 +1,7 @@
 import { getErrorMessage } from "../../util/getErrorMessage.js";
-export class ToolCallsOrTextParseError extends Error {
+export class ToolCallsParseError extends Error {
     constructor({ valueText, cause }) {
-        super(`Tool calls or text parsing failed. ` +
+        super(`Tool calls parsing failed. ` +
             `Value: ${valueText}.\n` +
             `Error message: ${getErrorMessage(cause)}`);
         Object.defineProperty(this, "valueText", {
@@ -16,7 +16,7 @@ export class ToolCallsOrTextParseError extends Error {
             writable: true,
             value: void 0
         });
-        this.name = "ToolCallsOrTextParseError";
+        this.name = "ToolCallsParseError";
         this.cause = cause;
         this.valueText = valueText;
     }

package/tool/{generate-tool-calls-or-text/ToolCallsOrGenerateTextPromptTemplate.d.ts → generate-tool-calls/ToolCallsPromptTemplate.d.ts}

@@ -1,5 +1,5 @@
 import { ToolDefinition } from "../ToolDefinition.js";
-export interface ToolCallsOrGenerateTextPromptTemplate<SOURCE_PROMPT, TARGET_PROMPT> {
+export interface ToolCallsPromptTemplate<SOURCE_PROMPT, TARGET_PROMPT> {
     createPrompt: (prompt: SOURCE_PROMPT, tools: Array<ToolDefinition<string, unknown>>) => TARGET_PROMPT;
     extractToolCallsAndText: (response: string) => {
         text: string | null;

package/tool/{generate-tool-calls-or-text/generateToolCallsOrText.cjs → generate-tool-calls/generateToolCalls.cjs}

@@ -1,21 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateToolCallsOrText = void 0;
+exports.generateToolCalls = void 0;
 const executeStandardCall_js_1 = require("../../model-function/executeStandardCall.cjs");
 const NoSuchToolDefinitionError_js_1 = require("../NoSuchToolDefinitionError.cjs");
 const ToolCallArgumentsValidationError_js_1 = require("../ToolCallArgumentsValidationError.cjs");
-async function generateToolCallsOrText(model, tools, prompt, options) {
+async function generateToolCalls(model, tools, prompt, options) {
     // Note: PROMPT must not be a function.
     const expandedPrompt = typeof prompt === "function"
         ? prompt(tools)
         : prompt;
     const fullResponse = await (0, executeStandardCall_js_1.executeStandardCall)({
-        functionType: "generate-tool-calls-or-text",
+        functionType: "generate-tool-calls",
         input: expandedPrompt,
         model,
         options,
         generateResponse: async (options) => {
-            const result = await model.doGenerateToolCallsOrText(tools, expandedPrompt, options);
+            const result = await model.doGenerateToolCalls(tools, expandedPrompt, options);
             const { text, toolCalls: rawToolCalls } = result;
             // no tool calls:
             if (rawToolCalls == null) {
@@ -60,4 +60,4 @@ async function generateToolCallsOrText(model, tools, prompt, options) {
     });
     return options?.fullResponse ? fullResponse : fullResponse.value;
 }
-exports.generateToolCallsOrText = generateToolCallsOrText;
+exports.generateToolCalls = generateToolCalls;

package/tool/{generate-tool-calls-or-text/generateToolCallsOrText.d.ts → generate-tool-calls/generateToolCalls.d.ts}

@@ -1,7 +1,7 @@
 import { FunctionOptions } from "../../core/FunctionOptions.js";
 import { ModelCallMetadata } from "../../model-function/ModelCallMetadata.js";
 import { ToolDefinition } from "../ToolDefinition.js";
-import { ToolCallsOrTextGenerationModel, ToolCallsOrTextGenerationModelSettings } from "./ToolCallsOrTextGenerationModel.js";
+import { ToolCallsGenerationModel, ToolCallsGenerationModelSettings } from "./ToolCallsGenerationModel.js";
 type ToolCallDefinitionArray<T extends ToolDefinition<any, any>[]> = T;
 type ToToolCallDefinitionMap<T extends ToolCallDefinitionArray<ToolDefinition<any, any>[]>> = {
     [K in T[number]["name"]]: Extract<T[number], ToolDefinition<K, any>>;
@@ -14,13 +14,13 @@ type ToToolCallUnion<T> = {
     } : never;
 }[keyof T];
 type ToOutputValue<TOOL_CALLS extends ToolCallDefinitionArray<ToolDefinition<any, any>[]>> = ToToolCallUnion<ToToolCallDefinitionMap<TOOL_CALLS>>;
-export declare function generateToolCallsOrText<TOOLS extends Array<ToolDefinition<any, any>>, PROMPT>(model: ToolCallsOrTextGenerationModel<PROMPT, ToolCallsOrTextGenerationModelSettings>, tools: TOOLS, prompt: PROMPT | ((tools: TOOLS) => PROMPT), options?: FunctionOptions & {
+export declare function generateToolCalls<TOOLS extends Array<ToolDefinition<any, any>>, PROMPT>(model: ToolCallsGenerationModel<PROMPT, ToolCallsGenerationModelSettings>, tools: TOOLS, prompt: PROMPT | ((tools: TOOLS) => PROMPT), options?: FunctionOptions & {
     fullResponse?: false;
 }): Promise<{
     text: string | null;
     toolCalls: Array<ToOutputValue<TOOLS>> | null;
 }>;
-export declare function generateToolCallsOrText<TOOLS extends ToolDefinition<any, any>[], PROMPT>(model: ToolCallsOrTextGenerationModel<PROMPT, ToolCallsOrTextGenerationModelSettings>, tools: TOOLS, prompt: PROMPT | ((tools: TOOLS) => PROMPT), options: FunctionOptions & {
+export declare function generateToolCalls<TOOLS extends ToolDefinition<any, any>[], PROMPT>(model: ToolCallsGenerationModel<PROMPT, ToolCallsGenerationModelSettings>, tools: TOOLS, prompt: PROMPT | ((tools: TOOLS) => PROMPT), options: FunctionOptions & {
     fullResponse?: boolean;
 }): Promise<{
     value: {

package/tool/{generate-tool-calls-or-text/generateToolCallsOrText.js → generate-tool-calls/generateToolCalls.js}

@@ -1,18 +1,18 @@
 import { executeStandardCall } from "../../model-function/executeStandardCall.js";
 import { NoSuchToolDefinitionError } from "../NoSuchToolDefinitionError.js";
 import { ToolCallArgumentsValidationError } from "../ToolCallArgumentsValidationError.js";
-export async function generateToolCallsOrText(model, tools, prompt, options) {
+export async function generateToolCalls(model, tools, prompt, options) {
     // Note: PROMPT must not be a function.
     const expandedPrompt = typeof prompt === "function"
         ? prompt(tools)
         : prompt;
     const fullResponse = await executeStandardCall({
-        functionType: "generate-tool-calls-or-text",
+        functionType: "generate-tool-calls",
         input: expandedPrompt,
         model,
         options,
         generateResponse: async (options) => {
-            const result = await model.doGenerateToolCallsOrText(tools, expandedPrompt, options);
+            const result = await model.doGenerateToolCalls(tools, expandedPrompt, options);
             const { text, toolCalls: rawToolCalls } = result;
             // no tool calls:
             if (rawToolCalls == null) {

package/tool/{generate-tool-calls-or-text → generate-tool-calls}/index.cjs

@@ -14,9 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./TextGenerationToolCallsOrGenerateTextModel.cjs"), exports);
-__exportStar(require("./ToolCallsOrGenerateTextPromptTemplate.cjs"), exports);
-__exportStar(require("./ToolCallsOrTextGenerationEvent.cjs"), exports);
-__exportStar(require("./ToolCallsOrTextGenerationModel.cjs"), exports);
-__exportStar(require("./ToolCallsOrTextParseError.cjs"), exports);
-__exportStar(require("./generateToolCallsOrText.cjs"), exports);
+__exportStar(require("./TextGenerationToolCallsModel.cjs"), exports);
+__exportStar(require("./ToolCallsGenerationEvent.cjs"), exports);
+__exportStar(require("./ToolCallsGenerationModel.cjs"), exports);
+__exportStar(require("./ToolCallsPromptTemplate.cjs"), exports);
+__exportStar(require("./ToolCallsParseError.cjs"), exports);
+__exportStar(require("./generateToolCalls.cjs"), exports);

package/tool/generate-tool-calls/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./TextGenerationToolCallsModel.js";
+export * from "./ToolCallsGenerationEvent.js";
+export * from "./ToolCallsGenerationModel.js";
+export * from "./ToolCallsPromptTemplate.js";
+export * from "./ToolCallsParseError.js";
+export * from "./generateToolCalls.js";

package/tool/generate-tool-calls/index.js

@@ -0,0 +1,6 @@
+export * from "./TextGenerationToolCallsModel.js";
+export * from "./ToolCallsGenerationEvent.js";
+export * from "./ToolCallsGenerationModel.js";
+export * from "./ToolCallsPromptTemplate.js";
+export * from "./ToolCallsParseError.js";
+export * from "./generateToolCalls.js";

package/tool/index.cjs

@@ -14,7 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./InvalidToolNameError.cjs"), exports);
 __exportStar(require("./NoSuchToolDefinitionError.cjs"), exports);
 __exportStar(require("./Tool.cjs"), exports);
 __exportStar(require("./ToolCall.cjs"), exports);
@@ -27,6 +26,6 @@ __exportStar(require("./ToolExecutionError.cjs"), exports);
 __exportStar(require("./WebSearchTool.cjs"), exports);
 __exportStar(require("./execute-tool/index.cjs"), exports);
 __exportStar(require("./generate-tool-call/index.cjs"), exports);
-__exportStar(require("./generate-tool-calls-or-text/index.cjs"), exports);
+__exportStar(require("./generate-tool-calls/index.cjs"), exports);
 __exportStar(require("./use-tool/index.cjs"), exports);
-__exportStar(require("./use-tools-or-generate-text/index.cjs"), exports);
+__exportStar(require("./use-tools/index.cjs"), exports);

package/tool/index.d.ts

@@ -1,4 +1,3 @@
-export * from "./InvalidToolNameError.js";
 export * from "./NoSuchToolDefinitionError.js";
 export * from "./Tool.js";
 export * from "./ToolCall.js";
@@ -11,6 +10,6 @@ export * from "./ToolExecutionError.js";
 export * from "./WebSearchTool.js";
 export * from "./execute-tool/index.js";
 export * from "./generate-tool-call/index.js";
-export * from "./generate-tool-calls-or-text/index.js";
+export * from "./generate-tool-calls/index.js";
 export * from "./use-tool/index.js";
-export * from "./use-tools-or-generate-text/index.js";
+export * from "./use-tools/index.js";

package/tool/index.js

@@ -1,4 +1,3 @@
-export * from "./InvalidToolNameError.js";
 export * from "./NoSuchToolDefinitionError.js";
 export * from "./Tool.js";
 export * from "./ToolCall.js";
@@ -11,6 +10,6 @@ export * from "./ToolExecutionError.js";
 export * from "./WebSearchTool.js";
 export * from "./execute-tool/index.js";
 export * from "./generate-tool-call/index.js";
-export * from "./generate-tool-calls-or-text/index.js";
+export * from "./generate-tool-calls/index.js";
 export * from "./use-tool/index.js";
-export * from "./use-tools-or-generate-text/index.js";
+export * from "./use-tools/index.js";

package/tool/use-tools/UseToolsEvent.d.ts

@@ -0,0 +1,7 @@
+import { BaseFunctionFinishedEvent, BaseFunctionStartedEvent } from "../../core/FunctionEvent.js";
+export interface useToolsStartedEvent extends BaseFunctionStartedEvent {
+    functionType: "use-tools";
+}
+export interface useToolsFinishedEvent extends BaseFunctionFinishedEvent {
+    functionType: "use-tools";
+}

package/tool/{use-tools-or-generate-text → use-tools}/index.cjs

@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./UseToolsOrGenerateTextEvent.cjs"), exports);
-__exportStar(require("./useToolsOrGenerateText.cjs"), exports);
+__exportStar(require("./UseToolsEvent.cjs"), exports);
+__exportStar(require("./useTools.cjs"), exports);

package/tool/use-tools/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./UseToolsEvent.js";
+export * from "./useTools.js";

package/tool/use-tools/index.js

@@ -0,0 +1,2 @@
+export * from "./UseToolsEvent.js";
+export * from "./useTools.js";

package/tool/{use-tools-or-generate-text/useToolsOrGenerateText.cjs → use-tools/useTools.cjs}

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useToolsOrGenerateText = void 0;
+exports.useTools = void 0;
 const executeFunctionCall_js_1 = require("../../core/executeFunctionCall.cjs");
 const ToolCallError_js_1 = require("../ToolCallError.cjs");
 const safeExecuteToolCall_js_1 = require("../execute-tool/safeExecuteToolCall.cjs");
-const generateToolCallsOrText_js_1 = require("../generate-tool-calls-or-text/generateToolCallsOrText.cjs");
-async function useToolsOrGenerateText(model, tools, prompt, options) {
+const generateToolCalls_js_1 = require("../generate-tool-calls/generateToolCalls.cjs");
+async function useTools(model, tools, prompt, options) {
     // Note: PROMPT must not be a function.
     const expandedPrompt = typeof prompt === "function"
         ? prompt(tools)
@@ -13,9 +13,9 @@ async function useToolsOrGenerateText(model, tools, prompt, options) {
     return (0, executeFunctionCall_js_1.executeFunctionCall)({
         options,
         input: expandedPrompt,
-        functionType: "use-tools-or-generate-text",
+        functionType: "use-tools",
         execute: async (options) => {
-            const modelResponse = await (0, generateToolCallsOrText_js_1.generateToolCallsOrText)(model, tools, expandedPrompt, { ...options, fullResponse: false });
+            const modelResponse = await (0, generateToolCalls_js_1.generateToolCalls)(model, tools, expandedPrompt, { ...options, fullResponse: false });
             const { toolCalls, text } = modelResponse;
             // no tool calls:
             if (toolCalls == null) {
@@ -45,4 +45,4 @@ async function useToolsOrGenerateText(model, tools, prompt, options) {
         },
     });
 }
-exports.useToolsOrGenerateText = useToolsOrGenerateText;
+exports.useTools = useTools;

package/tool/{use-tools-or-generate-text/useToolsOrGenerateText.d.ts → use-tools/useTools.d.ts}

@@ -1,7 +1,7 @@
 import { FunctionOptions } from "../../core/FunctionOptions.js";
 import { Tool } from "../Tool.js";
 import { ToolCallResult } from "../ToolCallResult.js";
-import { ToolCallsOrTextGenerationModel, ToolCallsOrTextGenerationModelSettings } from "../generate-tool-calls-or-text/ToolCallsOrTextGenerationModel.js";
+import { ToolCallsGenerationModel, ToolCallsGenerationModelSettings } from "../generate-tool-calls/ToolCallsGenerationModel.js";
 type ToolArray<T extends Tool<any, any, any>[]> = T;
 type ToToolMap<T extends ToolArray<Tool<any, any, any>[]>> = {
     [K in T[number]["name"]]: Extract<T[number], Tool<K, any, any>>;
@@ -11,7 +11,7 @@ type ToToolCallUnion<T> = {
     [KEY in StringKeys<T>]: T[KEY] extends Tool<any, infer PARAMETERS, infer OUTPUT> ? ToolCallResult<KEY, PARAMETERS, OUTPUT> : never;
 }[StringKeys<T>];
 type ToOutputValue<TOOLS extends ToolArray<Tool<any, any, any>[]>> = ToToolCallUnion<ToToolMap<TOOLS>>;
-export declare function useToolsOrGenerateText<PROMPT, TOOLS extends Array<Tool<any, any, any>>>(model: ToolCallsOrTextGenerationModel<PROMPT, ToolCallsOrTextGenerationModelSettings>, tools: TOOLS, prompt: PROMPT | ((tools: TOOLS) => PROMPT), options?: FunctionOptions): Promise<{
+export declare function useTools<PROMPT, TOOLS extends Array<Tool<any, any, any>>>(model: ToolCallsGenerationModel<PROMPT, ToolCallsGenerationModelSettings>, tools: TOOLS, prompt: PROMPT | ((tools: TOOLS) => PROMPT), options?: FunctionOptions): Promise<{
     text: string | null;
     toolResults: Array<ToOutputValue<TOOLS>> | null;
 }>;

package/tool/{use-tools-or-generate-text/useToolsOrGenerateText.js → use-tools/useTools.js}

@@ -1,8 +1,8 @@
 import { executeFunctionCall } from "../../core/executeFunctionCall.js";
 import { ToolCallError } from "../ToolCallError.js";
 import { safeExecuteToolCall } from "../execute-tool/safeExecuteToolCall.js";
-import { generateToolCallsOrText } from "../generate-tool-calls-or-text/generateToolCallsOrText.js";
-export async function useToolsOrGenerateText(model, tools, prompt, options) {
+import { generateToolCalls } from "../generate-tool-calls/generateToolCalls.js";
+export async function useTools(model, tools, prompt, options) {
     // Note: PROMPT must not be a function.
     const expandedPrompt = typeof prompt === "function"
         ? prompt(tools)
@@ -10,9 +10,9 @@ export async function useToolsOrGenerateText(model, tools, prompt, options) {
     return executeFunctionCall({
         options,
         input: expandedPrompt,
-        functionType: "use-tools-or-generate-text",
+        functionType: "use-tools",
         execute: async (options) => {
-            const modelResponse = await generateToolCallsOrText(model, tools, expandedPrompt, { ...options, fullResponse: false });
+            const modelResponse = await generateToolCalls(model, tools, expandedPrompt, { ...options, fullResponse: false });
             const { toolCalls, text } = modelResponse;
             // no tool calls:
             if (toolCalls == null) {

package/tool/InvalidToolNameError.cjs

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidToolNameError = void 0;
-class InvalidToolNameError extends Error {
-    constructor({ toolName, namePattern, }) {
-        super(`Invalid tool name '${toolName}'. The tool name must match the regular expression pattern ${namePattern}.`);
-        Object.defineProperty(this, "toolName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.name = "InvalidToolNameError";
-        this.toolName = toolName;
-    }
-}
-exports.InvalidToolNameError = InvalidToolNameError;

package/tool/InvalidToolNameError.d.ts

@@ -1,7 +0,0 @@
-export declare class InvalidToolNameError extends Error {
-    readonly toolName: string;
-    constructor({ toolName, namePattern, }: {
-        toolName: string;
-        namePattern: RegExp;
-    });
-}

package/tool/InvalidToolNameError.js

@@ -1,13 +0,0 @@
-export class InvalidToolNameError extends Error {
-    constructor({ toolName, namePattern, }) {
-        super(`Invalid tool name '${toolName}'. The tool name must match the regular expression pattern ${namePattern}.`);
-        Object.defineProperty(this, "toolName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.name = "InvalidToolNameError";
-        this.toolName = toolName;
-    }
-}