modelfusion 0.83.0 → 0.84.0

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

@@ -1,17 +1,9 @@
-import { z } from "zod";
-import { callWithRetryAndThrottle } from "../../../core/api/callWithRetryAndThrottle.js";
-import { createJsonResponseHandler, postJsonToApi, } from "../../../core/api/postToApi.js";
-import { parseJSON } from "../../../core/schema/parseJSON.js";
-import { AbstractModel } from "../../../model-function/AbstractModel.js";
 import { StructureFromTextStreamingModel } from "../../../model-function/generate-structure/StructureFromTextStreamingModel.js";
-import { parsePartialJson } from "../../../model-function/generate-structure/parsePartialJson.js";
 import { PromptFormatTextStreamingModel } from "../../../model-function/generate-text/PromptFormatTextStreamingModel.js";
-import { OpenAIApiConfiguration } from "../OpenAIApiConfiguration.js";
-import { failedOpenAICallResponseHandler } from "../OpenAIError.js";
 import { TikTokenTokenizer } from "../TikTokenTokenizer.js";
+import { AbstractOpenAIChatModel, } from "./AbstractOpenAIChatModel.js";
 import { OpenAIChatFunctionCallStructureGenerationModel } from "./OpenAIChatFunctionCallStructureGenerationModel.js";
 import { chat, identity, instruction, text } from "./OpenAIChatPromptFormat.js";
-import { createOpenAIChatDeltaIterableQueue } from "./OpenAIChatStreamIterable.js";
 import { countOpenAIChatPromptTokens } from "./countOpenAIChatMessageTokens.js";
 /*
  * Available OpenAI chat models, their token limits, and pricing.
@@ -138,7 +130,7 @@ export const calculateOpenAIChatCostInMillicents = ({ model, response, }) => {
         response.usage.completion_tokens * completionTokenCostInMillicents);
 };
 /**
- * Create a text generation model that calls the OpenAI chat completion API.
+ * Create a text generation model that calls the OpenAI chat API.
  *
  * @see https://platform.openai.com/docs/api-reference/chat/create
  *
@@ -156,9 +148,9 @@ export const calculateOpenAIChatCostInMillicents = ({ model, response, }) => {
  *   ),
  * ]);
  */
