modelfusion 0.107.0 → 0.108.0

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

@@ -7,7 +7,7 @@ import { TextGenerationModelSettings } from "../../model-function/generate-text/
 import { TextGenerationFinishReason } from "../../model-function/generate-text/TextGenerationResult.js";
 import { ToolDefinition } from "../../tool/ToolDefinition.js";
 import { OpenAIChatMessage } from "./OpenAIChatMessage.js";
-export interface AbstractOpenAIChatCallSettings {
+export interface AbstractOpenAIChatSettings extends TextGenerationModelSettings {
     api?: ApiConfiguration;
     model: string;
     functions?: Array<{
@@ -72,8 +72,6 @@ export interface AbstractOpenAIChatCallSettings {
         type?: "text" | "json_object";
     };
     logitBias?: Record<number, number>;
-}
-export interface AbstractOpenAIChatSettings extends TextGenerationModelSettings, AbstractOpenAIChatCallSettings {
     isUserIdForwardingEnabled?: boolean;
 }
 export type OpenAIChatPrompt = OpenAIChatMessage[];
@@ -87,10 +85,10 @@ export declare abstract class AbstractOpenAIChatModel<SETTINGS extends AbstractO
     callAPI<RESULT>(messages: OpenAIChatPrompt, options: {
         responseFormat: OpenAIChatResponseFormatType<RESULT>;
     } & FunctionOptions & {
-        functions?: AbstractOpenAIChatCallSettings["functions"];
-        functionCall?: AbstractOpenAIChatCallSettings["functionCall"];
-        tools?: AbstractOpenAIChatCallSettings["tools"];
-        toolChoice?: AbstractOpenAIChatCallSettings["toolChoice"];
+        functions?: AbstractOpenAIChatSettings["functions"];
+        functionCall?: AbstractOpenAIChatSettings["functionCall"];
+        tools?: AbstractOpenAIChatSettings["tools"];
+        toolChoice?: AbstractOpenAIChatSettings["toolChoice"];
     }): Promise<RESULT>;
     doGenerateTexts(prompt: OpenAIChatPrompt, options?: FunctionOptions): Promise<{
         response: {
@@ -163,8 +161,6 @@ export declare abstract class AbstractOpenAIChatModel<SETTINGS extends AbstractO
             finish_reason?: "length" | "stop" | "function_call" | "tool_calls" | "content_filter" | null | undefined;
         }[];
         system_fingerprint?: string | null | undefined;
-    } | {
-        object: string;
     }>>>;
     extractTextDelta(delta: unknown): string | undefined;
     doGenerateToolCall(tool: ToolDefinition<string, unknown>, prompt: OpenAIChatPrompt, options?: FunctionOptions): Promise<{
@@ -465,180 +461,6 @@ declare const openAIChatResponseSchema: z.ZodObject<{
     system_fingerprint?: string | null | undefined;
 }>;
 export type OpenAIChatResponse = z.infer<typeof openAIChatResponseSchema>;
-declare const chatCompletionChunkSchema: z.ZodObject<{
-    object: z.ZodLiteral<"chat.completion.chunk">;
-    id: z.ZodString;
-    choices: z.ZodArray<z.ZodObject<{
-        delta: z.ZodObject<{
-            role: z.ZodOptional<z.ZodEnum<["assistant", "user"]>>;
-            content: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-            function_call: z.ZodOptional<z.ZodObject<{
-                name: z.ZodOptional<z.ZodString>;
-                arguments: z.ZodOptional<z.ZodString>;
-            }, "strip", z.ZodTypeAny, {
-                name?: string | undefined;
-                arguments?: string | undefined;
-            }, {
-                name?: string | undefined;
-                arguments?: string | undefined;
-            }>>;
-            tool_calls: z.ZodOptional<z.ZodArray<z.ZodObject<{
-                id: z.ZodString;
-                type: z.ZodLiteral<"function">;
-                function: z.ZodObject<{
-                    name: z.ZodString;
-                    arguments: z.ZodString;
-                }, "strip", z.ZodTypeAny, {
-                    name: string;
-                    arguments: string;
-                }, {
-                    name: string;
-                    arguments: string;
-                }>;
-            }, "strip", z.ZodTypeAny, {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }, {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }>, "many">>;
-        }, "strip", z.ZodTypeAny, {
-            role?: "user" | "assistant" | undefined;
-            content?: string | null | undefined;
-            function_call?: {
-                name?: string | undefined;
-                arguments?: string | undefined;
-            } | undefined;
-            tool_calls?: {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }[] | undefined;
-        }, {
-            role?: "user" | "assistant" | undefined;
-            content?: string | null | undefined;
-            function_call?: {
-                name?: string | undefined;
-                arguments?: string | undefined;
-            } | undefined;
-            tool_calls?: {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }[] | undefined;
-        }>;
-        finish_reason: z.ZodOptional<z.ZodNullable<z.ZodEnum<["stop", "length", "tool_calls", "content_filter", "function_call"]>>>;
-        index: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        delta: {
-            role?: "user" | "assistant" | undefined;
-            content?: string | null | undefined;
-            function_call?: {
-                name?: string | undefined;
-                arguments?: string | undefined;
-            } | undefined;
-            tool_calls?: {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }[] | undefined;
-        };
-        index: number;
-        finish_reason?: "length" | "stop" | "function_call" | "tool_calls" | "content_filter" | null | undefined;
-    }, {
-        delta: {
-            role?: "user" | "assistant" | undefined;
-            content?: string | null | undefined;
-            function_call?: {
-                name?: string | undefined;
-                arguments?: string | undefined;
-            } | undefined;
-            tool_calls?: {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }[] | undefined;
-        };
-        index: number;
-        finish_reason?: "length" | "stop" | "function_call" | "tool_calls" | "content_filter" | null | undefined;
-    }>, "many">;
-    created: z.ZodNumber;
-    model: z.ZodString;
-    system_fingerprint: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-}, "strip", z.ZodTypeAny, {
-    object: "chat.completion.chunk";
-    model: string;
-    id: string;
-    created: number;
-    choices: {
-        delta: {
-            role?: "user" | "assistant" | undefined;
-            content?: string | null | undefined;
-            function_call?: {
-                name?: string | undefined;
-                arguments?: string | undefined;
-            } | undefined;
-            tool_calls?: {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }[] | undefined;
-        };
-        index: number;
-        finish_reason?: "length" | "stop" | "function_call" | "tool_calls" | "content_filter" | null | undefined;
-    }[];
-    system_fingerprint?: string | null | undefined;
-}, {
-    object: "chat.completion.chunk";
-    model: string;
-    id: string;
-    created: number;
-    choices: {
-        delta: {
-            role?: "user" | "assistant" | undefined;
-            content?: string | null | undefined;
-            function_call?: {
-                name?: string | undefined;
-                arguments?: string | undefined;
-            } | undefined;
-            tool_calls?: {
-                function: {
-                    name: string;
-                    arguments: string;
-                };
-                type: "function";
-                id: string;
-            }[] | undefined;
-        };
-        index: number;
-        finish_reason?: "length" | "stop" | "function_call" | "tool_calls" | "content_filter" | null | undefined;
-    }[];
-    system_fingerprint?: string | null | undefined;
-}>;
-export type OpenAIChatCompletionChunk = z.infer<typeof chatCompletionChunkSchema>;
 declare const openaiChatChunkSchema: import("../../core/schema/ZodSchema.js").ZodSchema<{
     object: "chat.completion.chunk";
     model: string;
@@ -665,8 +487,6 @@ declare const openaiChatChunkSchema: import("../../core/schema/ZodSchema.js").Zo
         finish_reason?: "length" | "stop" | "function_call" | "tool_calls" | "content_filter" | null | undefined;
     }[];
     system_fingerprint?: string | null | undefined;
-} | {
-    object: string;
 }>;
 export type OpenAIChatChunk = (typeof openaiChatChunkSchema)["_type"];
 export type OpenAIChatResponseFormatType<T> = {
@@ -746,8 +566,6 @@ export declare const OpenAIChatResponseFormat: {
                 finish_reason?: "length" | "stop" | "function_call" | "tool_calls" | "content_filter" | null | undefined;
             }[];
             system_fingerprint?: string | null | undefined;
-        } | {
-            object: string;
         }>>>;
     };
 };

