modelfusion 0.26.0 → 0.27.1

package/model-provider/openai/OpenAITextEmbeddingModel.js

@@ -3,6 +3,7 @@ import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { countTokens } from "../../model-function/tokenize-text/countTokens.js";
 import { callWithRetryAndThrottle } from "../../util/api/callWithRetryAndThrottle.js";
 import { createJsonResponseHandler, postJsonToApi, } from "../../util/api/postToApi.js";
+import { OpenAIApiConfiguration } from "./OpenAIApiConfiguration.js";
 import { failedOpenAICallResponseHandler } from "./OpenAIError.js";
 import { TikTokenTokenizer } from "./TikTokenTokenizer.js";
 export const OPENAI_TEXT_EMBEDDING_MODELS = {
@@ -78,36 +79,32 @@ export class OpenAITextEmbeddingModel extends AbstractModel {
     get modelName() {
         return this.settings.model;
     }
-    get apiKey() {
-        const apiKey = this.settings.apiKey ?? process.env.OPENAI_API_KEY;
-        if (apiKey == null) {
-            throw new Error(`OpenAI API key is missing. Pass it as an argument to the constructor or set it as an environment variable named OPENAI_API_KEY.`);
-        }
-        return apiKey;
-    }
     async countTokens(input) {
         return countTokens(this.tokenizer, input);
     }
     async callAPI(text, options) {
         const run = options?.run;
         const settings = options?.settings;
-        const callSettings = Object.assign({
-            apiKey: this.apiKey,
+        const combinedSettings = {
+            ...this.settings,
+            ...settings,
+        };
+        const callSettings = {
             user: this.settings.isUserIdForwardingEnabled ? run?.userId : undefined,
-        }, this.settings, settings, {
+            // Copied settings:
+            ...combinedSettings,
+            // other settings:
             abortSignal: run?.abortSignal,
             input: text,
-        });
+        };
         return callWithRetryAndThrottle({
-            retry: this.settings.retry,
-            throttle: this.settings.throttle,
+            retry: callSettings.api?.retry,
+            throttle: callSettings.api?.throttle,
             call: async () => callOpenAITextEmbeddingAPI(callSettings),
         });
     }
     get settingsForEvent() {
-        return {
-            baseUrl: this.settings.baseUrl,
-        };
+        return {};
     }
     generateEmbeddingResponse(texts, options) {
         if (texts.length > this.maxTextsPerCall) {
@@ -137,26 +134,10 @@ const openAITextEmbeddingResponseSchema = z.object({
         total_tokens: z.number(),
     }),
 });
-/**
- * Call the OpenAI Embedding API to generate an embedding for the given input.
- *
- * @see https://platform.openai.com/docs/api-reference/embeddings
- *
- * @example
- * const response = await callOpenAITextEmbeddingAPI({
- *   apiKey: OPENAI_API_KEY,
- *   model: "text-embedding-ada-002",
- *   input: "At first, Nox didn't know what to do with the pup.",
- * });
- *
- * console.log(response.data[0].embedding);
- */
-async function callOpenAITextEmbeddingAPI({ baseUrl = "https://api.openai.com/v1", abortSignal, apiKey, model, input, user, }) {
+async function callOpenAITextEmbeddingAPI({ api = new OpenAIApiConfiguration(), abortSignal, model, input, user, }) {
     return postJsonToApi({
-        url: `${baseUrl}/embeddings`,
-        headers: {
-            Authorization: `Bearer ${apiKey}`,
-        },
+        url: api.assembleUrl("/embeddings"),
+        headers: api.headers,
         body: {
             model,
             input,

package/model-provider/openai/OpenAITextGenerationModel.cjs

@@ -13,6 +13,7 @@ const countTokens_js_1 = require("../../model-function/tokenize-text/countTokens
 const PromptFormatTextGenerationModel_js_1 = require("../../prompt/PromptFormatTextGenerationModel.cjs");
 const callWithRetryAndThrottle_js_1 = require("../../util/api/callWithRetryAndThrottle.cjs");
 const postToApi_js_1 = require("../../util/api/postToApi.cjs");
+const OpenAIApiConfiguration_js_1 = require("./OpenAIApiConfiguration.cjs");
 const OpenAIError_js_1 = require("./OpenAIError.cjs");
 const TikTokenTokenizer_js_1 = require("./TikTokenTokenizer.cjs");
 /**
@@ -152,13 +153,6 @@ class OpenAITextGenerationModel extends AbstractModel_js_1.AbstractModel {
     get modelName() {
         return this.settings.model;
     }
-    get apiKey() {
-        const apiKey = this.settings.apiKey ?? process.env.OPENAI_API_KEY;
-        if (apiKey == null) {
-            throw new Error(`OpenAI API key is missing. Pass it as an argument to the constructor or set it as an environment variable named OPENAI_API_KEY.`);
-        }
-        return apiKey;
-    }
     async countPromptTokens(input) {
         return (0, countTokens_js_1.countTokens)(this.tokenizer, input);
     }
@@ -169,7 +163,6 @@ class OpenAITextGenerationModel extends AbstractModel_js_1.AbstractModel {
             ...settings,
         };
         const callSettings = {
-            apiKey: this.apiKey,
             user: this.settings.isUserIdForwardingEnabled ? run?.userId : undefined,
             // Copied settings:
             ...combinedSettings,
@@ -182,8 +175,8 @@ class OpenAITextGenerationModel extends AbstractModel_js_1.AbstractModel {
             responseFormat,
         };
         return (0, callWithRetryAndThrottle_js_1.callWithRetryAndThrottle)({
-            retry: callSettings.retry,
-            throttle: callSettings.throttle,
+            retry: callSettings.api?.retry,
+            throttle: callSettings.api?.throttle,
             call: async () => callOpenAITextGenerationAPI(callSettings),
         });
     }
@@ -191,7 +184,6 @@ class OpenAITextGenerationModel extends AbstractModel_js_1.AbstractModel {
         const eventSettingProperties = [
             "maxCompletionTokens",
             "stopSequences",
-            "baseUrl",
             "suffix",
             "temperature",
             "topP",
@@ -260,29 +252,10 @@ const openAITextGenerationResponseSchema = zod_1.default.object({
         total_tokens: zod_1.default.number(),
     }),
 });
-/**
- * Call the OpenAI Text Completion API to generate a text completion for the given prompt.
- *
- * @see https://platform.openai.com/docs/api-reference/completions/create
- *
- * @example
- * const response = await callOpenAITextGenerationAPI({
- *   apiKey: OPENAI_API_KEY,
- *   model: "text-davinci-003",
- *   prompt: "Write a short story about a robot learning to love:\n\n",
- *   temperature: 0.7,
- *   maxTokens: 500,
- * });
- *
- * console.log(response.choices[0].text);
- */
-async function callOpenAITextGenerationAPI({ baseUrl = "https://api.openai.com/v1", headers, abortSignal, responseFormat, apiKey, model, prompt, suffix, maxTokens, temperature, topP, n, logprobs, echo, stop, presencePenalty, frequencyPenalty, bestOf, logitBias, user, }) {
+async function callOpenAITextGenerationAPI({ api = new OpenAIApiConfiguration_js_1.OpenAIApiConfiguration(), abortSignal, responseFormat, model, prompt, suffix, maxTokens, temperature, topP, n, logprobs, echo, stop, presencePenalty, frequencyPenalty, bestOf, logitBias, user, }) {
     return (0, postToApi_js_1.postJsonToApi)({
-        url: `${baseUrl}/completions`,
-        headers: {
-            ...headers,
-            Authorization: `Bearer ${apiKey}`,
-        },
+        url: api.assembleUrl("/completions"),
+        headers: api.headers,
         body: {
             stream: responseFormat.stream,
             model,

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

@@ -1,13 +1,13 @@
 import z from "zod";
 import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { ModelFunctionOptions } from "../../model-function/ModelFunctionOptions.js";
+import { ApiConfiguration } from "../../model-function/ApiConfiguration.js";
 import { DeltaEvent } from "../../model-function/generate-text/DeltaEvent.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "../../model-function/generate-text/TextGenerationModel.js";
 import { PromptFormat } from "../../prompt/PromptFormat.js";
 import { PromptFormatTextGenerationModel } from "../../prompt/PromptFormatTextGenerationModel.js";
 import { ResponseHandler } from "../../util/api/postToApi.js";
 import { OpenAIImageGenerationCallSettings } from "./OpenAIImageGenerationModel.js";
-import { OpenAIModelSettings } from "./OpenAIModelSettings.js";
 import { TikTokenTokenizer } from "./TikTokenTokenizer.js";
 /**
  * @see https://platform.openai.com/docs/models/
@@ -81,8 +81,8 @@ export declare const calculateOpenAITextGenerationCostInMillicents: ({ model, re
     response: OpenAITextGenerationResponse;
 }) => number;
 export interface OpenAITextGenerationCallSettings {
+    api?: ApiConfiguration;
     model: OpenAITextGenerationModelType;
-    headers?: Record<string, string>;
     suffix?: string;
     maxTokens?: number;
     temperature?: number;
@@ -96,7 +96,7 @@ export interface OpenAITextGenerationCallSettings {
     bestOf?: number;
     logitBias?: Record<number, number>;
 }
-export interface OpenAITextGenerationModelSettings extends TextGenerationModelSettings, OpenAIModelSettings, Omit<OpenAITextGenerationCallSettings, "stop" | "maxTokens"> {
+export interface OpenAITextGenerationModelSettings extends TextGenerationModelSettings, Omit<OpenAITextGenerationCallSettings, "stop" | "maxTokens"> {
     isUserIdForwardingEnabled?: boolean;
 }
 /**
@@ -123,11 +123,10 @@ export declare class OpenAITextGenerationModel extends AbstractModel<OpenAITextG
     get modelName(): OpenAITextGenerationModelType;
     readonly contextWindowSize: number;
     readonly tokenizer: TikTokenTokenizer;
-    private get apiKey();
     countPromptTokens(input: string): Promise<number>;
     callAPI<RESULT>(prompt: string, options: {
         responseFormat: OpenAITextResponseFormatType<RESULT>;
-    } & ModelFunctionOptions<Partial<OpenAIImageGenerationCallSettings & OpenAIModelSettings & {
+    } & ModelFunctionOptions<Partial<OpenAIImageGenerationCallSettings & {
         user?: string;
     }>>): Promise<RESULT>;
     get settingsForEvent(): Partial<OpenAITextGenerationModelSettings>;

package/model-provider/openai/OpenAITextGenerationModel.js

@@ -7,6 +7,7 @@ import { countTokens } from "../../model-function/tokenize-text/countTokens.js";
 import { PromptFormatTextGenerationModel } from "../../prompt/PromptFormatTextGenerationModel.js";
 import { callWithRetryAndThrottle } from "../../util/api/callWithRetryAndThrottle.js";
 import { createJsonResponseHandler, postJsonToApi, } from "../../util/api/postToApi.js";
+import { OpenAIApiConfiguration } from "./OpenAIApiConfiguration.js";
 import { failedOpenAICallResponseHandler } from "./OpenAIError.js";
 import { TikTokenTokenizer } from "./TikTokenTokenizer.js";
 /**
@@ -143,13 +144,6 @@ export class OpenAITextGenerationModel extends AbstractModel {
     get modelName() {
         return this.settings.model;
     }
-    get apiKey() {
-        const apiKey = this.settings.apiKey ?? process.env.OPENAI_API_KEY;
-        if (apiKey == null) {
-            throw new Error(`OpenAI API key is missing. Pass it as an argument to the constructor or set it as an environment variable named OPENAI_API_KEY.`);
-        }
-        return apiKey;
-    }
     async countPromptTokens(input) {
         return countTokens(this.tokenizer, input);
     }
@@ -160,7 +154,6 @@ export class OpenAITextGenerationModel extends AbstractModel {
             ...settings,
         };
         const callSettings = {
-            apiKey: this.apiKey,
             user: this.settings.isUserIdForwardingEnabled ? run?.userId : undefined,
             // Copied settings:
             ...combinedSettings,
@@ -173,8 +166,8 @@ export class OpenAITextGenerationModel extends AbstractModel {
             responseFormat,
         };
         return callWithRetryAndThrottle({
-            retry: callSettings.retry,
-            throttle: callSettings.throttle,
+            retry: callSettings.api?.retry,
+            throttle: callSettings.api?.throttle,
             call: async () => callOpenAITextGenerationAPI(callSettings),
         });
     }
@@ -182,7 +175,6 @@ export class OpenAITextGenerationModel extends AbstractModel {
         const eventSettingProperties = [
             "maxCompletionTokens",
             "stopSequences",
-            "baseUrl",
             "suffix",
             "temperature",
             "topP",
@@ -250,29 +242,10 @@ const openAITextGenerationResponseSchema = z.object({
         total_tokens: z.number(),
     }),
 });
-/**
- * Call the OpenAI Text Completion API to generate a text completion for the given prompt.
- *
- * @see https://platform.openai.com/docs/api-reference/completions/create
- *
- * @example
- * const response = await callOpenAITextGenerationAPI({
- *   apiKey: OPENAI_API_KEY,
- *   model: "text-davinci-003",
- *   prompt: "Write a short story about a robot learning to love:\n\n",
- *   temperature: 0.7,
- *   maxTokens: 500,
- * });
- *
- * console.log(response.choices[0].text);
- */
-async function callOpenAITextGenerationAPI({ baseUrl = "https://api.openai.com/v1", headers, abortSignal, responseFormat, apiKey, model, prompt, suffix, maxTokens, temperature, topP, n, logprobs, echo, stop, presencePenalty, frequencyPenalty, bestOf, logitBias, user, }) {
+async function callOpenAITextGenerationAPI({ api = new OpenAIApiConfiguration(), abortSignal, responseFormat, model, prompt, suffix, maxTokens, temperature, topP, n, logprobs, echo, stop, presencePenalty, frequencyPenalty, bestOf, logitBias, user, }) {
     return postJsonToApi({
-        url: `${baseUrl}/completions`,
-        headers: {
-            ...headers,
-            Authorization: `Bearer ${apiKey}`,
-        },
+        url: api.assembleUrl("/completions"),
+        headers: api.headers,
         body: {
             stream: responseFormat.stream,
             model,

package/model-provider/openai/OpenAITranscriptionModel.cjs

@@ -8,6 +8,7 @@ const zod_1 = __importDefault(require("zod"));
 const AbstractModel_js_1 = require("../../model-function/AbstractModel.cjs");
 const callWithRetryAndThrottle_js_1 = require("../../util/api/callWithRetryAndThrottle.cjs");
 const postToApi_js_1 = require("../../util/api/postToApi.cjs");
+const OpenAIApiConfiguration_js_1 = require("./OpenAIApiConfiguration.cjs");
 const OpenAIError_js_1 = require("./OpenAIError.cjs");
 /**
  * @see https://openai.com/pricing
@@ -66,62 +67,40 @@ class OpenAITranscriptionModel extends AbstractModel_js_1.AbstractModel {
     extractTranscriptionText(response) {
         return response.text;
     }
-    get apiKey() {
-        const apiKey = this.settings.apiKey ?? process.env.OPENAI_API_KEY;
-        if (apiKey == null) {
-            throw new Error(`OpenAI API key is missing. Pass it as an argument to the constructor or set it as an environment variable named OPENAI_API_KEY.`);
-        }
-        return apiKey;
-    }
     async callAPI(data, options) {
         const run = options?.run;
         const settings = options?.settings;
         const responseFormat = options?.responseFormat;
-        const callSettings = Object.assign({
-            apiKey: this.apiKey,
-        }, this.settings, settings, {
+        const combinedSettings = {
+            ...this.settings,
+            ...settings,
+        };
+        const callSettings = {
+            // Copied settings:
+            ...combinedSettings,
+            // other settings:
             abortSignal: run?.abortSignal,
             file: {
                 name: `audio.${data.type}`,
                 data: data.data,
             },
             responseFormat,
-        });
+        };
         return (0, callWithRetryAndThrottle_js_1.callWithRetryAndThrottle)({
-            retry: this.settings.retry,
-            throttle: this.settings.throttle,
+            retry: callSettings.api?.retry,
+            throttle: callSettings.api?.throttle,
             call: async () => callOpenAITranscriptionAPI(callSettings),
         });
     }
-    getEventSettingProperties() {
-        return ["baseUrl"];
-    }
     get settingsForEvent() {
-        const eventSettingProperties = ["baseUrl"];
-        return Object.fromEntries(Object.entries(this.settings).filter(([key]) => eventSettingProperties.includes(key)));
+        return {};
     }
     withSettings(additionalSettings) {
         return new OpenAITranscriptionModel(Object.assign({}, this.settings, additionalSettings));
     }
 }
 exports.OpenAITranscriptionModel = OpenAITranscriptionModel;
-/**
- * Call the OpenAI Transcription API to generate a transcription from an audio file.
- *
- * @see https://platform.openai.com/docs/api-reference/audio/create
- *
- * @example
- * const transcriptionResponse = await callOpenAITranscriptionAPI({
- *   apiKey: openAiApiKey,
- *   model: "whisper-1",
- *   file: {
- *     name: "audio.mp3",
- *     data: fileData, // Buffer
- *   },
- *   responseFormat: callOpenAITranscriptionAPI.responseFormat.json,
- * });
- */
-async function callOpenAITranscriptionAPI({ baseUrl = "https://api.openai.com/v1", abortSignal, apiKey, model, file, prompt, responseFormat, temperature, language, }) {
+async function callOpenAITranscriptionAPI({ api = new OpenAIApiConfiguration_js_1.OpenAIApiConfiguration(), abortSignal, model, file, prompt, responseFormat, temperature, language, }) {
     const formData = new FormData();
     formData.append("file", new Blob([file.data]), file.name);
     formData.append("model", model);
@@ -138,10 +117,8 @@ async function callOpenAITranscriptionAPI({ baseUrl = "https://api.openai.com/v1
         formData.append("language", language);
     }
     return (0, postToApi_js_1.postToApi)({
-        url: `${baseUrl}/audio/transcriptions`,
-        headers: {
-            Authorization: `Bearer ${apiKey}`,
-        },
+        url: api.assembleUrl("/audio/transcriptions"),
+        headers: api.headers,
         body: {
             content: formData,
             values: {

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

@@ -2,11 +2,9 @@
 import z from "zod";
 import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { ModelFunctionOptions } from "../../model-function/ModelFunctionOptions.js";
+import { ApiConfiguration } from "../../model-function/ApiConfiguration.js";
 import { TranscriptionModel, TranscriptionModelSettings } from "../../model-function/transcribe-speech/TranscriptionModel.js";
-import { RetryFunction } from "../../util/api/RetryFunction.js";
-import { ThrottleFunction } from "../../util/api/ThrottleFunction.js";
 import { ResponseHandler } from "../../util/api/postToApi.js";
-import { OpenAIModelSettings } from "./OpenAIModelSettings.js";
 /**
  * @see https://openai.com/pricing
  */
@@ -21,11 +19,8 @@ export declare const calculateOpenAITranscriptionCostInMillicents: ({ model, res
     response: OpenAITranscriptionVerboseJsonResponse;
 }) => number | null;
 export interface OpenAITranscriptionModelSettings extends TranscriptionModelSettings {
+    api?: ApiConfiguration;
     model: OpenAITranscriptionModelType;
-    baseUrl?: string;
-    apiKey?: string;
-    retry?: RetryFunction;
-    throttle?: ThrottleFunction;
 }
 export type OpenAITranscriptionInput = {
     type: "mp3" | "mp4" | "mpeg" | "mpga" | "m3a" | "wav" | "webm";
@@ -51,13 +46,11 @@ export declare class OpenAITranscriptionModel extends AbstractModel<OpenAITransc
     constructor(settings: OpenAITranscriptionModelSettings);
     readonly provider: "openai";
     get modelName(): "whisper-1";
-    generateTranscriptionResponse(data: OpenAITranscriptionInput, options?: ModelFunctionOptions<Partial<OpenAITranscriptionModelSettings & OpenAIModelSettings>>): PromiseLike<OpenAITranscriptionVerboseJsonResponse>;
+    generateTranscriptionResponse(data: OpenAITranscriptionInput, options?: ModelFunctionOptions<Partial<OpenAITranscriptionModelSettings>>): PromiseLike<OpenAITranscriptionVerboseJsonResponse>;
     extractTranscriptionText(response: OpenAITranscriptionVerboseJsonResponse): string;
-    private get apiKey();
     callAPI<RESULT>(data: OpenAITranscriptionInput, options: {
         responseFormat: OpenAITranscriptionResponseFormatType<RESULT>;
-    } & ModelFunctionOptions<Partial<OpenAITranscriptionModelSettings & OpenAIModelSettings>>): Promise<RESULT>;
-    getEventSettingProperties(): (keyof OpenAITranscriptionModelSettings)[];
+    } & ModelFunctionOptions<Partial<OpenAITranscriptionModelSettings>>): Promise<RESULT>;
     get settingsForEvent(): Partial<OpenAITranscriptionModelSettings>;
     withSettings(additionalSettings: OpenAITranscriptionModelSettings): this;
 }

package/model-provider/openai/OpenAITranscriptionModel.js

@@ -2,6 +2,7 @@ import z from "zod";
 import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { callWithRetryAndThrottle } from "../../util/api/callWithRetryAndThrottle.js";
 import { createJsonResponseHandler, createTextResponseHandler, postToApi, } from "../../util/api/postToApi.js";
+import { OpenAIApiConfiguration } from "./OpenAIApiConfiguration.js";
 import { failedOpenAICallResponseHandler } from "./OpenAIError.js";
 /**
  * @see https://openai.com/pricing
@@ -59,61 +60,39 @@ export class OpenAITranscriptionModel extends AbstractModel {
     extractTranscriptionText(response) {
         return response.text;
     }
-    get apiKey() {
-        const apiKey = this.settings.apiKey ?? process.env.OPENAI_API_KEY;
-        if (apiKey == null) {
-            throw new Error(`OpenAI API key is missing. Pass it as an argument to the constructor or set it as an environment variable named OPENAI_API_KEY.`);
-        }
-        return apiKey;
-    }
     async callAPI(data, options) {
         const run = options?.run;
         const settings = options?.settings;
         const responseFormat = options?.responseFormat;
-        const callSettings = Object.assign({
-            apiKey: this.apiKey,
-        }, this.settings, settings, {
+        const combinedSettings = {
+            ...this.settings,
+            ...settings,
+        };
+        const callSettings = {
+            // Copied settings:
+            ...combinedSettings,
+            // other settings:
             abortSignal: run?.abortSignal,
             file: {
                 name: `audio.${data.type}`,
                 data: data.data,
             },
             responseFormat,
-        });
+        };
         return callWithRetryAndThrottle({
-            retry: this.settings.retry,
-            throttle: this.settings.throttle,
+            retry: callSettings.api?.retry,
+            throttle: callSettings.api?.throttle,
             call: async () => callOpenAITranscriptionAPI(callSettings),
         });
     }
-    getEventSettingProperties() {
-        return ["baseUrl"];
-    }
     get settingsForEvent() {
-        const eventSettingProperties = ["baseUrl"];
-        return Object.fromEntries(Object.entries(this.settings).filter(([key]) => eventSettingProperties.includes(key)));
+        return {};
     }
     withSettings(additionalSettings) {
         return new OpenAITranscriptionModel(Object.assign({}, this.settings, additionalSettings));
     }
 }
-/**
- * Call the OpenAI Transcription API to generate a transcription from an audio file.
- *
- * @see https://platform.openai.com/docs/api-reference/audio/create
- *
- * @example
- * const transcriptionResponse = await callOpenAITranscriptionAPI({
- *   apiKey: openAiApiKey,
- *   model: "whisper-1",
- *   file: {
- *     name: "audio.mp3",
- *     data: fileData, // Buffer
- *   },
- *   responseFormat: callOpenAITranscriptionAPI.responseFormat.json,
- * });
- */
-async function callOpenAITranscriptionAPI({ baseUrl = "https://api.openai.com/v1", abortSignal, apiKey, model, file, prompt, responseFormat, temperature, language, }) {
+async function callOpenAITranscriptionAPI({ api = new OpenAIApiConfiguration(), abortSignal, model, file, prompt, responseFormat, temperature, language, }) {
     const formData = new FormData();
     formData.append("file", new Blob([file.data]), file.name);
     formData.append("model", model);
@@ -130,10 +109,8 @@ async function callOpenAITranscriptionAPI({ baseUrl = "https://api.openai.com/v1
         formData.append("language", language);
     }
     return postToApi({
-        url: `${baseUrl}/audio/transcriptions`,
-        headers: {
-            Authorization: `Bearer ${apiKey}`,
-        },
+        url: api.assembleUrl("/audio/transcriptions"),
+        headers: api.headers,
         body: {
             content: formData,
             values: {

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

@@ -10,6 +10,7 @@ const AbstractModel_js_1 = require("../../../model-function/AbstractModel.cjs");
 const PromptFormatTextGenerationModel_js_1 = require("../../../prompt/PromptFormatTextGenerationModel.cjs");
 const callWithRetryAndThrottle_js_1 = require("../../../util/api/callWithRetryAndThrottle.cjs");
 const postToApi_js_1 = require("../../../util/api/postToApi.cjs");
+const OpenAIApiConfiguration_js_1 = require("../OpenAIApiConfiguration.cjs");
 const OpenAIError_js_1 = require("../OpenAIError.cjs");
 const TikTokenTokenizer_js_1 = require("../TikTokenTokenizer.cjs");
 const OpenAIChatStreamIterable_js_1 = require("./OpenAIChatStreamIterable.cjs");
@@ -170,13 +171,6 @@ class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
     get modelName() {
         return this.settings.model;
     }
-    get apiKey() {
-        const apiKey = this.settings.apiKey ?? process.env.OPENAI_API_KEY;
-        if (apiKey == null) {
-            throw new Error(`OpenAI API key is missing. Pass it as an argument to the constructor or set it as an environment variable named OPENAI_API_KEY.`);
-        }
-        return apiKey;
-    }
     /**
      * Counts the prompt tokens required for the messages. This includes the message base tokens
      * and the prompt base tokens.
@@ -194,18 +188,20 @@ class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
             ...settings,
         };
         const callSettings = {
-            apiKey: this.apiKey,
             user: this.settings.isUserIdForwardingEnabled ? run?.userId : undefined,
+            // Copied settings:
             ...combinedSettings,
+            // map to OpenAI API names:
             stop: combinedSettings.stopSequences,
             maxTokens: combinedSettings.maxCompletionTokens,
+            // other settings:
             abortSignal: run?.abortSignal,
             messages,
             responseFormat,
         };
         return (0, callWithRetryAndThrottle_js_1.callWithRetryAndThrottle)({
-            retry: callSettings.retry,
-            throttle: callSettings.throttle,
+            retry: callSettings.api?.retry,
+            throttle: callSettings.api?.throttle,
             call: async () => callOpenAIChatCompletionAPI(callSettings),
         });
     }
@@ -213,7 +209,6 @@ class OpenAIChatModel extends AbstractModel_js_1.AbstractModel {
         const eventSettingProperties = [
             "stopSequences",
             "maxCompletionTokens",
-            "baseUrl",
             "functions",
             "functionCall",
             "temperature",
@@ -310,13 +305,10 @@ const openAIChatResponseSchema = zod_1.default.object({
         total_tokens: zod_1.default.number(),
     }),
 });
-async function callOpenAIChatCompletionAPI({ baseUrl = "https://api.openai.com/v1", headers, abortSignal, responseFormat, apiKey, model, messages, functions, functionCall, temperature, topP, n, stop, maxTokens, presencePenalty, frequencyPenalty, logitBias, user, }) {
+async function callOpenAIChatCompletionAPI({ api = new OpenAIApiConfiguration_js_1.OpenAIApiConfiguration(), abortSignal, responseFormat, model, messages, functions, functionCall, temperature, topP, n, stop, maxTokens, presencePenalty, frequencyPenalty, logitBias, user, }) {
     return (0, postToApi_js_1.postJsonToApi)({
-        url: `${baseUrl}/chat/completions`,
-        headers: {
-            ...headers,
-            Authorization: `Bearer ${apiKey}`,
-        },
+        url: api.assembleUrl("/chat/completions"),
+        headers: api.headers,
         body: {
             stream: responseFormat.stream,
             model,

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

@@ -1,6 +1,7 @@
 import z from "zod";
 import { AbstractModel } from "../../../model-function/AbstractModel.js";
 import { ModelFunctionOptions } from "../../../model-function/ModelFunctionOptions.js";
+import { ApiConfiguration } from "../../../model-function/ApiConfiguration.js";
 import { JsonGenerationModel } from "../../../model-function/generate-json/JsonGenerationModel.js";
 import { JsonOrTextGenerationModel } from "../../../model-function/generate-json/JsonOrTextGenerationModel.js";
 import { DeltaEvent } from "../../../model-function/generate-text/DeltaEvent.js";
@@ -8,7 +9,6 @@ import { TextGenerationModel, TextGenerationModelSettings } from "../../../model
 import { PromptFormat } from "../../../prompt/PromptFormat.js";
 import { PromptFormatTextGenerationModel } from "../../../prompt/PromptFormatTextGenerationModel.js";
 import { ResponseHandler } from "../../../util/api/postToApi.js";
-import { OpenAIModelSettings } from "../OpenAIModelSettings.js";
 import { TikTokenTokenizer } from "../TikTokenTokenizer.js";
 import { OpenAIChatMessage } from "./OpenAIChatMessage.js";
 import { OpenAIChatAutoFunctionPrompt, OpenAIChatSingleFunctionPrompt, OpenAIFunctionDescription } from "./OpenAIChatPrompt.js";
@@ -91,8 +91,8 @@ export declare const calculateOpenAIChatCostInMillicents: ({ model, response, }:
     response: OpenAIChatResponse;
 }) => number;
 export interface OpenAIChatCallSettings {
+    api?: ApiConfiguration;
     model: OpenAIChatModelType;
-    headers?: Record<string, string>;
     functions?: Array<{
         name: string;
         description?: string;
@@ -110,7 +110,7 @@ export interface OpenAIChatCallSettings {
     frequencyPenalty?: number;
     logitBias?: Record<number, number>;
 }
-export interface OpenAIChatSettings extends TextGenerationModelSettings, OpenAIModelSettings, Omit<OpenAIChatCallSettings, "stop" | "maxTokens"> {
+export interface OpenAIChatSettings extends TextGenerationModelSettings, Omit<OpenAIChatCallSettings, "stop" | "maxTokens"> {
     isUserIdForwardingEnabled?: boolean;
 }
 /**
@@ -138,7 +138,6 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
     get modelName(): OpenAIChatModelType;
     readonly contextWindowSize: number;
     readonly tokenizer: TikTokenTokenizer;
-    private get apiKey();
     /**
      * Counts the prompt tokens required for the messages. This includes the message base tokens
      * and the prompt base tokens.
@@ -146,7 +145,7 @@ export declare class OpenAIChatModel extends AbstractModel<OpenAIChatSettings> i
     countPromptTokens(messages: OpenAIChatMessage[]): Promise<number>;
     callAPI<RESULT>(messages: Array<OpenAIChatMessage>, options: {
         responseFormat: OpenAIChatResponseFormatType<RESULT>;
-    } & ModelFunctionOptions<Partial<OpenAIChatCallSettings & OpenAIModelSettings & {
+    } & ModelFunctionOptions<Partial<OpenAIChatCallSettings & {
         user?: string;
     }>>): Promise<RESULT>;
     get settingsForEvent(): Partial<OpenAIChatSettings>;