-export class OpenAIChatModel extends AbstractModel {
+export class OpenAIChatModel extends AbstractOpenAIChatModel {
     constructor(settings) {
-        super({ settings });
+        super(settings);
         Object.defineProperty(this, "provider", {
             enumerable: true,
             configurable: true,
@@ -196,31 +188,6 @@ export class OpenAIChatModel extends AbstractModel {
             model: this.modelName,
         });
     }
-    async callAPI(messages, options) {
-        return callWithRetryAndThrottle({
-            retry: this.settings.api?.retry,
-            throttle: this.settings.api?.throttle,
-            call: async () => callOpenAIChatCompletionAPI({
-                ...this.settings,
-                // function & tool calling:
-                functions: options.functions ?? this.settings.functions,
-                functionCall: options.functionCall ?? this.settings.functionCall,
-                tools: options.tools ?? this.settings.tools,
-                toolChoice: options.toolChoice ?? this.settings.toolChoice,
-                // map to OpenAI API names:
-                stop: this.settings.stopSequences,
-                maxTokens: this.settings.maxCompletionTokens,
-                openAIResponseFormat: this.settings.responseFormat,
-                // other settings:
-                user: this.settings.isUserIdForwardingEnabled
-                    ? options.run?.userId
-                    : undefined,
-                abortSignal: options.run?.abortSignal,
-                responseFormat: options.responseFormat,
-                messages,
-            }),
-        });
-    }
     get settingsForEvent() {
         const eventSettingProperties = [
             "stopSequences",
@@ -238,87 +205,6 @@ export class OpenAIChatModel extends AbstractModel {
         ];
         return Object.fromEntries(Object.entries(this.settings).filter(([key]) => eventSettingProperties.includes(key)));
     }
-    async doGenerateText(prompt, options) {
-        const response = await this.callAPI(prompt, {
-            ...options,
-            responseFormat: OpenAIChatResponseFormat.json,
-        });
-        return {
-            response,
-            text: response.choices[0].message.content,
-            usage: this.extractUsage(response),
-        };
-    }
-    doStreamText(prompt, options) {
-        return this.callAPI(prompt, {
-            ...options,
-            responseFormat: OpenAIChatResponseFormat.textDeltaIterable,
-        });
-    }
-    async doGenerateToolCall(tool, prompt, options) {
-        const response = await this.callAPI(prompt, {
-            ...options,
-            responseFormat: OpenAIChatResponseFormat.json,
-            toolChoice: {
-                type: "function",
-                function: { name: tool.name },
-            },
-            tools: [
-                {
-                    type: "function",
-                    function: {
-                        name: tool.name,
-                        description: tool.description,
-                        parameters: tool.parameters.getJsonSchema(),
-                    },
-                },
-            ],
-        });
-        const toolCalls = response.choices[0]?.message.tool_calls;
-        return {
-            response,
-            toolCall: toolCalls == null || toolCalls.length === 0
-                ? null
-                : {
-                    id: toolCalls[0].id,
-                    args: parseJSON({ text: toolCalls[0].function.arguments }),
-                },
-            usage: this.extractUsage(response),
-        };
-    }
-    async doGenerateToolCallsOrText(tools, prompt, options) {
-        const response = await this.callAPI(prompt, {
-            ...options,
-            responseFormat: OpenAIChatResponseFormat.json,
-            toolChoice: "auto",
-            tools: tools.map((tool) => ({
-                type: "function",
-                function: {
-                    name: tool.name,
-                    description: tool.description,
-                    parameters: tool.parameters.getJsonSchema(),
-                },
-            })),
-        });
-        const message = response.choices[0]?.message;
-        return {
-            response,
-            text: message.content ?? null,
-            toolCalls: message.tool_calls?.map((toolCall) => ({
-                id: toolCall.id,
-                name: toolCall.function.name,
-                args: parseJSON({ text: toolCall.function.arguments }),
-            })) ?? null,
-            usage: this.extractUsage(response),
-        };
-    }
-    extractUsage(response) {
-        return {
-            promptTokens: response.usage.prompt_tokens,
-            completionTokens: response.usage.completion_tokens,
-            totalTokens: response.usage.total_tokens,
-        };
-    }
     asFunctionCallStructureGenerationModel({ fnName, fnDescription, }) {
         return new OpenAIChatFunctionCallStructureGenerationModel({
             model: this,
@@ -366,102 +252,3 @@ export class OpenAIChatModel extends AbstractModel {
         return new OpenAIChatModel(Object.assign({}, this.settings, additionalSettings));
     }
 }
-const openAIChatResponseSchema = z.object({
-    id: z.string(),
-    choices: z.array(z.object({
-        message: z.object({
-            role: z.literal("assistant"),
-            content: z.string().nullable(),
-            function_call: z
-                .object({
-                name: z.string(),
-                arguments: z.string(),
-            })
-                .optional(),
-            tool_calls: z
-                .array(z.object({
-                id: z.string(),
-                type: z.literal("function"),
-                function: z.object({
-                    name: z.string(),
-                    arguments: z.string(),
-                }),
-            }))
-                .optional(),
-        }),
-        index: z.number(),
-        logprobs: z.nullable(z.any()),
-        finish_reason: z
-            .enum([
-            "stop",
-            "length",
-            "tool_calls",
-            "content_filter",
-            "function_call",
-        ])
-            .optional()
-            .nullable(),
-    })),
-    created: z.number(),
-    model: z.string(),
-    system_fingerprint: z.string().optional(),
-    object: z.literal("chat.completion"),
-    usage: z.object({
-        prompt_tokens: z.number(),
-        completion_tokens: z.number(),
-        total_tokens: z.number(),
-    }),
-});
-async function callOpenAIChatCompletionAPI({ api = new OpenAIApiConfiguration(), abortSignal, responseFormat, model, messages, functions, functionCall, tools, toolChoice, temperature, topP, n, stop, maxTokens, presencePenalty, frequencyPenalty, logitBias, user, openAIResponseFormat, seed, }) {
-    // empty arrays are not allowed for stop:
-    if (stop != null && Array.isArray(stop) && stop.length === 0) {
-        stop = undefined;
-    }
-    return postJsonToApi({
-        url: api.assembleUrl("/chat/completions"),
-        headers: api.headers,
-        body: {
-            stream: responseFormat.stream,
-            model,
-            messages,
-            functions,
-            function_call: functionCall,
-            tools,
-            tool_choice: toolChoice,
-            temperature,
-            top_p: topP,
-            n,
-            stop,
-            max_tokens: maxTokens,
-            presence_penalty: presencePenalty,
-            frequency_penalty: frequencyPenalty,
-            logit_bias: logitBias,
-            seed,
-            response_format: openAIResponseFormat,
-            user,
-        },
-        failedResponseHandler: failedOpenAICallResponseHandler,
-        successfulResponseHandler: responseFormat.handler,
-        abortSignal,
-    });
-}
-export const OpenAIChatResponseFormat = {
-    /**
-     * Returns the response as a JSON object.
-     */
-    json: {
-        stream: false,
-        handler: createJsonResponseHandler(openAIChatResponseSchema),
-    },
-    /**
-     * Returns an async iterable over the text deltas (only the tex different of the first choice).
-     */
-    textDeltaIterable: {
-        stream: true,
-        handler: async ({ response }) => createOpenAIChatDeltaIterableQueue(response.body, (delta) => delta[0]?.delta.content ?? ""),
-    },
-    structureDeltaIterable: {
-        stream: true,
-        handler: async ({ response }) => createOpenAIChatDeltaIterableQueue(response.body, (delta) => parsePartialJson(delta[0]?.function_call?.arguments)),
-    },
-};

package/model-provider/openai/index.cjs

@@ -39,6 +39,7 @@ __exportStar(require("./OpenAISpeechModel.cjs"), exports);
 __exportStar(require("./OpenAITextEmbeddingModel.cjs"), exports);
 __exportStar(require("./OpenAITranscriptionModel.cjs"), exports);
 __exportStar(require("./TikTokenTokenizer.cjs"), exports);
+__exportStar(require("./chat/AbstractOpenAIChatModel.cjs"), exports);
 __exportStar(require("./chat/OpenAIChatMessage.cjs"), exports);
 __exportStar(require("./chat/OpenAIChatModel.cjs"), exports);
 exports.OpenAIChatPromptFormat = __importStar(require("./chat/OpenAIChatPromptFormat.cjs"));

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

@@ -9,6 +9,7 @@ export * from "./OpenAISpeechModel.js";
 export * from "./OpenAITextEmbeddingModel.js";
 export * from "./OpenAITranscriptionModel.js";
 export * from "./TikTokenTokenizer.js";
+export * from "./chat/AbstractOpenAIChatModel.js";
 export * from "./chat/OpenAIChatMessage.js";
 export * from "./chat/OpenAIChatModel.js";
 export * as OpenAIChatPromptFormat from "./chat/OpenAIChatPromptFormat.js";

package/model-provider/openai/index.js

@@ -9,6 +9,7 @@ export * from "./OpenAISpeechModel.js";
 export * from "./OpenAITextEmbeddingModel.js";
 export * from "./OpenAITranscriptionModel.js";
 export * from "./TikTokenTokenizer.js";
+export * from "./chat/AbstractOpenAIChatModel.js";
 export * from "./chat/OpenAIChatMessage.js";
 export * from "./chat/OpenAIChatModel.js";
 export * as OpenAIChatPromptFormat from "./chat/OpenAIChatPromptFormat.js";

package/model-provider/openai-compatible/FireworksAIApiConfiguration.cjs

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FireworksAIApiConfiguration = void 0;
+const BaseUrlApiConfiguration_js_1 = require("../../core/api/BaseUrlApiConfiguration.cjs");
+const loadApiKey_js_1 = require("../../core/api/loadApiKey.cjs");
+/**
+ * Configuration for the Fireworks.ai API.
+ *
+ * It uses the `FIREWORKS_API_KEY` api key environment variable.
+ *
+ * @see https://readme.fireworks.ai/docs/openai-compatibility
+ */
+class FireworksAIApiConfiguration extends BaseUrlApiConfiguration_js_1.BaseUrlApiConfiguration {
+    constructor({ baseUrl = "https://api.fireworks.ai/inference/v1", apiKey, retry, throttle, } = {}) {
+        super({
+            baseUrl,
+            headers: {
+                Authorization: `Bearer ${(0, loadApiKey_js_1.loadApiKey)({
+                    apiKey,
+                    environmentVariableName: "FIREWORKS_API_KEY",
+                    description: "Fireworks AI",
+                })}`,
+            },
+            retry,
+            throttle,
+        });
+    }
+}
+exports.FireworksAIApiConfiguration = FireworksAIApiConfiguration;

package/model-provider/openai-compatible/FireworksAIApiConfiguration.d.ts

@@ -0,0 +1,18 @@
+import { BaseUrlApiConfiguration } from "../../core/api/BaseUrlApiConfiguration.js";
+import { RetryFunction } from "../../core/api/RetryFunction.js";
+import { ThrottleFunction } from "../../core/api/ThrottleFunction.js";
+/**
+ * Configuration for the Fireworks.ai API.
+ *
+ * It uses the `FIREWORKS_API_KEY` api key environment variable.
+ *
+ * @see https://readme.fireworks.ai/docs/openai-compatibility
+ */
+export declare class FireworksAIApiConfiguration extends BaseUrlApiConfiguration {
+    constructor({ baseUrl, apiKey, retry, throttle, }?: {
+        baseUrl?: string;
+        apiKey?: string;
+        retry?: RetryFunction;
+        throttle?: ThrottleFunction;
+    });
+}

package/model-provider/openai-compatible/FireworksAIApiConfiguration.js

@@ -0,0 +1,25 @@
+import { BaseUrlApiConfiguration } from "../../core/api/BaseUrlApiConfiguration.js";
+import { loadApiKey } from "../../core/api/loadApiKey.js";
+/**
+ * Configuration for the Fireworks.ai API.
+ *
+ * It uses the `FIREWORKS_API_KEY` api key environment variable.
+ *
+ * @see https://readme.fireworks.ai/docs/openai-compatibility
+ */
+export class FireworksAIApiConfiguration extends BaseUrlApiConfiguration {
+    constructor({ baseUrl = "https://api.fireworks.ai/inference/v1", apiKey, retry, throttle, } = {}) {
+        super({
+            baseUrl,
+            headers: {
+                Authorization: `Bearer ${loadApiKey({
+                    apiKey,
+                    environmentVariableName: "FIREWORKS_API_KEY",
+                    description: "Fireworks AI",
+                })}`,
+            },
+            retry,
+            throttle,
+        });
+    }
+}

package/model-provider/openai-compatible/OpenAICompatibleChatModel.cjs

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenAICompatibleChatModel = void 0;
+const StructureFromTextStreamingModel_js_1 = require("../../model-function/generate-structure/StructureFromTextStreamingModel.cjs");
+const PromptFormatTextStreamingModel_js_1 = require("../../model-function/generate-text/PromptFormatTextStreamingModel.cjs");
+const AbstractOpenAIChatModel_js_1 = require("../openai/chat/AbstractOpenAIChatModel.cjs");
+const OpenAIChatPromptFormat_js_1 = require("../openai/chat/OpenAIChatPromptFormat.cjs");
+/**
+ * Create a text generation model that calls an API that is compatible with OpenAI's chat API.
+ *
+ * Please note that many providers implement the API with slight differences, which can cause
+ * unexpected errors and different behavior in less common scenarios.
+ *
+ * @see https://platform.openai.com/docs/api-reference/chat/create
+ */
+class OpenAICompatibleChatModel extends AbstractOpenAIChatModel_js_1.AbstractOpenAIChatModel {
+    constructor(settings) {
+        super(settings);
+        Object.defineProperty(this, "contextWindowSize", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: undefined
+        });
+        Object.defineProperty(this, "tokenizer", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: undefined
+        });
+        Object.defineProperty(this, "countPromptTokens", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: undefined
+        });
+    }
+    get provider() {
+        return this.settings.provider ?? "openaicompatible";
+    }
+    get modelName() {
+        return this.settings.model;
+    }
+    get settingsForEvent() {
+        const eventSettingProperties = [
+            "stopSequences",
+            "maxCompletionTokens",
+            "functions",
+            "functionCall",
+            "temperature",
+            "topP",
+            "n",
+            "presencePenalty",
+            "frequencyPenalty",
+            "logitBias",
+            "seed",
+            "responseFormat",
+        ];
+        return Object.fromEntries(Object.entries(this.settings).filter(([key]) => eventSettingProperties.includes(key)));
+    }
+    asStructureGenerationModel(promptFormat) {
+        return new StructureFromTextStreamingModel_js_1.StructureFromTextStreamingModel({
+            model: this,
+            format: promptFormat,
+        });
+    }
+    /**
+     * Returns this model with a text prompt format.
+     */
+    withTextPrompt() {
+        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.text)());
+    }
+    /**
+     * Returns this model with an instruction prompt format.
+     */
+    withInstructionPrompt() {
+        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.instruction)());
+    }
+    /**
+     * Returns this model with a chat prompt format.
+     */
+    withChatPrompt() {
+        return this.withPromptFormat((0, OpenAIChatPromptFormat_js_1.chat)());
+    }
+    withPromptFormat(promptFormat) {
+        return new PromptFormatTextStreamingModel_js_1.PromptFormatTextStreamingModel({
+            model: this.withSettings({
+                stopSequences: [
+                    ...(this.settings.stopSequences ?? []),
+                    ...promptFormat.stopSequences,
+                ],
+            }),
+            promptFormat,
+        });
+    }
+    withSettings(additionalSettings) {
+        return new OpenAICompatibleChatModel(Object.assign({}, this.settings, additionalSettings));
+    }
+}
+exports.OpenAICompatibleChatModel = OpenAICompatibleChatModel;