package/model-provider/openai/AbstractOpenAIChatModel.js

@@ -228,7 +228,7 @@ const openAIChatResponseSchema = z.object({
         total_tokens: z.number(),
     }),
 });
-const chatCompletionChunkSchema = z.object({
+const openaiChatChunkSchema = zodSchema(z.object({
     object: z.literal("chat.completion.chunk"),
     id: z.string(),
     choices: z.array(z.object({
@@ -267,15 +267,7 @@ const chatCompletionChunkSchema = z.object({
     created: z.number(),
     model: z.string(),
     system_fingerprint: z.string().optional().nullable(),
-});
-const openaiChatChunkSchema = zodSchema(z.union([
-    chatCompletionChunkSchema,
-    z.object({
-        object: z.string().refine((obj) => obj !== "chat.completion.chunk", {
-            message: "Object must be 'chat.completion.chunk'",
-        }),
-    }),
-]));
+}));
 export const OpenAIChatResponseFormat = {
     /**
      * Returns the response as a JSON object.

package/model-provider/openai/AbstractOpenAICompletionModel.cjs

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenAITextResponseFormat = exports.AbstractOpenAICompletionModel = 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 createEventSourceResponseHandler_js_1 = require("../../util/streaming/createEventSourceResponseHandler.cjs");
+const OpenAIApiConfiguration_js_1 = require("./OpenAIApiConfiguration.cjs");
+const OpenAIError_js_1 = require("./OpenAIError.cjs");
+/**
+ * Abstract completion model that calls an API that is compatible with the OpenAI completions API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/completions/create
+ */
+class AbstractOpenAICompletionModel extends AbstractModel_js_1.AbstractModel {
+    constructor(settings) {
+        super({ settings });
+    }
+    async callAPI(prompt, options) {
+        const api = this.settings.api ?? new OpenAIApiConfiguration_js_1.OpenAIApiConfiguration();
+        const user = this.settings.isUserIdForwardingEnabled
+            ? options.run?.userId
+            : undefined;
+        const abortSignal = options.run?.abortSignal;
+        const openaiResponseFormat = options.responseFormat;
+        // empty arrays are not allowed for stop:
+        const stopSequences = this.settings.stopSequences != null &&
+            Array.isArray(this.settings.stopSequences) &&
+            this.settings.stopSequences.length === 0
+            ? undefined
+            : this.settings.stopSequences;
+        return (0, callWithRetryAndThrottle_js_1.callWithRetryAndThrottle)({
+            retry: api.retry,
+            throttle: api.throttle,
+            call: async () => {
+                return (0, postToApi_js_1.postJsonToApi)({
+                    url: api.assembleUrl("/completions"),
+                    headers: api.headers,
+                    body: {
+                        stream: openaiResponseFormat.stream,
+                        model: this.settings.model,
+                        prompt,
+                        suffix: this.settings.suffix,
+                        max_tokens: this.settings.maxGenerationTokens,
+                        temperature: this.settings.temperature,
+                        top_p: this.settings.topP,
+                        n: this.settings.numberOfGenerations,
+                        logprobs: this.settings.logprobs,
+                        echo: this.settings.echo,
+                        stop: stopSequences,
+                        seed: this.settings.seed,
+                        presence_penalty: this.settings.presencePenalty,
+                        frequency_penalty: this.settings.frequencyPenalty,
+                        best_of: this.settings.bestOf,
+                        logit_bias: this.settings.logitBias,
+                        user,
+                    },
+                    failedResponseHandler: OpenAIError_js_1.failedOpenAICallResponseHandler,
+                    successfulResponseHandler: openaiResponseFormat.handler,
+                    abortSignal,
+                });
+            },
+        });
+    }
+    async doGenerateTexts(prompt, options) {
+        const response = await this.callAPI(prompt, {
+            ...options,
+            responseFormat: exports.OpenAITextResponseFormat.json,
+        });
+        return {
+            response,
+            textGenerationResults: response.choices.map((choice) => {
+                return {
+                    finishReason: this.translateFinishReason(choice.finish_reason),
+                    text: choice.text,
+                };
+            }),
+            usage: {
+                promptTokens: response.usage.prompt_tokens,
+                completionTokens: response.usage.completion_tokens,
+                totalTokens: response.usage.total_tokens,
+            },
+        };
+    }
+    translateFinishReason(finishReason) {
+        switch (finishReason) {
+            case "stop":
+                return "stop";
+            case "length":
+                return "length";
+            case "content_filter":
+                return "content-filter";
+            default:
+                return "unknown";
+        }
+    }
+    doStreamText(prompt, options) {
+        return this.callAPI(prompt, {
+            ...options,
+            responseFormat: exports.OpenAITextResponseFormat.deltaIterable,
+        });
+    }
+    extractTextDelta(delta) {
+        const chunk = delta;
+        const firstChoice = chunk.choices[0];
+        if (firstChoice.index > 0) {
+            return undefined;
+        }
+        return chunk.choices[0].text;
+    }
+}
+exports.AbstractOpenAICompletionModel = AbstractOpenAICompletionModel;
+const OpenAICompletionResponseSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    choices: zod_1.z.array(zod_1.z.object({
+        finish_reason: zod_1.z
+            .enum(["stop", "length", "content_filter"])
+            .optional()
+            .nullable(),
+        index: zod_1.z.number(),
+        logprobs: zod_1.z.nullable(zod_1.z.any()),
+        text: zod_1.z.string(),
+    })),
+    created: zod_1.z.number(),
+    model: zod_1.z.string(),
+    system_fingerprint: zod_1.z.string().optional(),
+    object: zod_1.z.literal("text_completion"),
+    usage: zod_1.z.object({
+        prompt_tokens: zod_1.z.number(),
+        completion_tokens: zod_1.z.number(),
+        total_tokens: zod_1.z.number(),
+    }),
+});
+const openaiCompletionStreamChunkSchema = (0, ZodSchema_js_1.zodSchema)(zod_1.z.object({
+    choices: zod_1.z.array(zod_1.z.object({
+        text: zod_1.z.string(),
+        finish_reason: zod_1.z
+            .enum(["stop", "length", "content_filter"])
+            .optional()
+            .nullable(),
+        index: zod_1.z.number(),
+    })),
+    created: zod_1.z.number(),
+    id: zod_1.z.string(),
+    model: zod_1.z.string(),
+    system_fingerprint: zod_1.z.string().optional(),
+    object: zod_1.z.literal("text_completion"),
+}));
+exports.OpenAITextResponseFormat = {
+    /**
+     * Returns the response as a JSON object.
+     */
+    json: {
+        stream: false,
+        handler: (0, postToApi_js_1.createJsonResponseHandler)(OpenAICompletionResponseSchema),
+    },
+    /**
+     * Returns an async iterable over the full deltas (all choices, including full current state at time of event)
+     * of the response stream.
+     */
+    deltaIterable: {
+        stream: true,
+        handler: (0, createEventSourceResponseHandler_js_1.createEventSourceResponseHandler)(openaiCompletionStreamChunkSchema),
+    },
+};

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

@@ -0,0 +1,199 @@
+import { z } from "zod";
+import { FunctionOptions } from "../../core/FunctionOptions.js";
+import { ApiConfiguration } from "../../core/api/ApiConfiguration.js";
+import { ResponseHandler } from "../../core/api/postToApi.js";
+import { AbstractModel } from "../../model-function/AbstractModel.js";
+import { TextGenerationModelSettings } from "../../model-function/generate-text/TextGenerationModel.js";
+import { TextGenerationFinishReason } from "../../model-function/generate-text/TextGenerationResult.js";
+export interface AbstractOpenAICompletionModelSettings extends TextGenerationModelSettings {
+    api?: ApiConfiguration;
+    model: string;
+    suffix?: string;
+    temperature?: number;
+    topP?: number;
+    logprobs?: number;
+    echo?: boolean;
+    presencePenalty?: number;
+    frequencyPenalty?: number;
+    bestOf?: number;
+    logitBias?: Record<number, number>;
+    seed?: number | null;
+    isUserIdForwardingEnabled?: boolean;
+}
+/**
+ * Abstract completion model that calls an API that is compatible with the OpenAI completions API.
+ *
+ * @see https://platform.openai.com/docs/api-reference/completions/create
+ */
+export declare abstract class AbstractOpenAICompletionModel<SETTINGS extends AbstractOpenAICompletionModelSettings> extends AbstractModel<SETTINGS> {
+    constructor(settings: SETTINGS);
+    callAPI<RESULT>(prompt: string, options: {
+        responseFormat: OpenAITextResponseFormatType<RESULT>;
+    } & FunctionOptions): Promise<RESULT>;
+    doGenerateTexts(prompt: string, options?: FunctionOptions): Promise<{
+        response: {
+            object: "text_completion";
+            usage: {
+                prompt_tokens: number;
+                completion_tokens: number;
+                total_tokens: number;
+            };
+            model: string;
+            id: string;
+            created: number;
+            choices: {
+                text: string;
+                index: number;
+                finish_reason?: "length" | "stop" | "content_filter" | null | undefined;
+                logprobs?: any;
+            }[];
+            system_fingerprint?: string | undefined;
+        };
+        textGenerationResults: {
+            finishReason: TextGenerationFinishReason;
+            text: string;
+        }[];
+        usage: {
+            promptTokens: number;
+            completionTokens: number;
+            totalTokens: number;
+        };
+    }>;
+    private translateFinishReason;
+    doStreamText(prompt: string, options?: FunctionOptions): Promise<AsyncIterable<import("../../index.js").Delta<{
+        object: "text_completion";
+        model: string;
+        id: string;
+        created: number;
+        choices: {
+            text: string;
+            index: number;
+            finish_reason?: "length" | "stop" | "content_filter" | null | undefined;
+        }[];
+        system_fingerprint?: string | undefined;
+    }>>>;
+    extractTextDelta(delta: unknown): string | undefined;
+}
+declare const OpenAICompletionResponseSchema: z.ZodObject<{
+    id: z.ZodString;
+    choices: z.ZodArray<z.ZodObject<{
+        finish_reason: z.ZodNullable<z.ZodOptional<z.ZodEnum<["stop", "length", "content_filter"]>>>;
+        index: z.ZodNumber;
+        logprobs: z.ZodNullable<z.ZodAny>;
+        text: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        text: string;
+        index: number;
+        finish_reason?: "length" | "stop" | "content_filter" | null | undefined;
+        logprobs?: any;
+    }, {
+        text: string;
+        index: number;
+        finish_reason?: "length" | "stop" | "content_filter" | null | undefined;
+        logprobs?: any;
+    }>, "many">;
+    created: z.ZodNumber;
+    model: z.ZodString;
+    system_fingerprint: z.ZodOptional<z.ZodString>;
+    object: z.ZodLiteral<"text_completion">;
+    usage: z.ZodObject<{
+        prompt_tokens: z.ZodNumber;
+        completion_tokens: z.ZodNumber;
+        total_tokens: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        prompt_tokens: number;
+        completion_tokens: number;
+        total_tokens: number;
+    }, {
+        prompt_tokens: number;
+        completion_tokens: number;
+        total_tokens: number;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    object: "text_completion";
+    usage: {
+        prompt_tokens: number;
+        completion_tokens: number;
+        total_tokens: number;
+    };
+    model: string;
+    id: string;
+    created: number;
+    choices: {
+        text: string;
+        index: number;
+        finish_reason?: "length" | "stop" | "content_filter" | null | undefined;
+        logprobs?: any;
+    }[];
+    system_fingerprint?: string | undefined;
+}, {
+    object: "text_completion";
+    usage: {
+        prompt_tokens: number;
+        completion_tokens: number;
+        total_tokens: number;
+    };
+    model: string;
+    id: string;
+    created: number;
+    choices: {
+        text: string;
+        index: number;
+        finish_reason?: "length" | "stop" | "content_filter" | null | undefined;
+        logprobs?: any;
+    }[];
+    system_fingerprint?: string | undefined;
+}>;
+export type OpenAICompletionResponse = z.infer<typeof OpenAICompletionResponseSchema>;
+export type OpenAITextResponseFormatType<T> = {
+    stream: boolean;
+    handler: ResponseHandler<T>;
+};
+export declare const OpenAITextResponseFormat: {
+    /**
+     * Returns the response as a JSON object.
+     */
+    json: {
+        stream: boolean;
+        handler: ResponseHandler<{
+            object: "text_completion";
+            usage: {
+                prompt_tokens: number;
+                completion_tokens: number;
+                total_tokens: number;
+            };
+            model: string;
+            id: string;
+            created: number;
+            choices: {
+                text: string;
+                index: number;
+                finish_reason?: "length" | "stop" | "content_filter" | null | undefined;
+                logprobs?: any;
+            }[];
+            system_fingerprint?: string | undefined;
+        }>;
+    };
+    /**
+     * Returns an async iterable over the full deltas (all choices, including full current state at time of event)
+     * of the response stream.
+     */
+    deltaIterable: {
+        stream: boolean;
+        handler: ({ response }: {
+            response: Response;
+        }) => Promise<AsyncIterable<import("../../index.js").Delta<{
+            object: "text_completion";
+            model: string;
+            id: string;
+            created: number;
+            choices: {
+                text: string;
+                index: number;
+                finish_reason?: "length" | "stop" | "content_filter" | null | undefined;
+            }[];
+            system_fingerprint?: string | undefined;
+        }>>>;
+    };
+};
+export {};