modelfusion 0.27.0 → 0.27.2

package/model-provider/elevenlabs/ElevenLabsSpeechSynthesisModel.js

@@ -1,7 +1,13 @@
 import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { callWithRetryAndThrottle } from "../../util/api/callWithRetryAndThrottle.js";
 import { createAudioMpegResponseHandler, postJsonToApi, } from "../../util/api/postToApi.js";
+import { ElevenLabsApiConfiguration } from "./ElevenLabsApiConfiguration.js";
 import { failedElevenLabsCallResponseHandler } from "./ElevenLabsError.js";
+/**
+ * Synthesize speech using the ElevenLabs Text to Speech API.
+ *
+ * @see https://api.elevenlabs.io/docs#/text-to-speech/Text_to_speech_v1_text_to_speech__voice_id__post
+ */
 export class ElevenLabsSpeechSynthesisModel extends AbstractModel {
     constructor(settings) {
         super({ settings });
@@ -11,19 +17,9 @@ export class ElevenLabsSpeechSynthesisModel extends AbstractModel {
             writable: true,
             value: "elevenlabs"
         });
-        Object.defineProperty(this, "modelName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: null
-        });
     }
-    get apiKey() {
-        const apiKey = this.settings.apiKey ?? process.env.ELEVENLABS_API_KEY;
-        if (apiKey == null) {
-            throw new Error("No ElevenLabs API key provided. Pass it in the constructor or set the ELEVENLABS_API_KEY environment variable.");
-        }
-        return apiKey;
+    get modelName() {
+        return this.settings.voice;
     }
     async callAPI(text, options) {
         const run = options?.run;
@@ -32,23 +28,22 @@ export class ElevenLabsSpeechSynthesisModel extends AbstractModel {
             ...this.settings,
             ...settings,
         };
+        const callSettings = {
+            api: combinedSettings.api,
+            abortSignal: run?.abortSignal,
+            text,
+            voiceId: combinedSettings.voice,
+            modelId: combinedSettings.model,
+            voiceSettings: combinedSettings.voiceSettings,
+        };
         return callWithRetryAndThrottle({
-            retry: this.settings.retry,
-            throttle: this.settings.throttle,
-            call: async () => callElevenLabsTextToSpeechAPI({
-                baseUrl: combinedSettings.baseUrl,
-                abortSignal: run?.abortSignal,
-                apiKey: this.apiKey,
-                text,
-                voiceId: combinedSettings.voice,
-                modelId: combinedSettings.model,
-                voiceSettings: combinedSettings.voiceSettings,
-            }),
+            retry: combinedSettings.api?.retry,
+            throttle: combinedSettings.api?.throttle,
+            call: async () => callElevenLabsTextToSpeechAPI(callSettings),
         });
     }
     get settingsForEvent() {
         return {
-            baseUrl: this.settings.baseUrl,
             model: this.settings.model,
             voice: this.settings.voice,
             voiceSettings: this.settings.voiceSettings,
@@ -64,15 +59,10 @@ export class ElevenLabsSpeechSynthesisModel extends AbstractModel {
         });
     }
 }