package/model-provider/openai-compatible/OpenAICompatibleChatModel.d.ts

@@ -0,0 +1,45 @@
+import { StructureFromTextPromptFormat } from "../../model-function/generate-structure/StructureFromTextPromptFormat.js";
+import { StructureFromTextStreamingModel } from "../../model-function/generate-structure/StructureFromTextStreamingModel.js";
+import { PromptFormatTextStreamingModel } from "../../model-function/generate-text/PromptFormatTextStreamingModel.js";
+import { TextGenerationModelSettings, TextStreamingModel } from "../../model-function/generate-text/TextGenerationModel.js";
+import { TextGenerationPromptFormat } from "../../model-function/generate-text/TextGenerationPromptFormat.js";
+import { ToolCallGenerationModel } from "../../tool/generate-tool-call/ToolCallGenerationModel.js";
+import { ToolCallsOrTextGenerationModel } from "../../tool/generate-tool-calls-or-text/ToolCallsOrTextGenerationModel.js";
+import { AbstractOpenAIChatCallSettings, AbstractOpenAIChatModel, OpenAIChatPrompt } from "../openai/chat/AbstractOpenAIChatModel.js";
+export type OpenAICompatibleProviderName = `openaicompatible` | `openaicompatible-${string}`;
+export interface OpenAICompatibleChatSettings extends TextGenerationModelSettings, Omit<AbstractOpenAIChatCallSettings, "stop" | "maxTokens"> {
+    provider?: OpenAICompatibleProviderName;
+    isUserIdForwardingEnabled?: boolean;
+}
+/**
+ * Create a text generation model that calls an API that is compatible with OpenAI's chat API.
+ *
+ * Please note that many providers implement the API with slight differences, which can cause
+ * unexpected errors and different behavior in less common scenarios.
+ *
+ * @see https://platform.openai.com/docs/api-reference/chat/create
+ */
+export declare class OpenAICompatibleChatModel extends AbstractOpenAIChatModel<OpenAICompatibleChatSettings> implements TextStreamingModel<OpenAIChatPrompt, OpenAICompatibleChatSettings>, ToolCallGenerationModel<OpenAIChatPrompt, OpenAICompatibleChatSettings>, ToolCallsOrTextGenerationModel<OpenAIChatPrompt, OpenAICompatibleChatSettings> {
+    constructor(settings: OpenAICompatibleChatSettings);
+    get provider(): OpenAICompatibleProviderName;
+    get modelName(): string;
+    readonly contextWindowSize: undefined;
+    readonly tokenizer: undefined;
+    readonly countPromptTokens: undefined;
+    get settingsForEvent(): Partial<OpenAICompatibleChatSettings>;
+    asStructureGenerationModel<INPUT_PROMPT>(promptFormat: StructureFromTextPromptFormat<INPUT_PROMPT, OpenAIChatPrompt>): StructureFromTextStreamingModel<INPUT_PROMPT, OpenAIChatPrompt, this>;
+    /**
+     * Returns this model with a text prompt format.
+     */
+    withTextPrompt(): PromptFormatTextStreamingModel<string, OpenAIChatPrompt, OpenAICompatibleChatSettings, this>;
+    /**
+     * Returns this model with an instruction prompt format.
+     */
+    withInstructionPrompt(): PromptFormatTextStreamingModel<import("../../index.js").MultiModalInstructionPrompt | import("../../index.js").TextInstructionPrompt, OpenAIChatPrompt, OpenAICompatibleChatSettings, this>;
+    /**
+     * Returns this model with a chat prompt format.
+     */
+    withChatPrompt(): PromptFormatTextStreamingModel<import("../../index.js").ChatPrompt, OpenAIChatPrompt, OpenAICompatibleChatSettings, this>;
+    withPromptFormat<INPUT_PROMPT>(promptFormat: TextGenerationPromptFormat<INPUT_PROMPT, OpenAIChatPrompt>): PromptFormatTextStreamingModel<INPUT_PROMPT, OpenAIChatPrompt, OpenAICompatibleChatSettings, this>;
+    withSettings(additionalSettings: Partial<OpenAICompatibleChatSettings>): this;
+}

