modelfusion 0.81.0 → 0.83.0

package/README.md

@@ -193,9 +193,10 @@ Generate typed objects using a language model and a schema.
 Generate a structure that matches a schema.
 
 ```ts
-import { ZodSchema, generateStructure, openai } from "modelfusion";
+import { zodSchema, generateStructure, openai } from "modelfusion";
 
 const sentiment = await generateStructure(
+  // model:
   openai
     .ChatTextGenerator({
       model: "gpt-3.5-turbo",
@@ -205,7 +206,8 @@ const sentiment = await generateStructure(
     .asFunctionCallStructureGenerationModel({ fnName: "sentiment" })
     .withInstructionPrompt(),
 
-  new ZodSchema(
+  // schema:
+  zodSchema(
     z.object({
       sentiment: z
         .enum(["positive", "neutral", "negative"])
@@ -213,6 +215,7 @@ const sentiment = await generateStructure(
     })
   ),
 
+  // prompt:
   {
     system:
       "You are a sentiment evaluator. " +
@@ -224,14 +227,14 @@ const sentiment = await generateStructure(
 );
 ```
 
-Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai)
+Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [Ollama](https://modelfusion.dev//integration/model-provider/ollama)
 
 #### streamStructure
 
 Stream a structure that matches a schema. Partial structures before the final part are untyped JSON.
 
 ```ts
-import { ZodSchema, openai, streamStructure } from "modelfusion";
+import { zodSchema, openai, streamStructure } from "modelfusion";
 
 const structureStream = await streamStructure(
   openai
@@ -242,7 +245,7 @@ const structureStream = await streamStructure(
     })
     .withTextPrompt(),
 
-  new ZodSchema(
+  zodSchema(
     z.object({
       characters: z.array(
         z.object({
@@ -270,7 +273,7 @@ for await (const part of structureStream) {
 }
 ```
 
-Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai)
+Providers: [OpenAI](https://modelfusion.dev/integration/model-provider/openai), [Ollama](https://modelfusion.dev//integration/model-provider/ollama)
 
 ### [Embed Value](https://modelfusion.dev/guide/function/embed)
 
@@ -330,7 +333,7 @@ const result = await guard(
         .asFunctionCallStructureGenerationModel({
           fnName: "myFunction",
         }),
-      new ZodSchema({
+      zodSchema({
         // ...
       }),
       input,
@@ -372,7 +375,7 @@ const calculator = new Tool({
   name: "calculator",
   description: "Execute a calculation",
 
-  parameters: new ZodSchema(
+  parameters: zodSchema(
     z.object({
       a: z.number().describe("The first number."),
       b: z.number().describe("The second number."),
@@ -591,15 +594,15 @@ const image = await generateImage(
     .ImageGenerator({
       //...
     })
-    .withBasicPrompt(),
+    .withTextPrompt(),
   "the wicked witch of the west in the style of early 19th century painting"
 );
 ```
 
-| Prompt Format | Basic Text Prompt |
-| ------------- | ----------------- |
-| Automatic1111 | ✅                |
-| Stability     | ✅                |
+| Prompt Format | Text Prompt |
+| ------------- | ----------- |
+| Automatic1111 | ✅          |
+| Stability     | ✅          |
 
 ### Metadata and original responses
 

package/core/schema/UncheckedSchema.cjs

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UncheckedSchema = void 0;
+exports.UncheckedSchema = exports.uncheckedSchema = void 0;
+function uncheckedSchema(jsonSchema) {
+    return new UncheckedSchema(jsonSchema);
+}
+exports.uncheckedSchema = uncheckedSchema;
 class UncheckedSchema {
     constructor(jsonSchema) {
         Object.defineProperty(this, "jsonSchema", {

package/core/schema/UncheckedSchema.d.ts

@@ -1,5 +1,6 @@
 import { JsonSchemaProducer } from "./JsonSchemaProducer.js";
 import { Schema } from "./Schema.js";
+export declare function uncheckedSchema<STRUCTURE>(jsonSchema?: unknown): UncheckedSchema<STRUCTURE>;
 export declare class UncheckedSchema<STRUCTURE> implements Schema<STRUCTURE>, JsonSchemaProducer {
     private readonly jsonSchema?;
     constructor(jsonSchema?: unknown);

package/core/schema/UncheckedSchema.js

@@ -1,3 +1,6 @@
+export function uncheckedSchema(jsonSchema) {
+    return new UncheckedSchema(jsonSchema);
+}
 export class UncheckedSchema {
     constructor(jsonSchema) {
         Object.defineProperty(this, "jsonSchema", {

package/core/schema/ZodSchema.cjs

@@ -1,7 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZodSchema = void 0;
+exports.ZodSchema = exports.zodSchema = void 0;
 const zod_to_json_schema_1 = require("zod-to-json-schema");
+function zodSchema(zodSchema) {
+    return new ZodSchema(zodSchema);
+}
+exports.zodSchema = zodSchema;
 class ZodSchema {
     constructor(zodSchema) {
         Object.defineProperty(this, "zodSchema", {

package/core/schema/ZodSchema.d.ts

@@ -1,6 +1,7 @@
 import { z } from "zod";
 import { JsonSchemaProducer } from "./JsonSchemaProducer.js";
 import { Schema } from "./Schema.js";
+export declare function zodSchema<STRUCTURE>(zodSchema: z.Schema<STRUCTURE>): ZodSchema<STRUCTURE>;
 export declare class ZodSchema<STRUCTURE> implements Schema<STRUCTURE>, JsonSchemaProducer {
     readonly zodSchema: z.Schema<STRUCTURE>;
     constructor(zodSchema: z.Schema<STRUCTURE>);

package/core/schema/ZodSchema.js

@@ -1,4 +1,7 @@
 import { zodToJsonSchema } from "zod-to-json-schema";
+export function zodSchema(zodSchema) {
+    return new ZodSchema(zodSchema);
+}
 export class ZodSchema {
     constructor(zodSchema) {
         Object.defineProperty(this, "zodSchema", {

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 interface InstructionPrompt {
+export interface MultiModalInstructionPrompt {
     /**
      * 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.

package/model-provider/automatic1111/Automatic1111ImageGenerationModel.cjs

@@ -53,7 +53,7 @@ class Automatic1111ImageGenerationModel extends AbstractModel_js_1.AbstractModel
             base64Image: response.images[0],
         };
     }
-    withBasicPrompt() {
+    withTextPrompt() {
         return this.withPromptFormat((0, Automatic1111ImageGenerationPrompt_js_1.mapBasicPromptToAutomatic1111Format)());
     }
     withPromptFormat(promptFormat) {

package/model-provider/automatic1111/Automatic1111ImageGenerationModel.d.ts

@@ -25,7 +25,7 @@ export declare class Automatic1111ImageGenerationModel extends AbstractModel<Aut
         };
         base64Image: string;
     }>;
-    withBasicPrompt(): PromptFormatImageGenerationModel<string, Automatic1111ImageGenerationPrompt, Automatic1111ImageGenerationSettings, this>;
+    withTextPrompt(): PromptFormatImageGenerationModel<string, Automatic1111ImageGenerationPrompt, Automatic1111ImageGenerationSettings, this>;
     withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, Automatic1111ImageGenerationPrompt>): PromptFormatImageGenerationModel<INPUT_PROMPT, Automatic1111ImageGenerationPrompt, Automatic1111ImageGenerationSettings, this>;
     withSettings(additionalSettings: Automatic1111ImageGenerationSettings): this;
 }

package/model-provider/automatic1111/Automatic1111ImageGenerationModel.js

@@ -50,7 +50,7 @@ export class Automatic1111ImageGenerationModel extends AbstractModel {
             base64Image: response.images[0],
         };
     }
-    withBasicPrompt() {
+    withTextPrompt() {
         return this.withPromptFormat(mapBasicPromptToAutomatic1111Format());
     }
     withPromptFormat(promptFormat) {

package/model-provider/llamacpp/LlamaCppBakLLaVA1Format.d.ts

@@ -1,4 +1,4 @@
-import { InstructionPrompt } from "../../model-function/generate-text/prompt-format/InstructionPrompt.js";
+import { MultiModalInstructionPrompt } from "../../model-function/generate-text/prompt-format/InstructionPrompt.js";
 import { TextGenerationPromptFormat } from "../../model-function/generate-text/TextGenerationPromptFormat.js";
 import { LlamaCppTextGenerationPrompt } from "./LlamaCppTextGenerationModel.js";
 /**
@@ -6,4 +6,4 @@ import { LlamaCppTextGenerationPrompt } from "./LlamaCppTextGenerationModel.js";
  *
  * @see https://github.com/SkunkworksAI/BakLLaVA
  */
-export declare function instruction(): TextGenerationPromptFormat<InstructionPrompt, LlamaCppTextGenerationPrompt>;
+export declare function instruction(): TextGenerationPromptFormat<MultiModalInstructionPrompt, LlamaCppTextGenerationPrompt>;

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

@@ -27,7 +27,7 @@ OpenAIChatSettings> {
     /**
      * Returns this model with an instruction prompt format.
      */
-    withInstructionPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptFormat<import("../../../index.js").InstructionPrompt | import("../../../index.js").TextInstructionPrompt, OpenAIChatMessage[]>>;
+    withInstructionPrompt(): OpenAIChatFunctionCallStructureGenerationModel<TextGenerationPromptFormat<import("../../../index.js").MultiModalInstructionPrompt | import("../../../index.js").TextInstructionPrompt, OpenAIChatMessage[]>>;
     /**
      * Returns this model with a chat prompt format.
      */

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

@@ -338,7 +338,7 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
     /**
      * Returns this model with an instruction prompt format.
      */
-    withInstructionPrompt(): PromptFormatTextStreamingModel<import("../../../index.js").InstructionPrompt | import("../../../index.js").TextInstructionPrompt, OpenAIChatMessage[], OpenAIChatSettings, this>;
+    withInstructionPrompt(): PromptFormatTextStreamingModel<import("../../../index.js").MultiModalInstructionPrompt | import("../../../index.js").TextInstructionPrompt, OpenAIChatMessage[], OpenAIChatSettings, this>;
     /**
      * Returns this model with a chat prompt format.
      */

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

@@ -1,6 +1,6 @@
 import { TextGenerationPromptFormat } from "../../../model-function/generate-text/TextGenerationPromptFormat.js";
 import { ChatPrompt } from "../../../model-function/generate-text/prompt-format/ChatPrompt.js";
-import { InstructionPrompt, TextInstructionPrompt } from "../../../model-function/generate-text/prompt-format/InstructionPrompt.js";
+import { MultiModalInstructionPrompt, TextInstructionPrompt } from "../../../model-function/generate-text/prompt-format/InstructionPrompt.js";
 import { OpenAIChatMessage } from "./OpenAIChatMessage.js";
 /**
  * OpenAIMessage[] identity chat format.
@@ -13,7 +13,7 @@ export declare function text(): TextGenerationPromptFormat<string, Array<OpenAIC
 /**
  * Formats an instruction prompt as an OpenAI chat prompt.
  */
-export declare function instruction(): TextGenerationPromptFormat<InstructionPrompt | TextInstructionPrompt, Array<OpenAIChatMessage>>;
+export declare function instruction(): TextGenerationPromptFormat<MultiModalInstructionPrompt | TextInstructionPrompt, Array<OpenAIChatMessage>>;
 /**
  * Formats a chat prompt as an OpenAI chat prompt.
  */

package/model-provider/stability/StabilityImageGenerationModel.cjs

@@ -78,7 +78,7 @@ class StabilityImageGenerationModel extends AbstractModel_js_1.AbstractModel {
             base64Image: response.artifacts[0].base64,
         };
     }
-    withBasicPrompt() {
+    withTextPrompt() {
         return this.withPromptFormat((0, StabilityImageGenerationPrompt_js_1.mapBasicPromptToStabilityFormat)());
     }
     withPromptFormat(promptFormat) {

package/model-provider/stability/StabilityImageGenerationModel.d.ts

@@ -44,7 +44,7 @@ export declare class StabilityImageGenerationModel extends AbstractModel<Stabili
         };
         base64Image: string;
     }>;
-    withBasicPrompt(): PromptFormatImageGenerationModel<string, StabilityImageGenerationPrompt, StabilityImageGenerationSettings, this>;
+    withTextPrompt(): PromptFormatImageGenerationModel<string, StabilityImageGenerationPrompt, StabilityImageGenerationSettings, this>;
     withPromptFormat<INPUT_PROMPT>(promptFormat: PromptFormat<INPUT_PROMPT, StabilityImageGenerationPrompt>): PromptFormatImageGenerationModel<INPUT_PROMPT, StabilityImageGenerationPrompt, StabilityImageGenerationSettings, this>;
     withSettings(additionalSettings: StabilityImageGenerationSettings): this;
 }

package/model-provider/stability/StabilityImageGenerationModel.js

@@ -75,7 +75,7 @@ export class StabilityImageGenerationModel extends AbstractModel {
             base64Image: response.artifacts[0].base64,
         };
     }
-    withBasicPrompt() {
+    withTextPrompt() {
         return this.withPromptFormat(mapBasicPromptToStabilityFormat());
     }
     withPromptFormat(promptFormat) {

package/package.json

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