-/**
- * @see https://api.elevenlabs.io/docs#/text-to-speech/Text_to_speech_v1_text_to_speech__voice_id__post
- */
-async function callElevenLabsTextToSpeechAPI({ baseUrl = "https://api.elevenlabs.io/v1", abortSignal, apiKey, text, voiceId, modelId, voiceSettings, }) {
+async function callElevenLabsTextToSpeechAPI({ api = new ElevenLabsApiConfiguration(), abortSignal, text, voiceId, modelId, voiceSettings, }) {
     return postJsonToApi({
-        url: `${baseUrl}/text-to-speech/${voiceId}`,
-        headers: {
-            "xi-api-key": apiKey,
-        },
+        url: api.assembleUrl(`/text-to-speech/${voiceId}`),
+        headers: api.headers,
         body: {
             text,
             model_id: modelId,

package/model-provider/elevenlabs/index.cjs

@@ -14,4 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ElevenLabsApiConfiguration.cjs"), exports);
 __exportStar(require("./ElevenLabsSpeechSynthesisModel.cjs"), exports);

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

@@ -1 +1,2 @@
+export * from "./ElevenLabsApiConfiguration.js";
 export * from "./ElevenLabsSpeechSynthesisModel.js";

package/model-provider/elevenlabs/index.js

@@ -1 +1,2 @@
+export * from "./ElevenLabsApiConfiguration.js";
 export * from "./ElevenLabsSpeechSynthesisModel.js";

package/model-provider/huggingface/HuggingFaceApiConfiguration.cjs

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HuggingFaceApiConfiguration = void 0;
+const BasicApiConfiguration_js_1 = require("../../model-function/BasicApiConfiguration.cjs");
+const loadApiKey_js_1 = require("../../util/api/loadApiKey.cjs");
+class HuggingFaceApiConfiguration extends BasicApiConfiguration_js_1.BasicApiConfiguration {
+    constructor({ baseUrl = "https://api-inference.huggingface.co/models", apiKey, retry, throttle, } = {}) {
+        super({
+            baseUrl,
+            retry,
+            throttle,
+        });
+        Object.defineProperty(this, "apiKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.apiKey = (0, loadApiKey_js_1.loadApiKey)({
+            apiKey,
+            environmentVariableName: "HUGGINGFACE_API_KEY",
+            description: "Hugging Face",
+        });
+    }
+    get headers() {
+        return { Authorization: `Bearer ${this.apiKey}` };
+    }
+}
+exports.HuggingFaceApiConfiguration = HuggingFaceApiConfiguration;

package/model-provider/huggingface/HuggingFaceApiConfiguration.d.ts

@@ -0,0 +1,13 @@
+import { BasicApiConfiguration } from "../../model-function/BasicApiConfiguration.js";
+import { RetryFunction } from "../../util/api/RetryFunction.js";
+import { ThrottleFunction } from "../../util/api/ThrottleFunction.js";
+export declare class HuggingFaceApiConfiguration extends BasicApiConfiguration {
+    readonly apiKey: string;
+    constructor({ baseUrl, apiKey, retry, throttle, }?: {
+        baseUrl?: string;
+        apiKey?: string;
+        retry?: RetryFunction;
+        throttle?: ThrottleFunction;
+    });
+    get headers(): Record<string, string>;
+}

package/model-provider/huggingface/HuggingFaceApiConfiguration.js

@@ -0,0 +1,25 @@
+import { BasicApiConfiguration } from "../../model-function/BasicApiConfiguration.js";
+import { loadApiKey } from "../../util/api/loadApiKey.js";
+export class HuggingFaceApiConfiguration extends BasicApiConfiguration {
+    constructor({ baseUrl = "https://api-inference.huggingface.co/models", apiKey, retry, throttle, } = {}) {
+        super({
+            baseUrl,
+            retry,
+            throttle,
+        });
+        Object.defineProperty(this, "apiKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.apiKey = loadApiKey({
+            apiKey,
+            environmentVariableName: "HUGGINGFACE_API_KEY",
+            description: "Hugging Face",
+        });
+    }
+    get headers() {
+        return { Authorization: `Bearer ${this.apiKey}` };
+    }
+}

package/model-provider/huggingface/HuggingFaceError.cjs

@@ -8,10 +8,10 @@ const secure_json_parse_1 = __importDefault(require("secure-json-parse"));
 const zod_1 = require("zod");
 const ApiCallError_js_1 = require("../../util/api/ApiCallError.cjs");
 exports.huggingFaceErrorDataSchema = zod_1.z.object({
-    error: zod_1.z.string(),
+    error: zod_1.z.array(zod_1.z.string()),
 });
 class HuggingFaceError extends ApiCallError_js_1.ApiCallError {
-    constructor({ data, statusCode, url, requestBodyValues, message = data.error, }) {
+    constructor({ data, statusCode, url, requestBodyValues, message = data.error.join("\n\n"), }) {
         super({ message, statusCode, requestBodyValues, url });
         Object.defineProperty(this, "data", {
             enumerable: true,
@@ -27,6 +27,7 @@ const failedHuggingFaceCallResponseHandler = async ({ response, url, requestBody
     const responseBody = await response.text();
     try {
         const parsedError = exports.huggingFaceErrorDataSchema.parse(secure_json_parse_1.default.parse(responseBody));
+        console.error(requestBodyValues);
         return new HuggingFaceError({
             url,
             requestBodyValues,

package/model-provider/huggingface/HuggingFaceError.d.ts

@@ -2,11 +2,11 @@ import { z } from "zod";
 import { ApiCallError } from "../../util/api/ApiCallError.js";
 import { ResponseHandler } from "../../util/api/postToApi.js";
 export declare const huggingFaceErrorDataSchema: z.ZodObject<{
-    error: z.ZodString;
+    error: z.ZodArray<z.ZodString, "many">;
 }, "strip", z.ZodTypeAny, {
-    error: string;
+    error: string[];
 }, {
-    error: string;
+    error: string[];
 }>;
 export type HuggingFaceErrorData = z.infer<typeof huggingFaceErrorDataSchema>;
 export declare class HuggingFaceError extends ApiCallError {

package/model-provider/huggingface/HuggingFaceError.js

@@ -2,10 +2,10 @@ import SecureJSON from "secure-json-parse";
 import { z } from "zod";
 import { ApiCallError } from "../../util/api/ApiCallError.js";
 export const huggingFaceErrorDataSchema = z.object({
-    error: z.string(),
+    error: z.array(z.string()),
 });
 export class HuggingFaceError extends ApiCallError {
-    constructor({ data, statusCode, url, requestBodyValues, message = data.error, }) {
+    constructor({ data, statusCode, url, requestBodyValues, message = data.error.join("\n\n"), }) {
         super({ message, statusCode, requestBodyValues, url });
         Object.defineProperty(this, "data", {
             enumerable: true,
@@ -20,6 +20,7 @@ export const failedHuggingFaceCallResponseHandler = async ({ response, url, requ
     const responseBody = await response.text();
     try {
         const parsedError = huggingFaceErrorDataSchema.parse(SecureJSON.parse(responseBody));
+        console.error(requestBodyValues);
         return new HuggingFaceError({
             url,
             requestBodyValues,

package/model-provider/huggingface/HuggingFaceTextEmbeddingModel.cjs

@@ -9,8 +9,9 @@ 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 HuggingFaceError_js_1 = require("./HuggingFaceError.cjs");
+const HuggingFaceApiConfiguration_js_1 = require("./HuggingFaceApiConfiguration.cjs");
 /**
- * Create a text embeddinng model that calls a Hugging Face Inference API Feature Extraction Task.
+ * Create a text embedding model that calls a Hugging Face Inference API Feature Extraction Task.
  *
  * @see https://huggingface.co/docs/api-inference/detailed_parameters#feature-extraction-task
  *
@@ -75,38 +76,33 @@ class HuggingFaceTextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
     get modelName() {
         return this.settings.model;
     }
-    get apiKey() {
-        const apiKey = this.settings.apiKey ?? process.env.HUGGINGFACE_API_KEY;
-        if (apiKey == null) {
-            throw new Error("No Hugging Face API key provided. Pass it in the constructor or set the HUGGINGFACE_API_KEY environment variable.");
-        }
-        return apiKey;
-    }
     async callAPI(texts, options) {
         if (texts.length > this.maxTextsPerCall) {
             throw new Error(`The HuggingFace feature extraction API is configured to only support ${this.maxTextsPerCall} texts per API call.`);
         }
         const run = options?.run;
         const settings = options?.settings;
-        const callSettings = Object.assign({
-            apiKey: this.apiKey,
+        const combinedSettings = {
+            ...this.settings,
+            ...settings,
+        };
+        const callSettings = {
             options: {
                 useCache: true,
                 waitForModel: true,
             },
-        }, this.settings, settings, {
+            ...combinedSettings,
             abortSignal: run?.abortSignal,
             inputs: texts,
-        });
+        };
         return (0, callWithRetryAndThrottle_js_1.callWithRetryAndThrottle)({
-            retry: this.settings.retry,
-            throttle: this.settings.throttle,
+            retry: callSettings.api?.retry,
+            throttle: callSettings.api?.throttle,
             call: async () => callHuggingFaceTextGenerationAPI(callSettings),
         });
     }
     get settingsForEvent() {
         return {
-            baseUrl: this.settings.baseUrl,
             embeddingDimensions: this.settings.embeddingDimensions,
             options: this.settings.options,
         };
@@ -123,12 +119,10 @@ class HuggingFaceTextEmbeddingModel extends AbstractModel_js_1.AbstractModel {
 }
 exports.HuggingFaceTextEmbeddingModel = HuggingFaceTextEmbeddingModel;
 const huggingFaceTextEmbeddingResponseSchema = zod_1.default.array(zod_1.default.array(zod_1.default.number()));
-async function callHuggingFaceTextGenerationAPI({ baseUrl = "https://api-inference.huggingface.co/pipeline/feature-extraction", abortSignal, apiKey, model, inputs, options, }) {
+async function callHuggingFaceTextGenerationAPI({ api = new HuggingFaceApiConfiguration_js_1.HuggingFaceApiConfiguration(), abortSignal, model, inputs, options, }) {
     return (0, postToApi_js_1.postJsonToApi)({
-        url: `${baseUrl}/${model}`,
-        headers: {
-            Authorization: `Bearer ${apiKey}`,
-        },
+        url: api.assembleUrl(`/${model}`),
+        headers: api.headers,
         body: {
             inputs,
             options: options
@@ -136,7 +130,7 @@ async function callHuggingFaceTextGenerationAPI({ baseUrl = "https://api-inferen
                     use_cache: options?.useCache,
                     wait_for_model: options?.waitForModel,
                 }
-                : undefined,
+                : {},
         },
         failedResponseHandler: HuggingFaceError_js_1.failedHuggingFaceCallResponseHandler,
         successfulResponseHandler: (0, postToApi_js_1.createJsonResponseHandler)(huggingFaceTextEmbeddingResponseSchema),

package/model-provider/huggingface/HuggingFaceTextEmbeddingModel.d.ts

@@ -1,24 +1,20 @@
 import z from "zod";
 import { AbstractModel } from "../../model-function/AbstractModel.js";
+import { ApiConfiguration } from "../../model-function/ApiConfiguration.js";
 import { ModelFunctionOptions } from "../../model-function/ModelFunctionOptions.js";
 import { TextEmbeddingModel, TextEmbeddingModelSettings } from "../../model-function/embed-text/TextEmbeddingModel.js";
-import { RetryFunction } from "../../util/api/RetryFunction.js";
-import { ThrottleFunction } from "../../util/api/ThrottleFunction.js";
 export interface HuggingFaceTextEmbeddingModelSettings extends TextEmbeddingModelSettings {
+    api?: ApiConfiguration;
     model: string;
-    baseUrl?: string;
-    apiKey?: string;
     maxTextsPerCall?: number;
     embeddingDimensions?: number;
-    retry?: RetryFunction;
-    throttle?: ThrottleFunction;
     options?: {
         useCache?: boolean;
         waitForModel?: boolean;
     };
 }
 /**
- * Create a text embeddinng model that calls a Hugging Face Inference API Feature Extraction Task.
+ * Create a text embedding model that calls a Hugging Face Inference API Feature Extraction Task.
  *
  * @see https://huggingface.co/docs/api-inference/detailed_parameters#feature-extraction-task
  *
@@ -45,7 +41,6 @@ export declare class HuggingFaceTextEmbeddingModel extends AbstractModel<Hugging
     readonly contextWindowSize: undefined;
     readonly embeddingDimensions: number | undefined;
     readonly tokenizer: undefined;
-    private get apiKey();
     callAPI(texts: Array<string>, options?: ModelFunctionOptions<HuggingFaceTextEmbeddingModelSettings>): Promise<HuggingFaceTextEmbeddingResponse>;
     get settingsForEvent(): Partial<HuggingFaceTextEmbeddingModelSettings>;
     readonly countPromptTokens: undefined;

package/model-provider/huggingface/HuggingFaceTextEmbeddingModel.js

@@ -3,8 +3,9 @@ import { AbstractModel } from "../../model-function/AbstractModel.js";
 import { callWithRetryAndThrottle } from "../../util/api/callWithRetryAndThrottle.js";
 import { createJsonResponseHandler, postJsonToApi, } from "../../util/api/postToApi.js";
 import { failedHuggingFaceCallResponseHandler } from "./HuggingFaceError.js";
+import { HuggingFaceApiConfiguration } from "./HuggingFaceApiConfiguration.js";
 /**
- * Create a text embeddinng model that calls a Hugging Face Inference API Feature Extraction Task.
+ * Create a text embedding model that calls a Hugging Face Inference API Feature Extraction Task.
  *
  * @see https://huggingface.co/docs/api-inference/detailed_parameters#feature-extraction-task
  *
@@ -69,38 +70,33 @@ export class HuggingFaceTextEmbeddingModel extends AbstractModel {
     get modelName() {
         return this.settings.model;
     }
-    get apiKey() {
-        const apiKey = this.settings.apiKey ?? process.env.HUGGINGFACE_API_KEY;
-        if (apiKey == null) {
-            throw new Error("No Hugging Face API key provided. Pass it in the constructor or set the HUGGINGFACE_API_KEY environment variable.");
-        }
-        return apiKey;
-    }
     async callAPI(texts, options) {
         if (texts.length > this.maxTextsPerCall) {
             throw new Error(`The HuggingFace feature extraction API is configured to only support ${this.maxTextsPerCall} texts per API call.`);
         }
         const run = options?.run;
         const settings = options?.settings;
-        const callSettings = Object.assign({
-            apiKey: this.apiKey,
+        const combinedSettings = {
+            ...this.settings,
+            ...settings,
+        };
+        const callSettings = {
             options: {
                 useCache: true,
                 waitForModel: true,
             },
-        }, this.settings, settings, {
+            ...combinedSettings,
             abortSignal: run?.abortSignal,
             inputs: texts,
-        });
+        };
         return callWithRetryAndThrottle({
-            retry: this.settings.retry,
-            throttle: this.settings.throttle,
+            retry: callSettings.api?.retry,
+            throttle: callSettings.api?.throttle,
             call: async () => callHuggingFaceTextGenerationAPI(callSettings),
         });
     }
     get settingsForEvent() {
         return {
-            baseUrl: this.settings.baseUrl,
             embeddingDimensions: this.settings.embeddingDimensions,
             options: this.settings.options,
         };
@@ -116,12 +112,10 @@ export class HuggingFaceTextEmbeddingModel extends AbstractModel {
     }
 }
 const huggingFaceTextEmbeddingResponseSchema = z.array(z.array(z.number()));
-async function callHuggingFaceTextGenerationAPI({ baseUrl = "https://api-inference.huggingface.co/pipeline/feature-extraction", abortSignal, apiKey, model, inputs, options, }) {
+async function callHuggingFaceTextGenerationAPI({ api = new HuggingFaceApiConfiguration(), abortSignal, model, inputs, options, }) {
     return postJsonToApi({
-        url: `${baseUrl}/${model}`,
-        headers: {
-            Authorization: `Bearer ${apiKey}`,
-        },
+        url: api.assembleUrl(`/${model}`),
+        headers: api.headers,
         body: {
             inputs,
             options: options
@@ -129,7 +123,7 @@ async function callHuggingFaceTextGenerationAPI({ baseUrl = "https://api-inferen
                     use_cache: options?.useCache,
                     wait_for_model: options?.waitForModel,
                 }
-                : undefined,
+                : {},
         },
         failedResponseHandler: failedHuggingFaceCallResponseHandler,
         successfulResponseHandler: createJsonResponseHandler(huggingFaceTextEmbeddingResponseSchema),

package/model-provider/huggingface/HuggingFaceTextGenerationModel.cjs

@@ -6,10 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.HuggingFaceTextGenerationModel = void 0;
 const zod_1 = __importDefault(require("zod"));
 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 HuggingFaceApiConfiguration_js_1 = require("./HuggingFaceApiConfiguration.cjs");
 const HuggingFaceError_js_1 = require("./HuggingFaceError.cjs");
-const PromptFormatTextGenerationModel_js_1 = require("../../prompt/PromptFormatTextGenerationModel.cjs");
 /**
  * Create a text generation model that calls a Hugging Face Inference API Text Generation Task.
  *
@@ -71,13 +72,6 @@ class HuggingFaceTextGenerationModel extends AbstractModel_js_1.AbstractModel {
     get modelName() {
         return this.settings.model;
     }
-    get apiKey() {
-        const apiKey = this.settings.apiKey ?? process.env.HUGGINGFACE_API_KEY;
-        if (apiKey == null) {
-            throw new Error("No Hugging Face API key provided. Pass it in the constructor or set the HUGGINGFACE_API_KEY environment variable.");
-        }
-        return apiKey;
-    }
     async callAPI(prompt, options) {
         const run = options?.run;
         const settings = options?.settings;
@@ -86,7 +80,6 @@ class HuggingFaceTextGenerationModel extends AbstractModel_js_1.AbstractModel {
             ...settings,
         };
         const callSettings = {
-            apiKey: this.apiKey,
             options: {
                 useCache: true,
                 waitForModel: true,
@@ -97,8 +90,8 @@ class HuggingFaceTextGenerationModel extends AbstractModel_js_1.AbstractModel {
             inputs: prompt,
         };
         return (0, callWithRetryAndThrottle_js_1.callWithRetryAndThrottle)({
-            retry: this.settings.retry,
-            throttle: this.settings.throttle,
+            retry: callSettings.api?.retry,
+            throttle: callSettings.api?.throttle,
             call: async () => callHuggingFaceTextGenerationAPI(callSettings),
         });
     }
@@ -106,7 +99,6 @@ class HuggingFaceTextGenerationModel extends AbstractModel_js_1.AbstractModel {
         const eventSettingProperties = [
             "stopSequences",
             "maxCompletionTokens",
-            "baseUrl",
             "topK",
             "topP",
             "temperature",
@@ -138,31 +130,10 @@ exports.HuggingFaceTextGenerationModel = HuggingFaceTextGenerationModel;
 const huggingFaceTextGenerationResponseSchema = zod_1.default.array(zod_1.default.object({
     generated_text: zod_1.default.string(),
 }));
-/**
- * Call a Hugging Face Inference API Text Generation Task to generate a text completion for the given prompt.
- *
- * @see https://huggingface.co/docs/api-inference/detailed_parameters#text-generation-task
- *
- * @example
- * const response = await callHuggingFaceTextGenerationAPI({
- *   apiKey: HUGGINGFACE_API_KEY,
- *   model: "tiiuae/falcon-7b",
- *   inputs: "Write a short story about a robot learning to love:\n\n",
- *   temperature: 700,
- *   maxNewTokens: 500,
- *   options: {
- *     waitForModel: true,
- *   },
- * });
- *
- * console.log(response[0].generated_text);
- */
-async function callHuggingFaceTextGenerationAPI({ baseUrl = "https://api-inference.huggingface.co/models", abortSignal, apiKey, model, inputs, topK, topP, temperature, repetitionPenalty, maxNewTokens, maxTime, numReturnSequences, doSample, options, }) {
+async function callHuggingFaceTextGenerationAPI({ api = new HuggingFaceApiConfiguration_js_1.HuggingFaceApiConfiguration(), abortSignal, model, inputs, topK, topP, temperature, repetitionPenalty, maxNewTokens, maxTime, numReturnSequences, doSample, options, }) {
     return (0, postToApi_js_1.postJsonToApi)({
-        url: `${baseUrl}/${model}`,
-        headers: {
-            Authorization: `Bearer ${apiKey}`,
-        },
+        url: api.assembleUrl(`/${model}`),
+        headers: api.headers,
         body: {
             inputs,
             top_k: topK,

package/model-provider/huggingface/HuggingFaceTextGenerationModel.d.ts

@@ -1,17 +1,13 @@
 import z from "zod";
 import { AbstractModel } from "../../model-function/AbstractModel.js";
+import { ApiConfiguration } from "../../model-function/ApiConfiguration.js";
 import { ModelFunctionOptions } from "../../model-function/ModelFunctionOptions.js";
 import { TextGenerationModel, TextGenerationModelSettings } from "../../model-function/generate-text/TextGenerationModel.js";
-import { RetryFunction } from "../../util/api/RetryFunction.js";
-import { ThrottleFunction } from "../../util/api/ThrottleFunction.js";
 import { PromptFormat } from "../../prompt/PromptFormat.js";
 import { PromptFormatTextGenerationModel } from "../../prompt/PromptFormatTextGenerationModel.js";
 export interface HuggingFaceTextGenerationModelSettings extends TextGenerationModelSettings {
+    api?: ApiConfiguration;
     model: string;
-    baseUrl?: string;
-    apiKey?: string;
-    retry?: RetryFunction;
-    throttle?: ThrottleFunction;
     topK?: number;
     topP?: number;
     temperature?: number;
@@ -48,7 +44,6 @@ export declare class HuggingFaceTextGenerationModel extends AbstractModel<Huggin
     get modelName(): string;
     readonly contextWindowSize: undefined;
     readonly tokenizer: undefined;
-    private get apiKey();
     callAPI(prompt: string, options?: ModelFunctionOptions<HuggingFaceTextGenerationModelSettings>): Promise<HuggingFaceTextGenerationResponse>;
     get settingsForEvent(): Partial<HuggingFaceTextGenerationModelSettings>;
     readonly countPromptTokens: undefined;

package/model-provider/huggingface/HuggingFaceTextGenerationModel.js

@@ -1,9 +1,10 @@
 import z from "zod";
 import { AbstractModel } from "../../model-function/AbstractModel.js";
+import { PromptFormatTextGenerationModel } from "../../prompt/PromptFormatTextGenerationModel.js";
 import { callWithRetryAndThrottle } from "../../util/api/callWithRetryAndThrottle.js";
 import { createJsonResponseHandler, postJsonToApi, } from "../../util/api/postToApi.js";
+import { HuggingFaceApiConfiguration } from "./HuggingFaceApiConfiguration.js";
 import { failedHuggingFaceCallResponseHandler } from "./HuggingFaceError.js";
-import { PromptFormatTextGenerationModel } from "../../prompt/PromptFormatTextGenerationModel.js";
 /**
  * Create a text generation model that calls a Hugging Face Inference API Text Generation Task.
  *
@@ -65,13 +66,6 @@ export class HuggingFaceTextGenerationModel extends AbstractModel {
     get modelName() {
         return this.settings.model;
     }
-    get apiKey() {
-        const apiKey = this.settings.apiKey ?? process.env.HUGGINGFACE_API_KEY;
-        if (apiKey == null) {
-            throw new Error("No Hugging Face API key provided. Pass it in the constructor or set the HUGGINGFACE_API_KEY environment variable.");
-        }
-        return apiKey;
-    }
     async callAPI(prompt, options) {
         const run = options?.run;
         const settings = options?.settings;
@@ -80,7 +74,6 @@ export class HuggingFaceTextGenerationModel extends AbstractModel {
             ...settings,
         };
         const callSettings = {
-            apiKey: this.apiKey,
             options: {
                 useCache: true,
                 waitForModel: true,
@@ -91,8 +84,8 @@ export class HuggingFaceTextGenerationModel extends AbstractModel {
             inputs: prompt,
         };
         return callWithRetryAndThrottle({
-            retry: this.settings.retry,
-            throttle: this.settings.throttle,
+            retry: callSettings.api?.retry,
+            throttle: callSettings.api?.throttle,
             call: async () => callHuggingFaceTextGenerationAPI(callSettings),
         });
     }
@@ -100,7 +93,6 @@ export class HuggingFaceTextGenerationModel extends AbstractModel {
         const eventSettingProperties = [
             "stopSequences",
             "maxCompletionTokens",
-            "baseUrl",
             "topK",
             "topP",
             "temperature",
@@ -131,31 +123,10 @@ export class HuggingFaceTextGenerationModel extends AbstractModel {
 const huggingFaceTextGenerationResponseSchema = z.array(z.object({
     generated_text: z.string(),
 }));
-/**
- * Call a Hugging Face Inference API Text Generation Task to generate a text completion for the given prompt.
- *
- * @see https://huggingface.co/docs/api-inference/detailed_parameters#text-generation-task
- *
- * @example
- * const response = await callHuggingFaceTextGenerationAPI({
- *   apiKey: HUGGINGFACE_API_KEY,
- *   model: "tiiuae/falcon-7b",
- *   inputs: "Write a short story about a robot learning to love:\n\n",
- *   temperature: 700,
- *   maxNewTokens: 500,
- *   options: {
- *     waitForModel: true,
- *   },
- * });
- *
- * console.log(response[0].generated_text);
- */
-async function callHuggingFaceTextGenerationAPI({ baseUrl = "https://api-inference.huggingface.co/models", abortSignal, apiKey, model, inputs, topK, topP, temperature, repetitionPenalty, maxNewTokens, maxTime, numReturnSequences, doSample, options, }) {
+async function callHuggingFaceTextGenerationAPI({ api = new HuggingFaceApiConfiguration(), abortSignal, model, inputs, topK, topP, temperature, repetitionPenalty, maxNewTokens, maxTime, numReturnSequences, doSample, options, }) {
     return postJsonToApi({
-        url: `${baseUrl}/${model}`,
-        headers: {
-            Authorization: `Bearer ${apiKey}`,
-        },
+        url: api.assembleUrl(`/${model}`),
+        headers: api.headers,
         body: {
             inputs,
             top_k: topK,

package/model-provider/huggingface/index.cjs

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HuggingFaceError = void 0;
+__exportStar(require("./HuggingFaceApiConfiguration.cjs"), exports);
 var HuggingFaceError_js_1 = require("./HuggingFaceError.cjs");
 Object.defineProperty(exports, "HuggingFaceError", { enumerable: true, get: function () { return HuggingFaceError_js_1.HuggingFaceError; } });
 __exportStar(require("./HuggingFaceTextEmbeddingModel.cjs"), exports);

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

@@ -1,3 +1,4 @@
+export * from "./HuggingFaceApiConfiguration.js";
 export { HuggingFaceError, HuggingFaceErrorData } from "./HuggingFaceError.js";
 export * from "./HuggingFaceTextEmbeddingModel.js";
 export * from "./HuggingFaceTextGenerationModel.js";