modelfusion 0.122.0 → 0.124.0

package/model-provider/ollama/OllamaChatModel.d.ts

@@ -40,11 +40,11 @@ export declare class OllamaChatModel extends AbstractModel<OllamaChatModelSettin
     get settingsForEvent(): Partial<OllamaChatModelSettings>;
     doGenerateTexts(prompt: OllamaChatPrompt, options: FunctionCallOptions): Promise<{
         rawResponse: {
-            model: string;
             message: {
                 role: string;
                 content: string;
             };
+            model: string;
             done: true;
             created_at: string;
             total_duration: number;
@@ -61,11 +61,11 @@ export declare class OllamaChatModel extends AbstractModel<OllamaChatModelSettin
     }>;
     restoreGeneratedTexts(rawResponse: unknown): {
         rawResponse: {
-            model: string;
             message: {
                 role: string;
                 content: string;
             };
+            model: string;
             done: true;
             created_at: string;
             total_duration: number;
@@ -82,11 +82,11 @@ export declare class OllamaChatModel extends AbstractModel<OllamaChatModelSettin
     };
     private processTextGenerationResponse;
     doStreamText(prompt: OllamaChatPrompt, options: FunctionCallOptions): Promise<AsyncIterable<import("../../index.js").Delta<{
-        model: string;
         message: {
             role: string;
             content: string;
         };
+        model: string;
         done: false;
         created_at: string;
     } | {
@@ -141,11 +141,11 @@ declare const ollamaChatResponseSchema: z.ZodObject<{
     eval_count: z.ZodNumber;
     eval_duration: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    model: string;
     message: {
         role: string;
         content: string;
     };
+    model: string;
     done: true;
     created_at: string;
     total_duration: number;
@@ -155,11 +155,11 @@ declare const ollamaChatResponseSchema: z.ZodObject<{
     prompt_eval_count?: number | undefined;
     prompt_eval_duration?: number | undefined;
 }, {
-    model: string;
     message: {
         role: string;
         content: string;
     };
+    model: string;
     done: true;
     created_at: string;
     total_duration: number;
@@ -185,19 +185,19 @@ declare const ollamaChatStreamChunkSchema: z.ZodDiscriminatedUnion<"done", [z.Zo
         content: string;
     }>;
 }, "strip", z.ZodTypeAny, {
-    model: string;
     message: {
         role: string;
         content: string;
     };
+    model: string;
     done: false;
     created_at: string;
 }, {
-    model: string;
     message: {
         role: string;
         content: string;
     };
+    model: string;
     done: false;
     created_at: string;
 }>, z.ZodObject<{
@@ -247,11 +247,11 @@ export declare const OllamaChatResponseFormat: {
             requestBodyValues: unknown;
             response: Response;
         }) => Promise<{
-            model: string;
             message: {
                 role: string;
                 content: string;
             };
+            model: string;
             done: true;
             created_at: string;
             total_duration: number;
@@ -271,11 +271,11 @@ export declare const OllamaChatResponseFormat: {
         handler: ({ response }: {
             response: Response;
         }) => Promise<AsyncIterable<import("../../index.js").Delta<{
-            model: string;
             message: {
                 role: string;
                 content: string;
             };
+            model: string;
             done: false;
             created_at: string;
         } | {

package/model-provider/openai/AbstractOpenAITextEmbeddingModel.cjs

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractOpenAITextEmbeddingModel = void 0;
+const zod_1 = require("zod");
+const callWithRetryAndThrottle_js_1 = require("../../core/api/callWithRetryAndThrottle.cjs");
+const postToApi_js_1 = require("../../core/api/postToApi.cjs");
+const ZodSchema_js_1 = require("../../core/schema/ZodSchema.cjs");
+const AbstractModel_js_1 = require("../../model-function/AbstractModel.cjs");
+const OpenAIApiConfiguration_js_1 = require("./OpenAIApiConfiguration.cjs");
+const OpenAIError_js_1 = require("./OpenAIError.cjs");
+/**
+ * Abstract text embedding model that calls an API that is compatible with the OpenAI embedding API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/embeddings
+ */
+class AbstractOpenAITextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
+    constructor(settings) {
+        super({ settings });
+        Object.defineProperty(this, "isParallelizable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+    }
+    get maxValuesPerCall() {
+        return this.settings.maxValuesPerCall ?? 2048;
+    }
+    async callAPI(texts, callOptions) {
+        const api = this.settings.api ?? new OpenAIApiConfiguration_js_1.OpenAIApiConfiguration();
+        const abortSignal = callOptions.run?.abortSignal;
+        return (0, callWithRetryAndThrottle_js_1.callWithRetryAndThrottle)({
+            retry: api.retry,
+            throttle: api.throttle,
+            call: async () => (0, postToApi_js_1.postJsonToApi)({
+                url: api.assembleUrl("/embeddings"),
+                headers: api.headers({
+                    functionType: callOptions.functionType,
+                    functionId: callOptions.functionId,
+                    run: callOptions.run,
+                    callId: callOptions.callId,
+                }),
+                body: {
+                    model: this.modelName,
+                    input: texts,
+                    user: this.settings.isUserIdForwardingEnabled
+                        ? callOptions.run?.userId
+                        : undefined,
+                },
+                failedResponseHandler: OpenAIError_js_1.failedOpenAICallResponseHandler,
+                successfulResponseHandler: (0, postToApi_js_1.createJsonResponseHandler)((0, ZodSchema_js_1.zodSchema)(openAITextEmbeddingResponseSchema)),
+                abortSignal,
+            }),
+        });
+    }
+    async doEmbedValues(texts, callOptions) {
+        if (texts.length > this.maxValuesPerCall) {
+            throw new Error(`The OpenAI embedding API only supports ${this.maxValuesPerCall} texts per API call.`);
+        }
+        const rawResponse = await this.callAPI(texts, callOptions);
+        return {
+            rawResponse,
+            embeddings: rawResponse.data.map((data) => data.embedding),
+        };
+    }
+}
+exports.AbstractOpenAITextEmbeddingModel = AbstractOpenAITextEmbeddingModel;
+const openAITextEmbeddingResponseSchema = zod_1.z.object({
+    object: zod_1.z.literal("list"),
+    data: zod_1.z.array(zod_1.z.object({
+        object: zod_1.z.literal("embedding"),
+        embedding: zod_1.z.array(zod_1.z.number()),
+        index: zod_1.z.number(),
+    })),
+    model: zod_1.z.string(),
+    usage: zod_1.z
+        .object({
+        prompt_tokens: zod_1.z.number(),
+        total_tokens: zod_1.z.number(),
+    })
+        .optional(), // for openai-compatible models
+});

package/model-provider/openai/AbstractOpenAITextEmbeddingModel.d.ts

@@ -0,0 +1,91 @@
+import { z } from "zod";
+import { FunctionCallOptions } from "../../core/FunctionOptions.js";
+import { ApiConfiguration } from "../../core/api/ApiConfiguration.js";
+import { AbstractModel } from "../../model-function/AbstractModel.js";
+import { EmbeddingModelSettings } from "../../model-function/embed/EmbeddingModel.js";
+export interface AbstractOpenAITextEmbeddingModelSettings extends EmbeddingModelSettings {
+    api?: ApiConfiguration;
+    model: string;
+    maxValuesPerCall?: number | undefined;
+    isUserIdForwardingEnabled?: boolean;
+}
+/**
+ * Abstract text embedding model that calls an API that is compatible with the OpenAI embedding API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/embeddings
+ */
+export declare abstract class AbstractOpenAITextEmbeddingModel<SETTINGS extends AbstractOpenAITextEmbeddingModelSettings> extends AbstractModel<SETTINGS> {
+    constructor(settings: SETTINGS);
+    get maxValuesPerCall(): number;
+    readonly isParallelizable = true;
+    callAPI(texts: Array<string>, callOptions: FunctionCallOptions): Promise<OpenAITextEmbeddingResponse>;
+    doEmbedValues(texts: string[], callOptions: FunctionCallOptions): Promise<{
+        rawResponse: {
+            object: "list";
+            data: {
+                object: "embedding";
+                embedding: number[];
+                index: number;
+            }[];
+            model: string;
+            usage?: {
+                prompt_tokens: number;
+                total_tokens: number;
+            } | undefined;
+        };
+        embeddings: number[][];
+    }>;
+}
+declare const openAITextEmbeddingResponseSchema: z.ZodObject<{
+    object: z.ZodLiteral<"list">;
+    data: z.ZodArray<z.ZodObject<{
+        object: z.ZodLiteral<"embedding">;
+        embedding: z.ZodArray<z.ZodNumber, "many">;
+        index: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        object: "embedding";
+        embedding: number[];
+        index: number;
+    }, {
+        object: "embedding";
+        embedding: number[];
+        index: number;
+    }>, "many">;
+    model: z.ZodString;
+    usage: z.ZodOptional<z.ZodObject<{
+        prompt_tokens: z.ZodNumber;
+        total_tokens: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        prompt_tokens: number;
+        total_tokens: number;
+    }, {
+        prompt_tokens: number;
+        total_tokens: number;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    object: "list";
+    data: {
+        object: "embedding";
+        embedding: number[];
+        index: number;
+    }[];
+    model: string;
+    usage?: {
+        prompt_tokens: number;
+        total_tokens: number;
+    } | undefined;
+}, {
+    object: "list";
+    data: {
+        object: "embedding";
+        embedding: number[];
+        index: number;
+    }[];
+    model: string;
+    usage?: {
+        prompt_tokens: number;
+        total_tokens: number;
+    } | undefined;
+}>;
+export type OpenAITextEmbeddingResponse = z.infer<typeof openAITextEmbeddingResponseSchema>;
+export {};

package/model-provider/openai/AbstractOpenAITextEmbeddingModel.js

@@ -0,0 +1,78 @@
+import { z } from "zod";
+import { callWithRetryAndThrottle } from "../../core/api/callWithRetryAndThrottle.js";
+import { createJsonResponseHandler, postJsonToApi, } from "../../core/api/postToApi.js";
+import { zodSchema } from "../../core/schema/ZodSchema.js";
+import { AbstractModel } from "../../model-function/AbstractModel.js";
+import { OpenAIApiConfiguration } from "./OpenAIApiConfiguration.js";
+import { failedOpenAICallResponseHandler } from "./OpenAIError.js";
+/**
+ * Abstract text embedding model that calls an API that is compatible with the OpenAI embedding API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/embeddings
+ */
+export class AbstractOpenAITextEmbeddingModel extends AbstractModel {
+    constructor(settings) {
+        super({ settings });
+        Object.defineProperty(this, "isParallelizable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+    }
+    get maxValuesPerCall() {
+        return this.settings.maxValuesPerCall ?? 2048;
+    }
+    async callAPI(texts, callOptions) {
+        const api = this.settings.api ?? new OpenAIApiConfiguration();
+        const abortSignal = callOptions.run?.abortSignal;
+        return callWithRetryAndThrottle({
+            retry: api.retry,
+            throttle: api.throttle,
+            call: async () => postJsonToApi({
+                url: api.assembleUrl("/embeddings"),
+                headers: api.headers({
+                    functionType: callOptions.functionType,
+                    functionId: callOptions.functionId,
+                    run: callOptions.run,
+                    callId: callOptions.callId,
+                }),
+                body: {
+                    model: this.modelName,
+                    input: texts,
+                    user: this.settings.isUserIdForwardingEnabled
+                        ? callOptions.run?.userId
+                        : undefined,
+                },
+                failedResponseHandler: failedOpenAICallResponseHandler,
+                successfulResponseHandler: createJsonResponseHandler(zodSchema(openAITextEmbeddingResponseSchema)),
+                abortSignal,
+            }),
+        });
+    }
+    async doEmbedValues(texts, callOptions) {
+        if (texts.length > this.maxValuesPerCall) {
+            throw new Error(`The OpenAI embedding API only supports ${this.maxValuesPerCall} texts per API call.`);
+        }
+        const rawResponse = await this.callAPI(texts, callOptions);
+        return {
+            rawResponse,
+            embeddings: rawResponse.data.map((data) => data.embedding),
+        };
+    }
+}
+const openAITextEmbeddingResponseSchema = z.object({
+    object: z.literal("list"),
+    data: z.array(z.object({
+        object: z.literal("embedding"),
+        embedding: z.array(z.number()),
+        index: z.number(),
+    })),
+    model: z.string(),
+    usage: z
+        .object({
+        prompt_tokens: z.number(),
+        total_tokens: z.number(),
+    })
+        .optional(), // for openai-compatible models
+});

package/model-provider/openai/OpenAIFacade.cjs

@@ -42,10 +42,10 @@ exports.AzureApi = AzureApi;
  *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
  * });
  *
- * const text = await generateText(
+ * const text = await generateText({
  *   model,
- *   "Write a short story about a robot learning to love:\n\n"
- * );
+ *   prompt: "Write a short story about a robot learning to love:\n\n"
+ * });
  *
  * @return A new instance of {@link OpenAICompletionModel}.
  */
@@ -65,14 +65,14 @@ exports.CompletionTextGenerator = CompletionTextGenerator;
  *   maxGenerationTokens: 500,
  * });
  *
- * const text = await generateText(
+ * const text = await generateText({
  *   model,
- *   [
+ *   prompt: [
  *     openai.ChatMessage.system(
  *       "Write a short story about a robot learning to love:"
  *     ),
  *   ]
- * );
+ * });
  */
 function ChatTextGenerator(settings) {
     return new OpenAIChatModel_js_1.OpenAIChatModel(settings);
@@ -84,13 +84,13 @@ exports.ChatTextGenerator = ChatTextGenerator;
  * @see https://platform.openai.com/docs/api-reference/embeddings
  *
  * @example
- * const embeddings = await embedMany(
- *   openai.TextEmbedder({ model: "text-embedding-ada-002" }),
- *   [
+ * const embeddings = await embedMany({
+ *   model: openai.TextEmbedder({ model: "text-embedding-ada-002" }),
+ *   values: [
  *     "At first, Nox didn't know what to do with the pup.",
  *     "He keenly observed and absorbed everything around him, from the birds in the sky to the trees in the forest.",
  *   ]
- * );
+ * });
  *
  * @returns A new instance of {@link OpenAITextEmbeddingModel}.
  */
@@ -117,13 +117,13 @@ exports.SpeechGenerator = SpeechGenerator;
  * @example
  * const data = await fs.promises.readFile("data/test.mp3");
  *
- * const transcription = await transcribe(
- *   openai.Transcriber({ model: "whisper-1" }),
- *   {
+ * const transcription = await transcribe({
+ *   model: openai.Transcriber({ model: "whisper-1" }),
+ *   data: {
  *     type: "mp3",
  *     data,
  *   }
- * );
+ * });
  *
  * @returns A new instance of {@link OpenAITranscriptionModel}.
  */
@@ -137,10 +137,10 @@ exports.Transcriber = Transcriber;
  * @see https://platform.openai.com/docs/api-reference/images/create
  *
  * @example
- * const image = await generateImage(
- *   new OpenAIImageGenerationModel({ size: "512x512" }),
- *   "the wicked witch of the west in the style of early 19th century painting"
- * );
+ * const image = await generateImage({
+ *   model: new OpenAIImageGenerationModel({ size: "512x512" }),
+ *   prompt: "the wicked witch of the west in the style of early 19th century painting"
+ * });
  *
  * @returns A new instance of {@link OpenAIImageGenerationModel}.
  */

package/model-provider/openai/OpenAIFacade.d.ts

@@ -36,10 +36,10 @@ export declare function AzureApi(settings: AzureOpenAIApiConfigurationOptions):
  *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
  * });
  *
- * const text = await generateText(
+ * const text = await generateText({
  *   model,
- *   "Write a short story about a robot learning to love:\n\n"
- * );
+ *   prompt: "Write a short story about a robot learning to love:\n\n"
+ * });
  *
  * @return A new instance of {@link OpenAICompletionModel}.
  */
@@ -56,14 +56,14 @@ export declare function CompletionTextGenerator(settings: OpenAICompletionModelS
  *   maxGenerationTokens: 500,
  * });
  *
- * const text = await generateText(
+ * const text = await generateText({
  *   model,
- *   [
+ *   prompt: [
  *     openai.ChatMessage.system(
  *       "Write a short story about a robot learning to love:"
  *     ),
  *   ]
- * );
+ * });
  */
 export declare function ChatTextGenerator(settings: OpenAIChatSettings): OpenAIChatModel;
 /**
@@ -72,13 +72,13 @@ export declare function ChatTextGenerator(settings: OpenAIChatSettings): OpenAIC
  * @see https://platform.openai.com/docs/api-reference/embeddings
  *
  * @example
- * const embeddings = await embedMany(
- *   openai.TextEmbedder({ model: "text-embedding-ada-002" }),
- *   [
+ * const embeddings = await embedMany({
+ *   model: openai.TextEmbedder({ model: "text-embedding-ada-002" }),
+ *   values: [
  *     "At first, Nox didn't know what to do with the pup.",
  *     "He keenly observed and absorbed everything around him, from the birds in the sky to the trees in the forest.",
  *   ]
- * );
+ * });
  *
  * @returns A new instance of {@link OpenAITextEmbeddingModel}.
  */
@@ -99,13 +99,13 @@ export declare function SpeechGenerator(settings: OpenAISpeechModelSettings): Op
  * @example
  * const data = await fs.promises.readFile("data/test.mp3");
  *
- * const transcription = await transcribe(
- *   openai.Transcriber({ model: "whisper-1" }),
- *   {
+ * const transcription = await transcribe({
+ *   model: openai.Transcriber({ model: "whisper-1" }),
+ *   data: {
  *     type: "mp3",
  *     data,
  *   }
- * );
+ * });
  *
  * @returns A new instance of {@link OpenAITranscriptionModel}.
  */
@@ -116,10 +116,10 @@ export declare function Transcriber(settings: OpenAITranscriptionModelSettings):
  * @see https://platform.openai.com/docs/api-reference/images/create
  *
  * @example
- * const image = await generateImage(
- *   new OpenAIImageGenerationModel({ size: "512x512" }),
- *   "the wicked witch of the west in the style of early 19th century painting"
- * );
+ * const image = await generateImage({
+ *   model: new OpenAIImageGenerationModel({ size: "512x512" }),
+ *   prompt: "the wicked witch of the west in the style of early 19th century painting"
+ * });
  *
  * @returns A new instance of {@link OpenAIImageGenerationModel}.
  */

package/model-provider/openai/OpenAIFacade.js

@@ -37,10 +37,10 @@ export function AzureApi(settings) {
  *   retry: retryWithExponentialBackoff({ maxTries: 5 }),
  * });
  *
- * const text = await generateText(
+ * const text = await generateText({
  *   model,
- *   "Write a short story about a robot learning to love:\n\n"
- * );
+ *   prompt: "Write a short story about a robot learning to love:\n\n"
+ * });
  *
  * @return A new instance of {@link OpenAICompletionModel}.
  */
@@ -59,14 +59,14 @@ export function CompletionTextGenerator(settings) {
  *   maxGenerationTokens: 500,
  * });
  *
- * const text = await generateText(
+ * const text = await generateText({
  *   model,
- *   [
+ *   prompt: [
  *     openai.ChatMessage.system(
  *       "Write a short story about a robot learning to love:"
  *     ),
  *   ]
- * );
+ * });
  */
 export function ChatTextGenerator(settings) {
     return new OpenAIChatModel(settings);
@@ -77,13 +77,13 @@ export function ChatTextGenerator(settings) {
  * @see https://platform.openai.com/docs/api-reference/embeddings
  *
  * @example
- * const embeddings = await embedMany(
- *   openai.TextEmbedder({ model: "text-embedding-ada-002" }),
- *   [
+ * const embeddings = await embedMany({
+ *   model: openai.TextEmbedder({ model: "text-embedding-ada-002" }),
+ *   values: [
  *     "At first, Nox didn't know what to do with the pup.",
  *     "He keenly observed and absorbed everything around him, from the birds in the sky to the trees in the forest.",
  *   ]
- * );
+ * });
  *
  * @returns A new instance of {@link OpenAITextEmbeddingModel}.
  */
@@ -108,13 +108,13 @@ export function SpeechGenerator(settings) {
  * @example
  * const data = await fs.promises.readFile("data/test.mp3");
  *
- * const transcription = await transcribe(
- *   openai.Transcriber({ model: "whisper-1" }),
- *   {
+ * const transcription = await transcribe({
+ *   model: openai.Transcriber({ model: "whisper-1" }),
+ *   data: {
  *     type: "mp3",
  *     data,
  *   }
- * );
+ * });
  *
  * @returns A new instance of {@link OpenAITranscriptionModel}.
  */
@@ -127,10 +127,10 @@ export function Transcriber(settings) {
  * @see https://platform.openai.com/docs/api-reference/images/create
  *
  * @example
- * const image = await generateImage(
- *   new OpenAIImageGenerationModel({ size: "512x512" }),
- *   "the wicked witch of the west in the style of early 19th century painting"
- * );
+ * const image = await generateImage({
+ *   model: new OpenAIImageGenerationModel({ size: "512x512" }),
+ *   prompt: "the wicked witch of the west in the style of early 19th century painting"
+ * });
  *
  * @returns A new instance of {@link OpenAIImageGenerationModel}.
  */