package/model-provider/openai-compatible/OpenAICompatibleChatModel.js

@@ -0,0 +1,96 @@
+import { StructureFromTextStreamingModel } from "../../model-function/generate-structure/StructureFromTextStreamingModel.js";
+import { PromptFormatTextStreamingModel } from "../../model-function/generate-text/PromptFormatTextStreamingModel.js";
+import { AbstractOpenAIChatModel, } from "../openai/chat/AbstractOpenAIChatModel.js";
+import { chat, instruction, text, } from "../openai/chat/OpenAIChatPromptFormat.js";
+/**
+ * Create a text generation model that calls an API that is compatible with OpenAI's chat API.
+ *
+ * Please note that many providers implement the API with slight differences, which can cause
+ * unexpected errors and different behavior in less common scenarios.
+ *
+ * @see https://platform.openai.com/docs/api-reference/chat/create
+ */
+export class OpenAICompatibleChatModel extends AbstractOpenAIChatModel {
+    constructor(settings) {
+        super(settings);
+        Object.defineProperty(this, "contextWindowSize", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: undefined
+        });
+        Object.defineProperty(this, "tokenizer", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: undefined
+        });
+        Object.defineProperty(this, "countPromptTokens", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: undefined
+        });
+    }
+    get provider() {
+        return this.settings.provider ?? "openaicompatible";
+    }
+    get modelName() {
+        return this.settings.model;
+    }
+    get settingsForEvent() {
+        const eventSettingProperties = [
+            "stopSequences",
+            "maxCompletionTokens",
+            "functions",
+            "functionCall",
+            "temperature",
+            "topP",
+            "n",
+            "presencePenalty",
+            "frequencyPenalty",
+            "logitBias",
+            "seed",
+            "responseFormat",
+        ];
+        return Object.fromEntries(Object.entries(this.settings).filter(([key]) => eventSettingProperties.includes(key)));
+    }
+    asStructureGenerationModel(promptFormat) {
+        return new StructureFromTextStreamingModel({
+            model: this,
+            format: promptFormat,
+        });
+    }
+    /**
+     * Returns this model with a text prompt format.
+     */
+    withTextPrompt() {
+        return this.withPromptFormat(text());
+    }
+    /**
+     * Returns this model with an instruction prompt format.
+     */
+    withInstructionPrompt() {
+        return this.withPromptFormat(instruction());
+    }
+    /**
+     * Returns this model with a chat prompt format.
+     */
+    withChatPrompt() {
+        return this.withPromptFormat(chat());
+    }
+    withPromptFormat(promptFormat) {
+        return new PromptFormatTextStreamingModel({
+            model: this.withSettings({
+                stopSequences: [
+                    ...(this.settings.stopSequences ?? []),
+                    ...promptFormat.stopSequences,
+                ],
+            }),
+            promptFormat,
+        });
+    }
+    withSettings(additionalSettings) {
+        return new OpenAICompatibleChatModel(Object.assign({}, this.settings, additionalSettings));
+    }
+}

