modelfusion 0.80.0 → 0.82.0

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

@@ -1,15 +1,9 @@
 import { getErrorMessage } from "../../util/getErrorMessage.js";
 export class StructureParseError extends Error {
-    constructor({ structureName, valueText, cause, }) {
-        super(`Structure parsing failed for '${structureName}'. ` +
+    constructor({ valueText, cause }) {
+        super(`Structure parsing failed. ` +
             `Value: ${valueText}.\n` +
             `Error message: ${getErrorMessage(cause)}`);
-        Object.defineProperty(this, "structureName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         Object.defineProperty(this, "cause", {
             enumerable: true,
             configurable: true,
@@ -23,7 +17,6 @@ export class StructureParseError extends Error {
             value: void 0
         });
         this.name = "StructureParseError";
-        this.structureName = structureName;
         this.cause = cause;
         this.valueText = valueText;
     }
@@ -33,7 +26,6 @@ export class StructureParseError extends Error {
             cause: this.cause,
             message: this.message,
             stack: this.stack,
-            structureName: this.structureName,
             valueText: this.valueText,
         };
     }

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

@@ -3,16 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.StructureValidationError = void 0;
 const getErrorMessage_js_1 = require("../../util/getErrorMessage.cjs");
 class StructureValidationError extends Error {
-    constructor({ structureName, value, valueText, cause, }) {
-        super(`Structure validation failed for '${structureName}'. ` +
+    constructor({ value, valueText, cause, }) {
+        super(`Structure validation failed. ` +
             `Value: ${valueText}.\n` +
             `Error message: ${(0, getErrorMessage_js_1.getErrorMessage)(cause)}`);
-        Object.defineProperty(this, "structureName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         Object.defineProperty(this, "cause", {
             enumerable: true,
             configurable: true,
@@ -32,7 +26,6 @@ class StructureValidationError extends Error {
             value: void 0
         });
         this.name = "StructureValidationError";
-        this.structureName = structureName;
         this.cause = cause;
         this.value = value;
         this.valueText = valueText;
@@ -43,7 +36,6 @@ class StructureValidationError extends Error {
             message: this.message,
             cause: this.cause,
             stack: this.stack,
-            structureName: this.structureName,
             value: this.value,
             valueText: this.valueText,
         };

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

@@ -1,10 +1,8 @@
 export declare class StructureValidationError extends Error {
-    readonly structureName: string;
     readonly cause: unknown;
     readonly valueText: string;
     readonly value: unknown;
-    constructor({ structureName, value, valueText, cause, }: {
-        structureName: string;
+    constructor({ value, valueText, cause, }: {
         value: unknown;
         valueText: string;
         cause: unknown;
@@ -14,7 +12,6 @@ export declare class StructureValidationError extends Error {
         message: string;
         cause: unknown;
         stack: string | undefined;
-        structureName: string;
         value: unknown;
         valueText: string;
     };

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

@@ -1,15 +1,9 @@
 import { getErrorMessage } from "../../util/getErrorMessage.js";
 export class StructureValidationError extends Error {
-    constructor({ structureName, value, valueText, cause, }) {
-        super(`Structure validation failed for '${structureName}'. ` +
+    constructor({ value, valueText, cause, }) {
+        super(`Structure validation failed. ` +
             `Value: ${valueText}.\n` +
             `Error message: ${getErrorMessage(cause)}`);
-        Object.defineProperty(this, "structureName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         Object.defineProperty(this, "cause", {
             enumerable: true,
             configurable: true,
@@ -29,7 +23,6 @@ export class StructureValidationError extends Error {
             value: void 0
         });
         this.name = "StructureValidationError";
-        this.structureName = structureName;
         this.cause = cause;
         this.value = value;
         this.valueText = valueText;
@@ -40,7 +33,6 @@ export class StructureValidationError extends Error {
             message: this.message,
             cause: this.cause,
             stack: this.stack,
-            structureName: this.structureName,
             value: this.value,
             valueText: this.valueText,
         };

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

@@ -3,10 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateStructure = void 0;
 const executeStandardCall_js_1 = require("../executeStandardCall.cjs");
 const StructureValidationError_js_1 = require("./StructureValidationError.cjs");
-async function generateStructure(model, structureDefinition, prompt, options) {
+async function generateStructure(model, schema, prompt, options) {
     // Note: PROMPT must not be a function.
     const expandedPrompt = typeof prompt === "function"
-        ? prompt(structureDefinition)
+        ? prompt(schema)
         : prompt;
     const fullResponse = await (0, executeStandardCall_js_1.executeStandardCall)({
         functionType: "generate-structure",
@@ -14,12 +14,11 @@ async function generateStructure(model, structureDefinition, prompt, options) {
         model,
         options,
         generateResponse: async (options) => {
-            const result = await model.doGenerateStructure(structureDefinition, expandedPrompt, options);
+            const result = await model.doGenerateStructure(schema, expandedPrompt, options);
             const structure = result.value;
-            const parseResult = structureDefinition.schema.validate(structure);
+            const parseResult = schema.validate(structure);
             if (!parseResult.success) {
                 throw new StructureValidationError_js_1.StructureValidationError({
-                    structureName: structureDefinition.name,
                     valueText: result.valueText,
                     value: structure,
                     cause: parseResult.error,

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

@@ -1,27 +1,21 @@
 import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { StructureDefinition } from "../../core/schema/StructureDefinition.js";
+import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
+import { Schema } from "../../core/schema/Schema.js";
 import { ModelCallMetadata } from "../ModelCallMetadata.js";
 import { StructureGenerationModel, StructureGenerationModelSettings } from "./StructureGenerationModel.js";
 /**
- * Generate a typed object for a prompt and a structure definition.
- * The structure definition is used as part of the final prompt.
- *
- * For the OpenAI chat model, this generates and parses a function call with a single function.
+ * Generate a typed object for a prompt and a schema.
  *
  * @see https://modelfusion.dev/guide/function/generate-structure
  *
  * @example
  * const sentiment = await generateStructure(
- *   openai.ChatTextGenerator(...),
- *   new ZodStructureDefinition({
- *     name: "sentiment",
- *     description: "Write the sentiment analysis",
- *     schema: z.object({
- *       sentiment: z
- *         .enum(["positive", "neutral", "negative"])
- *         .describe("Sentiment."),
- *     }),
- *   }),
+ *   openai.ChatTextGenerator(...).asFunctionCallStructureGenerationModel(...),
+ *   new ZodSchema(z.object({
+ *     sentiment: z
+ *       .enum(["positive", "neutral", "negative"])
+ *       .describe("Sentiment."),
+ *   })),
  *   [
  *     OpenAIChatMessage.system(
  *       "You are a sentiment evaluator. " +
@@ -35,18 +29,18 @@ import { StructureGenerationModel, StructureGenerationModelSettings } from "./St
  * );
  *
  * @param {StructureGenerationModel<PROMPT, SETTINGS>} model - The model to generate the structure.
- * @param {StructureDefinition<NAME, STRUCTURE>} structureDefinition - The structure definition to be used.
- * @param {PROMPT | ((structureDefinition: StructureDefinition<NAME, STRUCTURE>) => PROMPT)} prompt
+ * @param {Schema<STRUCTURE>} schema - The schema to be used.
+ * @param {PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT)} prompt
  * The prompt to be used.
- * You can also pass a function that takes the structure definition as an argument and returns the prompt.
+ * You can also pass a function that takes the schema as an argument and returns the prompt.
  * @param {FunctionOptions} [options] - Optional function options.
  *
  * @returns {Promise<STRUCTURE>} - Returns a promise that resolves to the generated structure.
  */
-export declare function generateStructure<STRUCTURE, PROMPT, NAME extends string, SETTINGS extends StructureGenerationModelSettings>(model: StructureGenerationModel<PROMPT, SETTINGS>, structureDefinition: StructureDefinition<NAME, STRUCTURE>, prompt: PROMPT | ((structureDefinition: StructureDefinition<NAME, STRUCTURE>) => PROMPT), options?: FunctionOptions & {
+export declare function generateStructure<STRUCTURE, PROMPT, SETTINGS extends StructureGenerationModelSettings>(model: StructureGenerationModel<PROMPT, SETTINGS>, schema: Schema<STRUCTURE> & JsonSchemaProducer, prompt: PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT), options?: FunctionOptions & {
     returnType?: "structure";
 }): Promise<STRUCTURE>;
-export declare function generateStructure<STRUCTURE, PROMPT, NAME extends string, SETTINGS extends StructureGenerationModelSettings>(model: StructureGenerationModel<PROMPT, SETTINGS>, structureDefinition: StructureDefinition<NAME, STRUCTURE>, prompt: PROMPT | ((structureDefinition: StructureDefinition<NAME, STRUCTURE>) => PROMPT), options: FunctionOptions & {
+export declare function generateStructure<STRUCTURE, PROMPT, SETTINGS extends StructureGenerationModelSettings>(model: StructureGenerationModel<PROMPT, SETTINGS>, schema: Schema<STRUCTURE> & JsonSchemaProducer, prompt: PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT), options: FunctionOptions & {
     returnType: "full";
 }): Promise<{
     value: STRUCTURE;

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

@@ -1,9 +1,9 @@
 import { executeStandardCall } from "../executeStandardCall.js";
 import { StructureValidationError } from "./StructureValidationError.js";
-export async function generateStructure(model, structureDefinition, prompt, options) {
+export async function generateStructure(model, schema, prompt, options) {
     // Note: PROMPT must not be a function.
     const expandedPrompt = typeof prompt === "function"
-        ? prompt(structureDefinition)
+        ? prompt(schema)
         : prompt;
     const fullResponse = await executeStandardCall({
         functionType: "generate-structure",
@@ -11,12 +11,11 @@ export async function generateStructure(model, structureDefinition, prompt, opti
         model,
         options,
         generateResponse: async (options) => {
-            const result = await model.doGenerateStructure(structureDefinition, expandedPrompt, options);
+            const result = await model.doGenerateStructure(schema, expandedPrompt, options);
             const structure = result.value;
-            const parseResult = structureDefinition.schema.validate(structure);
+            const parseResult = schema.validate(structure);
             if (!parseResult.success) {
                 throw new StructureValidationError({
-                    structureName: structureDefinition.name,
                     valueText: result.valueText,
                     value: structure,
                     cause: parseResult.error,

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

@@ -15,10 +15,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./StructureFromTextGenerationModel.cjs"), exports);
+__exportStar(require("./StructureFromTextPromptFormat.cjs"), exports);
+__exportStar(require("./StructureFromTextStreamingModel.cjs"), exports);
 __exportStar(require("./StructureGenerationEvent.cjs"), exports);
 __exportStar(require("./StructureGenerationModel.cjs"), exports);
 __exportStar(require("./StructureParseError.cjs"), exports);
 __exportStar(require("./StructureStreamingEvent.cjs"), exports);
 __exportStar(require("./StructureValidationError.cjs"), exports);
 __exportStar(require("./generateStructure.cjs"), exports);
+__exportStar(require("./jsonStructurePrompt.cjs"), exports);
 __exportStar(require("./streamStructure.cjs"), exports);

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

@@ -1,8 +1,11 @@
 export * from "./StructureFromTextGenerationModel.js";
+export * from "./StructureFromTextPromptFormat.js";
+export * from "./StructureFromTextStreamingModel.js";
 export * from "./StructureGenerationEvent.js";
 export * from "./StructureGenerationModel.js";
 export * from "./StructureParseError.js";
 export * from "./StructureStreamingEvent.js";
 export * from "./StructureValidationError.js";
 export * from "./generateStructure.js";
+export * from "./jsonStructurePrompt.js";
 export * from "./streamStructure.js";

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

@@ -1,8 +1,11 @@
 export * from "./StructureFromTextGenerationModel.js";
+export * from "./StructureFromTextPromptFormat.js";
+export * from "./StructureFromTextStreamingModel.js";
 export * from "./StructureGenerationEvent.js";
 export * from "./StructureGenerationModel.js";
 export * from "./StructureParseError.js";
 export * from "./StructureStreamingEvent.js";
 export * from "./StructureValidationError.js";
 export * from "./generateStructure.js";
+export * from "./jsonStructurePrompt.js";
 export * from "./streamStructure.js";

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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonStructurePrompt = void 0;
+const parseJSON_js_1 = require("../../core/schema/parseJSON.cjs");
+function jsonStructurePrompt(createPrompt) {
+    return {
+        createPrompt,
+        extractStructure: (response) => (0, parseJSON_js_1.parseJSON)({ text: response }),
+    };
+}
+exports.jsonStructurePrompt = jsonStructurePrompt;

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

@@ -0,0 +1,4 @@
+import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
+import { Schema } from "../../core/schema/Schema.js";
+import { StructureFromTextPromptFormat } from "./StructureFromTextPromptFormat.js";
+export declare function jsonStructurePrompt<SOURCE_PROMPT, TARGET_PROMPT>(createPrompt: (prompt: SOURCE_PROMPT, schema: Schema<unknown> & JsonSchemaProducer) => TARGET_PROMPT): StructureFromTextPromptFormat<SOURCE_PROMPT, TARGET_PROMPT>;

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

@@ -0,0 +1,7 @@
+import { parseJSON } from "../../core/schema/parseJSON.js";
+export function jsonStructurePrompt(createPrompt) {
+    return {
+        createPrompt,
+        extractStructure: (response) => parseJSON({ text: response }),
+    };
+}

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

@@ -3,10 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.streamStructure = void 0;
 const isDeepEqualData_js_1 = require("../../util/isDeepEqualData.cjs");
 const executeStreamCall_js_1 = require("../executeStreamCall.cjs");
-async function streamStructure(model, structureDefinition, prompt, options) {
+async function streamStructure(model, schema, prompt, options) {
     // Note: PROMPT must not be a function.
     const expandedPrompt = typeof prompt === "function"
-        ? prompt(structureDefinition)
+        ? prompt(schema)
         : prompt;
     let lastStructure;
     let lastFullDelta;
@@ -15,7 +15,7 @@ async function streamStructure(model, structureDefinition, prompt, options) {
         input: prompt,
         model,
         options,
-        startStream: async (options) => model.doStreamStructure(structureDefinition, expandedPrompt, options),
+        startStream: async (options) => model.doStreamStructure(schema, expandedPrompt, options),
         processDelta: (delta) => {
             const latestFullDelta = delta.fullDelta;
             const latestStructure = delta.valueDelta;
@@ -32,7 +32,7 @@ async function streamStructure(model, structureDefinition, prompt, options) {
         },
         processFinished: () => {
             // process the final result (full type validation):
-            const parseResult = structureDefinition.schema.validate(lastStructure);
+            const parseResult = schema.validate(lastStructure);
             if (!parseResult.success) {
                 reportError(parseResult.error);
                 throw parseResult.error;

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

@@ -1,5 +1,6 @@
 import { FunctionOptions } from "../../core/FunctionOptions.js";
-import { StructureDefinition } from "../../core/schema/StructureDefinition.js";
+import { JsonSchemaProducer } from "../../core/schema/JsonSchemaProducer.js";
+import { Schema } from "../../core/schema/Schema.js";
 import { ModelCallMetadata } from "../ModelCallMetadata.js";
 import { StructureStreamingModel } from "./StructureGenerationModel.js";
 export type StructureStreamPart<STRUCTURE> = {
@@ -25,26 +26,17 @@ export type StructureStreamPart<STRUCTURE> = {
  *
  * @example
  * const structureStream = await streamStructure(
- *    openai.ChatTextGenerator({
- *      model: "gpt-3.5-turbo",
- *     temperature: 0,
- *     maxCompletionTokens: 2000,
- *   }),
- *   new ZodStructureDefinition({
- *     name: "generateCharacter",
- *     description: "Generate character descriptions.",
- *     schema: z.object({
- *       characters: z.array(
- *         z.object({
- *           name: z.string(),
- *           class: z
- *             .string()
- *             .describe("Character class, e.g. warrior, mage, or thief."),
- *           description: z.string(),
- *         })
- *       ),
- *     }),
- *   }),
+ *   openai.ChatTextGenerator(...).asFunctionCallStructureGenerationModel(...),
+ *   new ZodSchema(
+ *     z.array(
+ *       z.object({
+ *         name: z.string(),
+ *         class: z
+ *           .string()
+ *           .describe("Character class, e.g. warrior, mage, or thief."),
+ *         description: z.string(),
+ *       })
+ *     ),
  *   [
  *     OpenAIChatMessage.user(
  *       "Generate 3 character descriptions for a fantasy role playing game."
@@ -64,10 +56,10 @@ export type StructureStreamPart<STRUCTURE> = {
  * }
  *
  * @param {StructureStreamingModel<PROMPT>} model - The model to use for streaming
- * @param {StructureDefinition<NAME, STRUCTURE>} structureDefinition - The structure definition to use
- * @param {PROMPT | ((structureDefinition: StructureDefinition<NAME, STRUCTURE>) => PROMPT)} prompt
+ * @param {Schema<STRUCTURE>} schema - The schema to be used.
+ * @param {PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT)} prompt
  * The prompt to be used.
- * You can also pass a function that takes the structure definition as an argument and returns the prompt.
+ * You can also pass a function that takes the schema as an argument and returns the prompt.
  * @param {FunctionOptions} [options] - Optional function options
  *
  * @returns {AsyncIterableResultPromise<StructureStreamPart<STRUCTURE>>}
@@ -76,10 +68,10 @@ export type StructureStreamPart<STRUCTURE> = {
  * It contains a isComplete flag to indicate whether the structure is complete,
  * and a value that is either the partial structure or the final structure.
  */
-export declare function streamStructure<STRUCTURE, PROMPT, NAME extends string>(model: StructureStreamingModel<PROMPT>, structureDefinition: StructureDefinition<NAME, STRUCTURE>, prompt: PROMPT | ((structureDefinition: StructureDefinition<NAME, STRUCTURE>) => PROMPT), options?: FunctionOptions & {
+export declare function streamStructure<STRUCTURE, PROMPT>(model: StructureStreamingModel<PROMPT>, schema: Schema<STRUCTURE> & JsonSchemaProducer, prompt: PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT), options?: FunctionOptions & {
     returnType?: "structure-stream";
 }): Promise<AsyncIterable<StructureStreamPart<STRUCTURE>>>;
-export declare function streamStructure<STRUCTURE, PROMPT, NAME extends string>(model: StructureStreamingModel<PROMPT>, structureDefinition: StructureDefinition<NAME, STRUCTURE>, prompt: PROMPT | ((structureDefinition: StructureDefinition<NAME, STRUCTURE>) => PROMPT), options: FunctionOptions & {
+export declare function streamStructure<STRUCTURE, PROMPT>(model: StructureStreamingModel<PROMPT>, schema: Schema<STRUCTURE> & JsonSchemaProducer, prompt: PROMPT | ((schema: Schema<STRUCTURE>) => PROMPT), options: FunctionOptions & {
     returnType: "full";
 }): Promise<{
     value: AsyncIterable<StructureStreamPart<STRUCTURE>>;

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

@@ -1,9 +1,9 @@
 import { isDeepEqualData } from "../../util/isDeepEqualData.js";
 import { executeStreamCall } from "../executeStreamCall.js";
-export async function streamStructure(model, structureDefinition, prompt, options) {
+export async function streamStructure(model, schema, prompt, options) {
     // Note: PROMPT must not be a function.
     const expandedPrompt = typeof prompt === "function"
-        ? prompt(structureDefinition)
+        ? prompt(schema)
         : prompt;
     let lastStructure;
     let lastFullDelta;
@@ -12,7 +12,7 @@ export async function streamStructure(model, structureDefinition, prompt, option
         input: prompt,
         model,
         options,
-        startStream: async (options) => model.doStreamStructure(structureDefinition, expandedPrompt, options),
+        startStream: async (options) => model.doStreamStructure(schema, expandedPrompt, options),
         processDelta: (delta) => {
             const latestFullDelta = delta.fullDelta;
             const latestStructure = delta.valueDelta;
@@ -29,7 +29,7 @@ export async function streamStructure(model, structureDefinition, prompt, option
         },
         processFinished: () => {
             // process the final result (full type validation):
-            const parseResult = structureDefinition.schema.validate(lastStructure);
+            const parseResult = schema.validate(lastStructure);
             if (!parseResult.success) {
                 reportError(parseResult.error);
                 throw parseResult.error;

package/model-function/generate-text/PromptFormatTextGenerationModel.cjs

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PromptFormatTextGenerationModel = void 0;
+const StructureFromTextGenerationModel_js_1 = require("../../model-function/generate-structure/StructureFromTextGenerationModel.cjs");
 const TextGenerationToolCallModel_js_1 = require("../../tool/generate-tool-call/TextGenerationToolCallModel.cjs");
 const TextGenerationToolCallsOrGenerateTextModel_js_1 = require("../../tool/generate-tool-calls-or-text/TextGenerationToolCallsOrGenerateTextModel.cjs");
 class PromptFormatTextGenerationModel {
@@ -58,6 +59,12 @@ class PromptFormatTextGenerationModel {
             format: promptFormat,
         });
     }
+    asStructureGenerationModel(promptFormat) {
+        return new StructureFromTextGenerationModel_js_1.StructureFromTextGenerationModel({
+            model: this,
+            format: promptFormat,
+        });
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextGenerationModel({
             model: this.withSettings({

package/model-function/generate-text/PromptFormatTextGenerationModel.d.ts

@@ -1,4 +1,6 @@
 import { FunctionOptions } from "../../core/FunctionOptions.js";
+import { StructureFromTextGenerationModel } from "../../model-function/generate-structure/StructureFromTextGenerationModel.js";
+import { StructureFromTextPromptFormat } from "model-function/generate-structure/StructureFromTextPromptFormat.js";
 import { TextGenerationToolCallModel, ToolCallPromptFormat } from "../../tool/generate-tool-call/TextGenerationToolCallModel.js";
 import { TextGenerationToolCallsOrGenerateTextModel, ToolCallsOrGenerateTextPromptFormat } from "../../tool/generate-tool-calls-or-text/TextGenerationToolCallsOrGenerateTextModel.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "./TextGenerationModel.js";
@@ -27,6 +29,7 @@ export declare class PromptFormatTextGenerationModel<PROMPT, MODEL_PROMPT, SETTI
     get settingsForEvent(): Partial<SETTINGS>;
     asToolCallGenerationModel<INPUT_PROMPT>(promptFormat: ToolCallPromptFormat<INPUT_PROMPT, PROMPT>): TextGenerationToolCallModel<INPUT_PROMPT, PROMPT, this>;
     asToolCallsOrTextGenerationModel<INPUT_PROMPT>(promptFormat: ToolCallsOrGenerateTextPromptFormat<INPUT_PROMPT, PROMPT>): TextGenerationToolCallsOrGenerateTextModel<INPUT_PROMPT, PROMPT, this>;
+    asStructureGenerationModel<INPUT_PROMPT>(promptFormat: StructureFromTextPromptFormat<INPUT_PROMPT, PROMPT>): StructureFromTextGenerationModel<INPUT_PROMPT, PROMPT, this>;
     withPromptFormat<INPUT_PROMPT>(promptFormat: TextGenerationPromptFormat<INPUT_PROMPT, PROMPT>): PromptFormatTextGenerationModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
     withSettings(additionalSettings: Partial<SETTINGS>): this;
 }

package/model-function/generate-text/PromptFormatTextGenerationModel.js

@@ -1,3 +1,4 @@
+import { StructureFromTextGenerationModel } from "../../model-function/generate-structure/StructureFromTextGenerationModel.js";
 import { TextGenerationToolCallModel, } from "../../tool/generate-tool-call/TextGenerationToolCallModel.js";
 import { TextGenerationToolCallsOrGenerateTextModel, } from "../../tool/generate-tool-calls-or-text/TextGenerationToolCallsOrGenerateTextModel.js";
 export class PromptFormatTextGenerationModel {
@@ -55,6 +56,12 @@ export class PromptFormatTextGenerationModel {
             format: promptFormat,
         });
     }
+    asStructureGenerationModel(promptFormat) {
+        return new StructureFromTextGenerationModel({
+            model: this,
+            format: promptFormat,
+        });
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextGenerationModel({
             model: this.withSettings({

package/model-function/generate-text/PromptFormatTextStreamingModel.cjs

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PromptFormatTextStreamingModel = void 0;
+const StructureFromTextStreamingModel_js_1 = require("../../model-function/generate-structure/StructureFromTextStreamingModel.cjs");
 const PromptFormatTextGenerationModel_js_1 = require("./PromptFormatTextGenerationModel.cjs");
 class PromptFormatTextStreamingModel extends PromptFormatTextGenerationModel_js_1.PromptFormatTextGenerationModel {
     constructor(options) {
@@ -10,6 +11,12 @@ class PromptFormatTextStreamingModel extends PromptFormatTextGenerationModel_js_
         const mappedPrompt = this.promptFormat.format(prompt);
         return this.model.doStreamText(mappedPrompt, options);
     }
+    asStructureGenerationModel(promptFormat) {
+        return new StructureFromTextStreamingModel_js_1.StructureFromTextStreamingModel({
+            model: this,
+            format: promptFormat,
+        });
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel({
             model: this.withSettings({

package/model-function/generate-text/PromptFormatTextStreamingModel.d.ts

@@ -1,4 +1,6 @@
 import { FunctionOptions } from "../../core/FunctionOptions.js";
+import { StructureFromTextPromptFormat } from "model-function/generate-structure/StructureFromTextPromptFormat.js";
+import { StructureFromTextStreamingModel } from "../../model-function/generate-structure/StructureFromTextStreamingModel.js";
 import { PromptFormatTextGenerationModel } from "./PromptFormatTextGenerationModel.js";
 import { TextGenerationModelSettings, TextStreamingModel } from "./TextGenerationModel.js";
 import { TextGenerationPromptFormat } from "./TextGenerationPromptFormat.js";
@@ -8,6 +10,7 @@ export declare class PromptFormatTextStreamingModel<PROMPT, MODEL_PROMPT, SETTIN
         promptFormat: TextGenerationPromptFormat<PROMPT, MODEL_PROMPT>;
     });
     doStreamText(prompt: PROMPT, options?: FunctionOptions): PromiseLike<AsyncIterable<import("../Delta.js").Delta<string>>>;
+    asStructureGenerationModel<INPUT_PROMPT>(promptFormat: StructureFromTextPromptFormat<INPUT_PROMPT, PROMPT>): StructureFromTextStreamingModel<INPUT_PROMPT, PROMPT, this>;
     withPromptFormat<INPUT_PROMPT>(promptFormat: TextGenerationPromptFormat<INPUT_PROMPT, PROMPT>): PromptFormatTextStreamingModel<INPUT_PROMPT, PROMPT, SETTINGS, this>;
     withSettings(additionalSettings: Partial<SETTINGS>): this;
 }

package/model-function/generate-text/PromptFormatTextStreamingModel.js

@@ -1,3 +1,4 @@
+import { StructureFromTextStreamingModel } from "../../model-function/generate-structure/StructureFromTextStreamingModel.js";
 import { PromptFormatTextGenerationModel } from "./PromptFormatTextGenerationModel.js";
 export class PromptFormatTextStreamingModel extends PromptFormatTextGenerationModel {
     constructor(options) {
@@ -7,6 +8,12 @@ export class PromptFormatTextStreamingModel extends PromptFormatTextGenerationMo
         const mappedPrompt = this.promptFormat.format(prompt);
         return this.model.doStreamText(mappedPrompt, options);
     }
+    asStructureGenerationModel(promptFormat) {
+        return new StructureFromTextStreamingModel({
+            model: this,
+            format: promptFormat,
+        });
+    }
     withPromptFormat(promptFormat) {
         return new PromptFormatTextStreamingModel({
             model: this.withSettings({

package/model-function/generate-text/prompt-format/ChatPrompt.d.ts

@@ -24,18 +24,18 @@
  *
  * @see validateChatPrompt
  */
-export type ChatPrompt = {
+export interface ChatPrompt {
     system?: string;
     messages: Array<ChatMessage>;
-};
+}
 /**
  * A message in a chat prompt.
  * @see ChatPrompt
  */
-export type ChatMessage = {
+export interface ChatMessage {
     role: "user" | "assistant";
     content: string;
-};
+}
 /**
  * Checks if a chat prompt is valid. Throws a {@link ChatPromptValidationError} if it's not.
  *

package/model-function/generate-text/prompt-format/Content.d.ts

@@ -1,13 +1,13 @@
 export type MultiModalInput = Array<Content>;
 export type Content = TextContent | ImageContent;
-export type TextContent = {
+export interface TextContent {
     type: "text";
     /**
      * The text content.
      */
     text: string;
-};
-export type ImageContent = {
+}
+export interface ImageContent {
     type: "image";
     /**
      * Base-64 encoded image.
@@ -17,4 +17,4 @@ export type ImageContent = {
      * Optional mime type of the image.
      */
     mimeType?: string;
-};
+}

package/model-function/generate-text/prompt-format/InstructionPrompt.d.ts

@@ -4,7 +4,7 @@ import { MultiModalInput } from "./Content.js";
  * the role and behavior of the language model.
  * The instruction is a multi-model input (`array` of content).
  */
-export type InstructionPrompt = {
+export interface InstructionPrompt {
     /**
      * Optional system message to provide context for the language model. Note that for some models,
      * changing the system message can impact the results, because the model may be trained on the default system message.
@@ -14,7 +14,7 @@ export type InstructionPrompt = {
      * The multi-modal instruction for the model.
      */
     instruction: MultiModalInput;
-};
+}
 /**
  * A single text instruction prompt. It can contain an optional system message to define
  * the role and behavior of the language model.
@@ -27,7 +27,7 @@ export type InstructionPrompt = {
  * }
  * ```
  */
-export type TextInstructionPrompt = {
+export interface TextInstructionPrompt {
     /**
      * Optional system message to provide context for the language model. Note that for some models,
      * changing the system message can impact the results, because the model may be trained on the default system message.
@@ -37,4 +37,4 @@ export type TextInstructionPrompt = {
      * The text instruction for the model.
      */
     instruction: string;
-};
+}