modelfusion 0.30.1 → 0.31.0

package/README.md

@@ -82,7 +82,7 @@ const text = await generateText(
   new LlamaCppTextGenerationModel({
     contextWindowSize: 4096, // Llama 2 context window size
     maxCompletionTokens: 1000,
-  }).withPromptFormat(Llama2InstructionPromptFormat()),
+  }).withPromptFormat(mapInstructionPromptToLlama2Format()),
   {
     system: "You are a story writer.",
     instruction: "Write a short story about a robot learning to love.",
@@ -94,7 +94,7 @@ const text = await generateText(
 const textStream = await streamText(
   new OpenAIChatModel({
     model: "gpt-3.5-turbo",
-  }).withPromptFormat(OpenAIChatChatPromptFormat()),
+  }).withPromptFormat(mapChatPromptToOpenAIChatFormat()),
   [
     { system: "You are a celebrated poet." },
     { user: "Write a short story about a robot learning to love." },
@@ -155,7 +155,7 @@ const sentiment = await generateStructure(
         .describe("Sentiment."),
     }),
   }),
-  OpenAIChatFunctionPrompt.forStructureCurried([
+  [
     OpenAIChatMessage.system(
       "You are a sentiment evaluator. " +
         "Analyze the sentiment of the following product review:"
@@ -164,7 +164,7 @@ const sentiment = await generateStructure(
       "After I opened the package, I was met by a very unpleasant smell " +
         "that did not disappear even after washing. Never again!"
     ),
-  ])
+  ]
 );
 ```
 
@@ -197,7 +197,7 @@ const { structure, value, text } = await generateStructureOrText(
       }),
     }),
   ],
-  OpenAIChatFunctionPrompt.forStructuresCurried([OpenAIChatMessage.user(query)])
+  [OpenAIChatMessage.user(query)]
 );
 ```
 
@@ -253,9 +253,7 @@ The model determines the parameters for the tool from the prompt and then execut
 const { tool, parameters, result } = await useTool(
   new OpenAIChatModel({ model: "gpt-3.5-turbo" }),
   calculator,
-  OpenAIChatFunctionPrompt.forToolCurried([
-    OpenAIChatMessage.user("What's fourteen times twelve?"),
-  ])
+  [OpenAIChatMessage.user("What's fourteen times twelve?")]
 );
 ```
 
@@ -268,9 +266,7 @@ Text is generated as a fallback.
 const { tool, parameters, result, text } = await useToolOrGenerateText(
   new OpenAIChatModel({ model: "gpt-3.5-turbo" }),
   [calculator /* and other tools... */],
-  OpenAIChatFunctionPrompt.forToolsCurried([
-    OpenAIChatMessage.user("What's fourteen times twelve?"),
-  ])
+  [OpenAIChatMessage.user("What's fourteen times twelve?")]
 );
 ```
 

package/model-function/SuccessfulModelCall.cjs

@@ -2,15 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractSuccessfulModelCalls = void 0;
 function extractSuccessfulModelCalls(runFunctionEvents) {
-    return runFunctionEvents
-        .filter((event) => "result" in event &&
+    return runFunctionEvents.filter((event) => "result" in event &&
         "status" in event.result &&
-        event.result.status === "success")
-        .map((event) => ({
-        model: event.model,
-        settings: event.settings,
-        response: event.result.response,
-        type: event.functionType,
-    }));
+        event.result.status === "success");
 }
 exports.extractSuccessfulModelCalls = extractSuccessfulModelCalls;

package/model-function/SuccessfulModelCall.d.ts

@@ -1,9 +1,12 @@
 import { FunctionEvent } from "../core/FunctionEvent.js";