package/model-provider/openai-compatible/OpenAICompatibleFacade.cjs

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatTextGenerator = void 0;
+const OpenAICompatibleChatModel_js_1 = require("./OpenAICompatibleChatModel.cjs");
+/**
+ * Create a text generation model that calls an API that is compatible with OpenAI's chat API.
+ *
+ * Please note that many providers implement the API with slight differences, which can cause
+ * unexpected errors and different behavior in less common scenarios.
+ *
+ * @see https://platform.openai.com/docs/api-reference/chat/create
+ *
+ * @example
+ * const model = openaicompatible.ChatTextGenerator({
+ *   model: "provider-specific-model-name",
+ *   temperature: 0.7,
+ *   maxCompletionTokens: 500,
+ * });
+ *
+ * const text = await generateText([
+ *   model,
+ *   OpenAIChatMessage.system(
+ *     "Write a short story about a robot learning to love:"
+ *   ),
+ * ]);
+ */
+function ChatTextGenerator(settings) {
+    return new OpenAICompatibleChatModel_js_1.OpenAICompatibleChatModel(settings);
+}
+exports.ChatTextGenerator = ChatTextGenerator;

package/model-provider/openai-compatible/OpenAICompatibleFacade.d.ts

@@ -0,0 +1,24 @@
+import { OpenAICompatibleChatModel, OpenAICompatibleChatSettings } from "./OpenAICompatibleChatModel.js";
+/**
+ * Create a text generation model that calls an API that is compatible with OpenAI's chat API.
+ *
+ * Please note that many providers implement the API with slight differences, which can cause
+ * unexpected errors and different behavior in less common scenarios.
+ *
+ * @see https://platform.openai.com/docs/api-reference/chat/create
+ *
+ * @example
+ * const model = openaicompatible.ChatTextGenerator({
+ *   model: "provider-specific-model-name",
+ *   temperature: 0.7,
+ *   maxCompletionTokens: 500,
+ * });
+ *
+ * const text = await generateText([
+ *   model,
+ *   OpenAIChatMessage.system(
+ *     "Write a short story about a robot learning to love:"
+ *   ),
+ * ]);
+ */
+export declare function ChatTextGenerator(settings: OpenAICompatibleChatSettings): OpenAICompatibleChatModel;