-import { ModelInformation } from "./ModelInformation.js";
-export type SuccessfulModelCall = {
-    type: "image-description" | "image-generation" | "structure-generation" | "structure-or-text-generation" | "speech-synthesis" | "text-embedding" | "text-generation" | "text-streaming" | "transcription";
-    model: ModelInformation;
-    settings: unknown;
-    response: unknown;
+import { ModelCallFinishedEvent } from "./ModelCallEvent.js";
+export type SuccessfulModelCall = ModelCallFinishedEvent & {
+    result: {
+        status: "success";
+    };
 };
-export declare function extractSuccessfulModelCalls(runFunctionEvents: FunctionEvent[]): SuccessfulModelCall[];
+export declare function extractSuccessfulModelCalls(runFunctionEvents: FunctionEvent[]): (ModelCallFinishedEvent & {
+    result: {
+        status: "success";
+    };
+})[];

package/model-function/SuccessfulModelCall.js

@@ -1,12 +1,5 @@
 export function extractSuccessfulModelCalls(runFunctionEvents) {
-    return runFunctionEvents
-        .filter((event) => "result" in event &&
+    return runFunctionEvents.filter((event) => "result" in event &&
         "status" in event.result &&
-        event.result.status === "success")
-        .map((event) => ({
-        model: event.model,
-        settings: event.settings,
-        response: event.result.response,
-        type: event.functionType,
-    }));
+        event.result.status === "success");
 }

package/model-function/generate-structure/StructureFromTextGenerationModel.cjs

@@ -28,8 +28,8 @@ class StructureFromTextGenerationModel {
     get settingsForEvent() {
         return this.model.settingsForEvent;
     }
-    async generateStructureResponse(prompt, options) {
-        return await (0, generateText_js_1.generateText)(this.model, this.format.createPrompt(prompt), options);
+    async generateStructureResponse(structure, prompt, options) {
+        return await (0, generateText_js_1.generateText)(this.model, this.format.createPrompt(prompt, structure), options);
     }
     extractStructure(response) {
         return this.format.extractStructure(response);

package/model-function/generate-structure/StructureFromTextGenerationModel.d.ts

@@ -1,26 +1,22 @@
 import { TextGenerationModel, TextGenerationModelSettings } from "../generate-text/TextGenerationModel.js";
 import { StructureDefinition } from "../../core/structure/StructureDefinition.js";
-import { InstructionWithStructure } from "./InstructionWithStructurePrompt.js";
 import { StructureGenerationModel } from "./StructureGenerationModel.js";
 import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
-export type StructureFromTextPromptFormat = {
-    createPrompt: (prompt: {
-        instruction: string;
-        structure: StructureDefinition<string, unknown>;
-    }) => string;
+export type StructureFromTextPromptFormat<PROMPT> = {
+    createPrompt: (prompt: PROMPT, structure: StructureDefinition<string, unknown>) => string;
     extractStructure: (response: string) => unknown;
 };
-export declare class StructureFromTextGenerationModel<MODEL extends TextGenerationModel<string, any, any, TextGenerationModelSettings>> implements StructureGenerationModel<InstructionWithStructure<string, unknown>, string, MODEL["settings"]> {
+export declare class StructureFromTextGenerationModel<PROMPT, MODEL extends TextGenerationModel<string, any, any, TextGenerationModelSettings>> implements StructureGenerationModel<PROMPT, string, MODEL["settings"]> {
     private readonly model;
     private readonly format;
     constructor({ model, format, }: {
         model: MODEL;
-        format: StructureFromTextPromptFormat;
+        format: StructureFromTextPromptFormat<PROMPT>;
     });
     get modelInformation(): import("../ModelInformation.js").ModelInformation;
     get settings(): TextGenerationModelSettings;
     get settingsForEvent(): Partial<MODEL["settings"]>;
-    generateStructureResponse(prompt: InstructionWithStructure<string, unknown>, options?: ModelFunctionOptions<MODEL["settings"]> | undefined): Promise<string>;
+    generateStructureResponse(structure: StructureDefinition<string, unknown>, prompt: PROMPT, options?: ModelFunctionOptions<MODEL["settings"]> | undefined): Promise<string>;
     extractStructure(response: string): unknown;
     withSettings(additionalSettings: Partial<MODEL["settings"]>): this;
 }

package/model-function/generate-structure/StructureFromTextGenerationModel.js

@@ -25,8 +25,8 @@ export class StructureFromTextGenerationModel {
     get settingsForEvent() {
         return this.model.settingsForEvent;
     }
-    async generateStructureResponse(prompt, options) {
-        return await generateText(this.model, this.format.createPrompt(prompt), options);
+    async generateStructureResponse(structure, prompt, options) {
+        return await generateText(this.model, this.format.createPrompt(prompt, structure), options);
     }
     extractStructure(response) {
         return this.format.extractStructure(response);

package/model-function/generate-structure/StructureGenerationModel.d.ts

@@ -1,9 +1,10 @@
-import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
+import { StructureDefinition } from "../../core/structure/StructureDefinition.js";
 import { Model, ModelSettings } from "../Model.js";
+import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
 export interface StructureGenerationModelSettings extends ModelSettings {
 }
 export interface StructureGenerationModel<PROMPT, RESPONSE, SETTINGS extends StructureGenerationModelSettings> extends Model<SETTINGS> {
-    generateStructureResponse(prompt: PROMPT, options?: ModelFunctionOptions<SETTINGS>): PromiseLike<RESPONSE>;
+    generateStructureResponse(structure: StructureDefinition<string, unknown>, prompt: PROMPT, options?: ModelFunctionOptions<SETTINGS>): PromiseLike<RESPONSE>;
     extractStructure(response: RESPONSE): unknown;
     extractUsage?(response: RESPONSE): {
         promptTokens: number;

package/model-function/generate-structure/StructureOrTextGenerationModel.d.ts

@@ -1,8 +1,10 @@
-import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
+import { StructureDefinition } from "../../core/structure/StructureDefinition.js";
 import { Model, ModelSettings } from "../Model.js";
+import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
 export interface StructureOrTextGenerationModelSettings extends ModelSettings {
 }
-export interface StructureOrTextGenerationPrompt<RESPONSE> {
+export interface StructureOrTextGenerationModel<PROMPT, RESPONSE, SETTINGS extends StructureOrTextGenerationModelSettings> extends Model<SETTINGS> {
+    generateStructureOrTextResponse(structureDefinitions: Array<StructureDefinition<string, unknown>>, prompt: PROMPT, options?: ModelFunctionOptions<SETTINGS>): PromiseLike<RESPONSE>;
     extractStructureAndText(response: RESPONSE): {
         structure: null;
         value: null;
@@ -12,9 +14,6 @@ export interface StructureOrTextGenerationPrompt<RESPONSE> {
         value: unknown;
         text: string | null;
     };
-}
-export interface StructureOrTextGenerationModel<PROMPT, RESPONSE, SETTINGS extends StructureOrTextGenerationModelSettings> extends Model<SETTINGS> {
-    generateStructureResponse(prompt: PROMPT & StructureOrTextGenerationPrompt<RESPONSE>, options?: ModelFunctionOptions<SETTINGS>): PromiseLike<RESPONSE>;
     extractUsage?(response: RESPONSE): {
         promptTokens: number;
         completionTokens: number;

package/model-function/generate-structure/generateStructure.cjs

@@ -4,13 +4,16 @@ exports.generateStructure = void 0;
 const executeCall_js_1 = require("../executeCall.cjs");
 const StructureValidationError_js_1 = require("./StructureValidationError.cjs");
 function generateStructure(model, structureDefinition, prompt, options) {
-    const expandedPrompt = prompt(structureDefinition);
+    // Note: PROMPT must not be a function.
+    const expandedPrompt = typeof prompt === "function"
+        ? prompt(structureDefinition)
+        : prompt;
     return (0, executeCall_js_1.executeCall)({
         functionType: "structure-generation",
         input: expandedPrompt,
         model,
         options,
-        generateResponse: (options) => model.generateStructureResponse(expandedPrompt, options),
+        generateResponse: (options) => model.generateStructureResponse(structureDefinition, expandedPrompt, options),
         extractOutputValue: (response) => {
             const structure = model.extractStructure(response);
             const parseResult = structureDefinition.schema.validate(structure);

package/model-function/generate-structure/generateStructure.d.ts

@@ -2,4 +2,4 @@ import { StructureDefinition } from "../../core/structure/StructureDefinition.js
 import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
 import { ModelFunctionPromise } from "../executeCall.js";
 import { StructureGenerationModel, StructureGenerationModelSettings } from "./StructureGenerationModel.js";
-export declare function generateStructure<STRUCTURE, PROMPT, RESPONSE, NAME extends string, SETTINGS extends StructureGenerationModelSettings>(model: StructureGenerationModel<PROMPT, RESPONSE, SETTINGS>, structureDefinition: StructureDefinition<NAME, STRUCTURE>, prompt: (structureDefinition: StructureDefinition<NAME, STRUCTURE>) => PROMPT, options?: ModelFunctionOptions<SETTINGS>): ModelFunctionPromise<STRUCTURE, RESPONSE>;
+export declare function generateStructure<STRUCTURE, PROMPT, RESPONSE, NAME extends string, SETTINGS extends StructureGenerationModelSettings>(model: StructureGenerationModel<PROMPT, RESPONSE, SETTINGS>, structureDefinition: StructureDefinition<NAME, STRUCTURE>, prompt: PROMPT | ((structureDefinition: StructureDefinition<NAME, STRUCTURE>) => PROMPT), options?: ModelFunctionOptions<SETTINGS>): ModelFunctionPromise<STRUCTURE, RESPONSE>;

package/model-function/generate-structure/generateStructure.js

@@ -1,13 +1,16 @@
 import { executeCall } from "../executeCall.js";
 import { StructureValidationError } from "./StructureValidationError.js";
 export function generateStructure(model, structureDefinition, prompt, options) {
-    const expandedPrompt = prompt(structureDefinition);
+    // Note: PROMPT must not be a function.
+    const expandedPrompt = typeof prompt === "function"
+        ? prompt(structureDefinition)
+        : prompt;
     return executeCall({
         functionType: "structure-generation",
         input: expandedPrompt,
         model,
         options,
-        generateResponse: (options) => model.generateStructureResponse(expandedPrompt, options),
+        generateResponse: (options) => model.generateStructureResponse(structureDefinition, expandedPrompt, options),
         extractOutputValue: (response) => {
             const structure = model.extractStructure(response);
             const parseResult = structureDefinition.schema.validate(structure);

package/model-function/generate-structure/generateStructureOrText.cjs

@@ -4,21 +4,24 @@ exports.generateStructureOrText = void 0;
 const executeCall_js_1 = require("../executeCall.cjs");
 const NoSuchStructureError_js_1 = require("./NoSuchStructureError.cjs");
 const StructureValidationError_js_1 = require("./StructureValidationError.cjs");
-function generateStructureOrText(model, structures, prompt, options) {
-    const expandedPrompt = prompt(structures);
+function generateStructureOrText(model, structureDefinitions, prompt, options) {
+    // Note: PROMPT must not be a function.
+    const expandedPrompt = typeof prompt === "function"
+        ? prompt(structureDefinitions)
+        : prompt;
     return (0, executeCall_js_1.executeCall)({
         functionType: "structure-or-text-generation",
         input: expandedPrompt,
         model,
         options,
-        generateResponse: (options) => model.generateStructureResponse(expandedPrompt, options),
+        generateResponse: (options) => model.generateStructureOrTextResponse(structureDefinitions, expandedPrompt, options),
         extractOutputValue: (response) => {
-            const { structure, value, text } = expandedPrompt.extractStructureAndText(response);
+            const { structure, value, text } = model.extractStructureAndText(response);
             // text generation:
             if (structure == null) {
                 return { structure, value, text };
             }
-            const definition = structures.find((d) => d.name === structure);
+            const definition = structureDefinitions.find((d) => d.name === structure);
             if (definition == undefined) {
                 throw new NoSuchStructureError_js_1.NoSuchStructureError(structure);
             }

package/model-function/generate-structure/generateStructureOrText.d.ts

@@ -1,6 +1,6 @@
 import { ModelFunctionOptions } from "../ModelFunctionOptions.js";
 import { ModelFunctionPromise } from "../executeCall.js";
-import { StructureOrTextGenerationModel, StructureOrTextGenerationModelSettings, StructureOrTextGenerationPrompt } from "./StructureOrTextGenerationModel.js";
+import { StructureOrTextGenerationModel, StructureOrTextGenerationModelSettings } from "./StructureOrTextGenerationModel.js";
 import { StructureDefinition } from "../../core/structure/StructureDefinition.js";
 type StructureDefinitionArray<T extends StructureDefinition<any, any>[]> = T;
 type ToStructureDefinitionMap<T extends StructureDefinitionArray<StructureDefinition<any, any>[]>> = {
@@ -14,7 +14,7 @@ type ToStructureUnion<T> = {
     } : never;
 }[keyof T];
 type ToOutputValue<STRUCTURES extends StructureDefinitionArray<StructureDefinition<any, any>[]>> = ToStructureUnion<ToStructureDefinitionMap<STRUCTURES>>;
-export declare function generateStructureOrText<STRUCTURES extends StructureDefinition<any, any>[], PROMPT, RESPONSE, SETTINGS extends StructureOrTextGenerationModelSettings>(model: StructureOrTextGenerationModel<PROMPT, RESPONSE, SETTINGS>, structures: STRUCTURES, prompt: (structures: STRUCTURES) => PROMPT & StructureOrTextGenerationPrompt<RESPONSE>, options?: ModelFunctionOptions<SETTINGS>): ModelFunctionPromise<{
+export declare function generateStructureOrText<STRUCTURES extends StructureDefinition<any, any>[], PROMPT, RESPONSE, SETTINGS extends StructureOrTextGenerationModelSettings>(model: StructureOrTextGenerationModel<PROMPT, RESPONSE, SETTINGS>, structureDefinitions: STRUCTURES, prompt: PROMPT | ((structureDefinitions: STRUCTURES) => PROMPT), options?: ModelFunctionOptions<SETTINGS>): ModelFunctionPromise<{
     structure: null;
     value: null;
     text: string;

package/model-function/generate-structure/generateStructureOrText.js

@@ -1,21 +1,24 @@
 import { executeCall } from "../executeCall.js";
 import { NoSuchStructureError } from "./NoSuchStructureError.js";
 import { StructureValidationError } from "./StructureValidationError.js";
-export function generateStructureOrText(model, structures, prompt, options) {
-    const expandedPrompt = prompt(structures);
+export function generateStructureOrText(model, structureDefinitions, prompt, options) {
+    // Note: PROMPT must not be a function.
+    const expandedPrompt = typeof prompt === "function"
+        ? prompt(structureDefinitions)
+        : prompt;
     return executeCall({
         functionType: "structure-or-text-generation",
         input: expandedPrompt,
         model,
         options,
-        generateResponse: (options) => model.generateStructureResponse(expandedPrompt, options),
+        generateResponse: (options) => model.generateStructureOrTextResponse(structureDefinitions, expandedPrompt, options),
         extractOutputValue: (response) => {
-            const { structure, value, text } = expandedPrompt.extractStructureAndText(response);
+            const { structure, value, text } = model.extractStructureAndText(response);
             // text generation:
             if (structure == null) {
                 return { structure, value, text };
             }
-            const definition = structures.find((d) => d.name === structure);
+            const definition = structureDefinitions.find((d) => d.name === structure);
             if (definition == undefined) {
                 throw new NoSuchStructureError(structure);
             }

package/model-function/index.cjs

@@ -28,12 +28,11 @@ __exportStar(require("./embed-text/embedText.cjs"), exports);
 __exportStar(require("./generate-image/ImageGenerationEvent.cjs"), exports);
 __exportStar(require("./generate-image/ImageGenerationModel.cjs"), exports);
 __exportStar(require("./generate-image/generateImage.cjs"), exports);
-__exportStar(require("./generate-structure/InstructionWithStructurePrompt.cjs"), exports);
+__exportStar(require("./generate-structure/NoSuchStructureError.cjs"), exports);
+__exportStar(require("./generate-structure/StructureFromTextGenerationModel.cjs"), exports);
 __exportStar(require("./generate-structure/StructureGenerationEvent.cjs"), exports);
 __exportStar(require("./generate-structure/StructureGenerationModel.cjs"), exports);
 __exportStar(require("./generate-structure/StructureOrTextGenerationModel.cjs"), exports);
-__exportStar(require("./generate-structure/StructureFromTextGenerationModel.cjs"), exports);
-__exportStar(require("./generate-structure/NoSuchStructureError.cjs"), exports);
 __exportStar(require("./generate-structure/StructureValidationError.cjs"), exports);
 __exportStar(require("./generate-structure/generateStructure.cjs"), exports);
 __exportStar(require("./generate-structure/generateStructureOrText.cjs"), exports);

package/model-function/index.d.ts

@@ -12,12 +12,11 @@ export * from "./embed-text/embedText.js";
 export * from "./generate-image/ImageGenerationEvent.js";
 export * from "./generate-image/ImageGenerationModel.js";
 export * from "./generate-image/generateImage.js";
-export * from "./generate-structure/InstructionWithStructurePrompt.js";
+export * from "./generate-structure/NoSuchStructureError.js";
+export * from "./generate-structure/StructureFromTextGenerationModel.js";
 export * from "./generate-structure/StructureGenerationEvent.js";
 export * from "./generate-structure/StructureGenerationModel.js";
 export * from "./generate-structure/StructureOrTextGenerationModel.js";
-export * from "./generate-structure/StructureFromTextGenerationModel.js";
-export * from "./generate-structure/NoSuchStructureError.js";
 export * from "./generate-structure/StructureValidationError.js";
 export * from "./generate-structure/generateStructure.js";
 export * from "./generate-structure/generateStructureOrText.js";

package/model-function/index.js

@@ -12,12 +12,11 @@ export * from "./embed-text/embedText.js";
 export * from "./generate-image/ImageGenerationEvent.js";
 export * from "./generate-image/ImageGenerationModel.js";
 export * from "./generate-image/generateImage.js";
-export * from "./generate-structure/InstructionWithStructurePrompt.js";
+export * from "./generate-structure/NoSuchStructureError.js";
+export * from "./generate-structure/StructureFromTextGenerationModel.js";
 export * from "./generate-structure/StructureGenerationEvent.js";
 export * from "./generate-structure/StructureGenerationModel.js";
 export * from "./generate-structure/StructureOrTextGenerationModel.js";
-export * from "./generate-structure/StructureFromTextGenerationModel.js";
-export * from "./generate-structure/NoSuchStructureError.js";
 export * from "./generate-structure/StructureValidationError.js";
 export * from "./generate-structure/generateStructure.js";
 export * from "./generate-structure/generateStructureOrText.js";

package/model-provider/openai/OpenAICostCalculator.cjs

@@ -16,7 +16,7 @@ class OpenAICostCalculator {
         });
     }
     async calculateCostInMillicents(call) {
-        const type = call.type;
+        const type = call.functionType;
         const model = call.model.modelName;
         switch (type) {
             case "image-generation": {
@@ -31,7 +31,7 @@ class OpenAICostCalculator {
                 if ((0, OpenAITextEmbeddingModel_js_1.isOpenAIEmbeddingModel)(model)) {
                     return (0, OpenAITextEmbeddingModel_js_1.calculateOpenAIEmbeddingCostInMillicents)({
                         model,
-                        responses: call.response,
+                        responses: call.result.response,
                     });
                 }
                 break;
@@ -44,13 +44,13 @@ class OpenAICostCalculator {
                 if ((0, OpenAIChatModel_js_1.isOpenAIChatModel)(model)) {
                     return (0, OpenAIChatModel_js_1.calculateOpenAIChatCostInMillicents)({
                         model,
-                        response: call.response,
+                        response: call.result.response,
                     });
                 }
                 if ((0, OpenAITextGenerationModel_js_1.isOpenAITextGenerationModel)(model)) {
                     return (0, OpenAITextGenerationModel_js_1.calculateOpenAITextGenerationCostInMillicents)({
                         model,
-                        response: call.response,
+                        response: call.result.response,
                     });
                 }
                 break;
@@ -61,7 +61,8 @@ class OpenAICostCalculator {
                 }
                 return (0, OpenAITranscriptionModel_js_1.calculateOpenAITranscriptionCostInMillicents)({
                     model: model,
-                    response: call.response,
+                    response: call.result
+                        .response,
                 });
             }
         }

package/model-provider/openai/OpenAICostCalculator.js

@@ -13,7 +13,7 @@ export class OpenAICostCalculator {
         });
     }
     async calculateCostInMillicents(call) {
-        const type = call.type;
+        const type = call.functionType;
         const model = call.model.modelName;
         switch (type) {
             case "image-generation": {
@@ -28,7 +28,7 @@ export class OpenAICostCalculator {
                 if (isOpenAIEmbeddingModel(model)) {
                     return calculateOpenAIEmbeddingCostInMillicents({
                         model,
-                        responses: call.response,
+                        responses: call.result.response,
                     });
                 }
                 break;
@@ -41,13 +41,13 @@ export class OpenAICostCalculator {
                 if (isOpenAIChatModel(model)) {
                     return calculateOpenAIChatCostInMillicents({
                         model,
-                        response: call.response,
+                        response: call.result.response,
                     });
                 }
                 if (isOpenAITextGenerationModel(model)) {
                     return calculateOpenAITextGenerationCostInMillicents({
                         model,
-                        response: call.response,
+                        response: call.result.response,
                     });
                 }
                 break;
@@ -58,7 +58,8 @@ export class OpenAICostCalculator {
                 }
                 return calculateOpenAITranscriptionCostInMillicents({
                     model: model,
-                    response: call.response,
+                    response: call.result
+                        .response,
                 });
             }
         }

package/model-provider/openai/chat/OpenAIChatModel.cjs

@@ -6,10 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAIChatResponseFormat = exports.OpenAIChatModel = exports.calculateOpenAIChatCostInMillicents = exports.isOpenAIChatModel = exports.getOpenAIChatModelInformation = exports.OPENAI_CHAT_MODELS = void 0;
 const secure_json_parse_1 = __importDefault(require("secure-json-parse"));
 const zod_1 = __importDefault(require("zod"));
-const AbstractModel_js_1 = require("../../../model-function/AbstractModel.cjs");
-const PromptFormatTextGenerationModel_js_1 = require("../../../prompt/PromptFormatTextGenerationModel.cjs");
 const callWithRetryAndThrottle_js_1 = require("../../../core/api/callWithRetryAndThrottle.cjs");
 const postToApi_js_1 = require("../../../core/api/postToApi.cjs");
+const AbstractModel_js_1 = require("../../../model-function/AbstractModel.cjs");
+const PromptFormatTextGenerationModel_js_1 = require("../../../prompt/PromptFormatTextGenerationModel.cjs");
 const OpenAIApiConfiguration_js_1 = require("../OpenAIApiConfiguration.cjs");
 const OpenAIError_js_1 = require("../OpenAIError.cjs");
 const TikTokenTokenizer_js_1 = require("../TikTokenTokenizer.cjs");
@@ -245,15 +245,21 @@ class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
      *
      * @see https://platform.openai.com/docs/guides/gpt/function-calling
      */
-    generateStructureResponse(prompt, options) {
-        const settingsWithFunctionCall = Object.assign({}, options, {
-            functionCall: prompt.functionCall,
-            functions: prompt.functions,
-        });
-        return this.callAPI(prompt.messages, {
+    generateStructureResponse(structureDefinition, prompt, options) {
+        return this.callAPI(prompt, {
             responseFormat: exports.OpenAIChatResponseFormat.json,
             functionId: options?.functionId,
-            settings: settingsWithFunctionCall,
+            settings: {
+                ...options,
+                functionCall: { name: structureDefinition.name },
+                functions: [
+                    {
+                        name: structureDefinition.name,
+                        description: structureDefinition.description,
+                        parameters: structureDefinition.schema.getJsonSchema(),
+                    },
+                ],
+            },
             run: options?.run,
         });
     }
@@ -261,6 +267,38 @@ class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
         const jsonText = response.choices[0].message.function_call.arguments;
         return secure_json_parse_1.default.parse(jsonText);
     }
+    generateStructureOrTextResponse(structureDefinitions, prompt, options) {
+        return this.callAPI(prompt, {
+            responseFormat: exports.OpenAIChatResponseFormat.json,
+            functionId: options?.functionId,
+            settings: {
+                ...options,
+                functionCall: "auto",
+                functions: structureDefinitions.map((structureDefinition) => ({
+                    name: structureDefinition.name,
+                    description: structureDefinition.description,
+                    parameters: structureDefinition.schema.getJsonSchema(),
+                })),
+            },
+            run: options?.run,
+        });
+    }
+    extractStructureAndText(response) {
+        const message = response.choices[0].message;
+        const content = message.content;
+        const functionCall = message.function_call;
+        return functionCall == null
+            ? {
+                structure: null,
+                value: null,
+                text: content ?? "",
+            }
+            : {
+                structure: functionCall.name,
+                value: secure_json_parse_1.default.parse(functionCall.arguments),
+                text: content,
+            };
+    }
     extractUsage(response) {
         return {
             promptTokens: response.usage.prompt_tokens,

package/model-provider/openai/chat/OpenAIChatModel.d.ts

@@ -1,17 +1,17 @@
 import z from "zod";
+import { ApiConfiguration } from "../../../core/api/ApiConfiguration.js";
+import { ResponseHandler } from "../../../core/api/postToApi.js";
+import { StructureDefinition } from "../../../core/structure/StructureDefinition.js";
 import { AbstractModel } from "../../../model-function/AbstractModel.js";
 import { ModelFunctionOptions } from "../../../model-function/ModelFunctionOptions.js";
-import { ApiConfiguration } from "../../../core/api/ApiConfiguration.js";
 import { StructureGenerationModel } from "../../../model-function/generate-structure/StructureGenerationModel.js";
 import { StructureOrTextGenerationModel } from "../../../model-function/generate-structure/StructureOrTextGenerationModel.js";
 import { DeltaEvent } from "../../../model-function/generate-text/DeltaEvent.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "../../../model-function/generate-text/TextGenerationModel.js";
 import { PromptFormat } from "../../../prompt/PromptFormat.js";
 import { PromptFormatTextGenerationModel } from "../../../prompt/PromptFormatTextGenerationModel.js";
-import { ResponseHandler } from "../../../core/api/postToApi.js";
 import { TikTokenTokenizer } from "../TikTokenTokenizer.js";
 import { OpenAIChatMessage } from "./OpenAIChatMessage.js";
-import { OpenAIChatAutoFunctionPrompt, OpenAIChatSingleFunctionPrompt, OpenAIFunctionDescription } from "./OpenAIChatPrompt.js";
 import { OpenAIChatDelta } from "./OpenAIChatStreamIterable.js";
 export declare const OPENAI_CHAT_MODELS: {
     "gpt-4": {
@@ -132,7 +132,7 @@ export interface OpenAIChatSettings extends TextGenerationModelSettings, Omit<Op
  *   ),
  * ]);
  */
-export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> implements TextGenerationModel<OpenAIChatMessage[], OpenAIChatResponse, OpenAIChatDelta, OpenAIChatSettings>, StructureGenerationModel<OpenAIChatSingleFunctionPrompt<unknown>, OpenAIChatResponse, OpenAIChatSettings>, StructureOrTextGenerationModel<OpenAIChatAutoFunctionPrompt<Array<OpenAIFunctionDescription<unknown>>>, OpenAIChatResponse, OpenAIChatSettings> {
+export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> implements TextGenerationModel<OpenAIChatMessage[], OpenAIChatResponse, OpenAIChatDelta, OpenAIChatSettings>, StructureGenerationModel<OpenAIChatMessage[], OpenAIChatResponse, OpenAIChatSettings>, StructureOrTextGenerationModel<OpenAIChatMessage[], OpenAIChatResponse, OpenAIChatSettings> {
     constructor(settings: OpenAIChatSettings);
     readonly provider: "openai";
     get modelName(): OpenAIChatModelType;
@@ -183,8 +183,18 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
      *
      * @see https://platform.openai.com/docs/guides/gpt/function-calling
      */
-    generateStructureResponse(prompt: OpenAIChatSingleFunctionPrompt<unknown> | OpenAIChatAutoFunctionPrompt<Array<OpenAIFunctionDescription<unknown>>>, options?: ModelFunctionOptions<OpenAIChatSettings> | undefined): PromiseLike<OpenAIChatResponse>;
+    generateStructureResponse(structureDefinition: StructureDefinition<string, unknown>, prompt: OpenAIChatMessage[], options?: ModelFunctionOptions<OpenAIChatSettings> | undefined): PromiseLike<OpenAIChatResponse>;
     extractStructure(response: OpenAIChatResponse): unknown;
+    generateStructureOrTextResponse(structureDefinitions: Array<StructureDefinition<string, unknown>>, prompt: OpenAIChatMessage[], options?: ModelFunctionOptions<OpenAIChatSettings> | undefined): PromiseLike<OpenAIChatResponse>;
+    extractStructureAndText(response: OpenAIChatResponse): {
+        structure: null;
+        value: null;
+        text: string;
+    } | {
+        structure: string;
+        value: any;
+        text: string | null;
+    };
     extractUsage(response: OpenAIChatResponse): {
         promptTokens: number;
         completionTokens: number;