@huggingface/inference 3.13.2 → 3.14.0

package/dist/commonjs/lib/makeRequestOptions.js

@@ -0,0 +1,161 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeRequestOptions = makeRequestOptions;
+exports.makeRequestOptionsFromResolvedModel = makeRequestOptionsFromResolvedModel;
+const config_js_1 = require("../config.js");
+const package_js_1 = require("../package.js");
+const getInferenceProviderMapping_js_1 = require("./getInferenceProviderMapping.js");
+const isUrl_js_1 = require("./isUrl.js");
+/**
+ * Lazy-loaded from huggingface.co/api/tasks when needed
+ * Used to determine the default model to use when it's not user defined
+ */
+let tasks = null;
+/**
+ * Helper that prepares request arguments.
+ * This async version handle the model ID resolution step.
+ */
+async function makeRequestOptions(args, providerHelper, options) {
+    const { model: maybeModel } = args;
+    const provider = providerHelper.provider;
+    const { task } = options ?? {};
+    // Validate inputs
+    if (args.endpointUrl && provider !== "hf-inference") {
+        throw new Error(`Cannot use endpointUrl with a third-party provider.`);
+    }
+    if (maybeModel && (0, isUrl_js_1.isUrl)(maybeModel)) {
+        throw new Error(`Model URLs are no longer supported. Use endpointUrl instead.`);
+    }
+    if (args.endpointUrl) {
+        // No need to have maybeModel, or to load default model for a task
+        return makeRequestOptionsFromResolvedModel(maybeModel ?? args.endpointUrl, providerHelper, args, undefined, options);
+    }
+    if (!maybeModel && !task) {
+        throw new Error("No model provided, and no task has been specified.");
+    }
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const hfModel = maybeModel ?? (await loadDefaultModel(task));
+    if (providerHelper.clientSideRoutingOnly && !maybeModel) {
+        throw new Error(`Provider ${provider} requires a model ID to be passed directly.`);
+    }
+    const inferenceProviderMapping = providerHelper.clientSideRoutingOnly
+        ? {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            providerId: removeProviderPrefix(maybeModel, provider),
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            hfModelId: maybeModel,
+            status: "live",
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            task: task,
+        }
+        : await (0, getInferenceProviderMapping_js_1.getInferenceProviderMapping)({
+            modelId: hfModel,
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            task: task,
+            provider,
+            accessToken: args.accessToken,
+        }, { fetch: options?.fetch });
+    if (!inferenceProviderMapping) {
+        throw new Error(`We have not been able to find inference provider information for model ${hfModel}.`);
+    }
+    // Use the sync version with the resolved model
+    return makeRequestOptionsFromResolvedModel(inferenceProviderMapping.providerId, providerHelper, args, inferenceProviderMapping, options);
+}
+/**
+ * Helper that prepares request arguments. - for internal use only
+ * This sync version skips the model ID resolution step
+ */
+function makeRequestOptionsFromResolvedModel(resolvedModel, providerHelper, args, mapping, options) {
+    const { accessToken, endpointUrl, provider: maybeProvider, model, ...remainingArgs } = args;
+    void model;
+    void maybeProvider;
+    const provider = providerHelper.provider;
+    const { includeCredentials, task, signal, billTo } = options ?? {};
+    const authMethod = (() => {
+        if (providerHelper.clientSideRoutingOnly) {
+            // Closed-source providers require an accessToken (cannot be routed).
+            if (accessToken && accessToken.startsWith("hf_")) {
+                throw new Error(`Provider ${provider} is closed-source and does not support HF tokens.`);
+            }
+            return "provider-key";
+        }
+        if (accessToken) {
+            return accessToken.startsWith("hf_") ? "hf-token" : "provider-key";
+        }
+        if (includeCredentials === "include") {
+            // If accessToken is passed, it should take precedence over includeCredentials
+            return "credentials-include";
+        }
+        return "none";
+    })();
+    // Make URL
+    const modelId = endpointUrl ?? resolvedModel;
+    const url = providerHelper.makeUrl({
+        authMethod,
+        model: modelId,
+        task,
+    });
+    // Make headers
+    const headers = providerHelper.prepareHeaders({
+        accessToken,
+        authMethod,
+    }, "data" in args && !!args.data);
+    if (billTo) {
+        headers[config_js_1.HF_HEADER_X_BILL_TO] = billTo;
+    }
+    // Add user-agent to headers
+    // e.g. @huggingface/inference/3.1.3
+    const ownUserAgent = `${package_js_1.PACKAGE_NAME}/${package_js_1.PACKAGE_VERSION}`;
+    const userAgent = [ownUserAgent, typeof navigator !== "undefined" ? navigator.userAgent : undefined]
+        .filter((x) => x !== undefined)
+        .join(" ");
+    headers["User-Agent"] = userAgent;
+    // Make body
+    const body = providerHelper.makeBody({
+        args: remainingArgs,
+        model: resolvedModel,
+        task,
+        mapping,
+    });
+    /**
+     * For edge runtimes, leave 'credentials' undefined, otherwise cloudflare workers will error
+     */
+    let credentials;
+    if (typeof includeCredentials === "string") {
+        credentials = includeCredentials;
+    }
+    else if (includeCredentials === true) {
+        credentials = "include";
+    }
+    const info = {
+        headers,
+        method: "POST",
+        body: body,
+        ...(credentials ? { credentials } : undefined),
+        signal,
+    };
+    return { url, info };
+}
+async function loadDefaultModel(task) {
+    if (!tasks) {
+        tasks = await loadTaskInfo();
+    }
+    const taskInfo = tasks[task];
+    if ((taskInfo?.models.length ?? 0) <= 0) {
+        throw new Error(`No default model defined for task ${task}, please define the model explicitly.`);
+    }
+    return taskInfo.models[0].id;
+}
+async function loadTaskInfo() {
+    const res = await fetch(`${config_js_1.HF_HUB_URL}/api/tasks`);
+    if (!res.ok) {
+        throw new Error("Failed to load tasks definitions from Hugging Face Hub.");
+    }
+    return await res.json();
+}
+function removeProviderPrefix(model, provider) {
+    if (!model.startsWith(`${provider}/`)) {
+        throw new Error(`Models from ${provider} must be prefixed by "${provider}/". Got "${model}".`);
+    }
+    return model.slice(provider.length + 1);
+}

package/dist/commonjs/package.d.ts

@@ -0,0 +1,3 @@
+export declare const PACKAGE_VERSION = "3.14.0";
+export declare const PACKAGE_NAME = "@huggingface/inference";
+//# sourceMappingURL=package.d.ts.map

package/dist/commonjs/package.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.d.ts","sourceRoot":"","sources":["../../src/package.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,eAAe,WAAW,CAAC;AACxC,eAAO,MAAM,YAAY,2BAA2B,CAAC"}

package/dist/commonjs/package.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PACKAGE_NAME = exports.PACKAGE_VERSION = void 0;
+// Generated file from package.json. Issues importing JSON directly when publishing on commonjs/ESM - see https://github.com/microsoft/TypeScript/issues/51783
+exports.PACKAGE_VERSION = "3.14.0";
+exports.PACKAGE_NAME = "@huggingface/inference";

package/dist/commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/{src → commonjs}/providers/black-forest-labs.d.ts

@@ -1,5 +1,5 @@
-import type { BodyParams, HeaderParams, UrlParams } from "../types";
-import { TaskProviderHelper, type TextToImageTaskHelper } from "./providerHelper";
+import type { BodyParams, HeaderParams, UrlParams } from "../types.js";
+import { TaskProviderHelper, type TextToImageTaskHelper } from "./providerHelper.js";
 interface BlackForestLabsResponse {
     id: string;
     polling_url: string;

package/dist/{src → commonjs}/providers/black-forest-labs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"black-forest-labs.d.ts","sourceRoot":"","sources":["../../../src/providers/black-forest-labs.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAGpE,OAAO,EAAE,kBAAkB,EAAE,KAAK,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAGlF,UAAU,uBAAuB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,qBAAa,8BAA+B,SAAQ,kBAAmB,YAAW,qBAAqB;;IAKtG,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAQlD,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAWtF,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM;IAO9B,WAAW,CAChB,QAAQ,EAAE,uBAAuB,EACjC,GAAG,CAAC,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,WAAW,EACrB,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,GACzB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CAgCzB"}
+{"version":3,"file":"black-forest-labs.d.ts","sourceRoot":"","sources":["../../../src/providers/black-forest-labs.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGvE,OAAO,EAAE,kBAAkB,EAAE,KAAK,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAGrF,UAAU,uBAAuB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,qBAAa,8BAA+B,SAAQ,kBAAmB,YAAW,qBAAqB;;IAKtG,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAQlD,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAWtF,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM;IAO9B,WAAW,CAChB,QAAQ,EAAE,uBAAuB,EACjC,GAAG,CAAC,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,WAAW,EACrB,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,GACzB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CAgCzB"}

package/dist/commonjs/providers/black-forest-labs.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlackForestLabsTextToImageTask = void 0;
+/**
+ * See the registered mapping of HF model ID => Black Forest Labs model ID here:
+ *
+ * https://huggingface.co/api/partners/blackforestlabs/models
+ *
+ * This is a publicly available mapping.
+ *
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co,
+ * you can add it to the dictionary "HARDCODED_MODEL_ID_MAPPING" in consts.ts, for dev purposes.
+ *
+ * - If you work at Black Forest Labs and want to update this mapping, please use the model mapping API we provide on huggingface.co
+ * - If you're a community member and want to add a new supported HF model to Black Forest Labs, please open an issue on the present repo
+ * and we will tag Black Forest Labs team members.
+ *
+ * Thanks!
+ */
+const InferenceOutputError_js_1 = require("../lib/InferenceOutputError.js");
+const delay_js_1 = require("../utils/delay.js");
+const omit_js_1 = require("../utils/omit.js");
+const providerHelper_js_1 = require("./providerHelper.js");
+const BLACK_FOREST_LABS_AI_API_BASE_URL = "https://api.us1.bfl.ai";
+class BlackForestLabsTextToImageTask extends providerHelper_js_1.TaskProviderHelper {
+    constructor() {
+        super("black-forest-labs", BLACK_FOREST_LABS_AI_API_BASE_URL);
+    }
+    preparePayload(params) {
+        return {
+            ...(0, omit_js_1.omit)(params.args, ["inputs", "parameters"]),
+            ...params.args.parameters,
+            prompt: params.args.inputs,
+        };
+    }
+    prepareHeaders(params, binary) {
+        const headers = {
+            Authorization: params.authMethod !== "provider-key" ? `Bearer ${params.accessToken}` : `X-Key ${params.accessToken}`,
+        };
+        if (!binary) {
+            headers["Content-Type"] = "application/json";
+        }
+        return headers;
+    }
+    makeRoute(params) {
+        if (!params) {
+            throw new Error("Params are required");
+        }
+        return `/v1/${params.model}`;
+    }
+    async getResponse(response, url, headers, outputType) {
+        const urlObj = new URL(response.polling_url);
+        for (let step = 0; step < 5; step++) {
+            await (0, delay_js_1.delay)(1000);
+            console.debug(`Polling Black Forest Labs API for the result... ${step + 1}/5`);
+            urlObj.searchParams.set("attempt", step.toString(10));
+            const resp = await fetch(urlObj, { headers: { "Content-Type": "application/json" } });
+            if (!resp.ok) {
+                throw new InferenceOutputError_js_1.InferenceOutputError("Failed to fetch result from black forest labs API");
+            }
+            const payload = await resp.json();
+            if (typeof payload === "object" &&
+                payload &&
+                "status" in payload &&
+                typeof payload.status === "string" &&
+                payload.status === "Ready" &&
+                "result" in payload &&
+                typeof payload.result === "object" &&
+                payload.result &&
+                "sample" in payload.result &&
+                typeof payload.result.sample === "string") {
+                if (outputType === "url") {
+                    return payload.result.sample;
+                }
+                const image = await fetch(payload.result.sample);
+                return await image.blob();
+            }
+        }
+        throw new InferenceOutputError_js_1.InferenceOutputError("Failed to fetch result from black forest labs API");
+    }
+}
+exports.BlackForestLabsTextToImageTask = BlackForestLabsTextToImageTask;

package/dist/{src → commonjs}/providers/cerebras.d.ts

@@ -14,7 +14,7 @@
  *
  * Thanks!
  */
-import { BaseConversationalTask } from "./providerHelper";
+import { BaseConversationalTask } from "./providerHelper.js";
 export declare class CerebrasConversationalTask extends BaseConversationalTask {
     constructor();
 }

package/dist/{src → commonjs}/providers/cerebras.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cerebras.d.ts","sourceRoot":"","sources":["../../../src/providers/cerebras.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAE1D,qBAAa,0BAA2B,SAAQ,sBAAsB;;CAIrE"}
+{"version":3,"file":"cerebras.d.ts","sourceRoot":"","sources":["../../../src/providers/cerebras.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,qBAAa,0BAA2B,SAAQ,sBAAsB;;CAIrE"}

package/dist/commonjs/providers/cerebras.js

@@ -0,0 +1,26 @@
+"use strict";
+/**
+ * See the registered mapping of HF model ID => Cerebras model ID here:
+ *
+ * https://huggingface.co/api/partners/cerebras/models
+ *
+ * This is a publicly available mapping.
+ *
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co,
+ * you can add it to the dictionary "HARDCODED_MODEL_ID_MAPPING" in consts.ts, for dev purposes.
+ *
+ * - If you work at Cerebras and want to update this mapping, please use the model mapping API we provide on huggingface.co
+ * - If you're a community member and want to add a new supported HF model to Cerebras, please open an issue on the present repo
+ * and we will tag Cerebras team members.
+ *
+ * Thanks!
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CerebrasConversationalTask = void 0;
+const providerHelper_js_1 = require("./providerHelper.js");
+class CerebrasConversationalTask extends providerHelper_js_1.BaseConversationalTask {
+    constructor() {
+        super("cerebras", "https://api.cerebras.ai");
+    }
+}
+exports.CerebrasConversationalTask = CerebrasConversationalTask;

package/dist/{src → commonjs}/providers/cohere.d.ts

@@ -14,7 +14,7 @@
  *
  * Thanks!
  */
-import { BaseConversationalTask } from "./providerHelper";
+import { BaseConversationalTask } from "./providerHelper.js";
 export declare class CohereConversationalTask extends BaseConversationalTask {
     constructor();
     makeRoute(): string;

package/dist/{src → commonjs}/providers/cohere.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cohere.d.ts","sourceRoot":"","sources":["../../../src/providers/cohere.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAE1D,qBAAa,wBAAyB,SAAQ,sBAAsB;;IAI1D,SAAS,IAAI,MAAM;CAG5B"}
+{"version":3,"file":"cohere.d.ts","sourceRoot":"","sources":["../../../src/providers/cohere.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,qBAAa,wBAAyB,SAAQ,sBAAsB;;IAI1D,SAAS,IAAI,MAAM;CAG5B"}

package/dist/commonjs/providers/cohere.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CohereConversationalTask = void 0;
+/**
+ * See the registered mapping of HF model ID => Cohere model ID here:
+ *
+ * https://huggingface.co/api/partners/cohere/models
+ *
+ * This is a publicly available mapping.
+ *
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co,
+ * you can add it to the dictionary "HARDCODED_MODEL_ID_MAPPING" in consts.ts, for dev purposes.
+ *
+ * - If you work at Cohere and want to update this mapping, please use the model mapping API we provide on huggingface.co
+ * - If you're a community member and want to add a new supported HF model to Cohere, please open an issue on the present repo
+ * and we will tag Cohere team members.
+ *
+ * Thanks!
+ */
+const providerHelper_js_1 = require("./providerHelper.js");
+class CohereConversationalTask extends providerHelper_js_1.BaseConversationalTask {
+    constructor() {
+        super("cohere", "https://api.cohere.com");
+    }
+    makeRoute() {
+        return "/compatibility/v1/chat/completions";
+    }
+}
+exports.CohereConversationalTask = CohereConversationalTask;

package/dist/{src → commonjs}/providers/consts.d.ts

@@ -1,6 +1,6 @@
-import type { InferenceProviderModelMapping } from "../lib/getInferenceProviderMapping";
-import type { InferenceProvider } from "../types";
-import { type ModelId } from "../types";
+import type { InferenceProviderModelMapping } from "../lib/getInferenceProviderMapping.js";
+import type { InferenceProvider } from "../types.js";
+import { type ModelId } from "../types.js";
 /**
  * If you want to try to run inference for a new model locally before it's registered on huggingface.co
  * for a given Inference Provider,

package/dist/commonjs/providers/consts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../../../src/providers/consts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,uCAAuC,CAAC;AAC3F,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,aAAa,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC,EAAE,MAAM,CACrD,iBAAiB,EACjB,MAAM,CAAC,OAAO,EAAE,6BAA6B,CAAC,CAyB9C,CAAC"}

package/dist/commonjs/providers/consts.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HARDCODED_MODEL_INFERENCE_MAPPING = void 0;
+/**
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co
+ * for a given Inference Provider,
+ * you can add it to the following dictionary, for dev purposes.
+ *
+ * We also inject into this dictionary from tests.
+ */
+exports.HARDCODED_MODEL_INFERENCE_MAPPING = {
+    /**
+     * "HF model ID" => "Model ID on Inference Provider's side"
+     *
+     * Example:
+     * "Qwen/Qwen2.5-Coder-32B-Instruct": "Qwen2.5-Coder-32B-Instruct",
+     */
+    "black-forest-labs": {},
+    cerebras: {},
+    cohere: {},
+    "fal-ai": {},
+    "featherless-ai": {},
+    "fireworks-ai": {},
+    groq: {},
+    "hf-inference": {},
+    hyperbolic: {},
+    nebius: {},
+    novita: {},
+    nscale: {},
+    openai: {},
+    ovhcloud: {},
+    replicate: {},
+    sambanova: {},
+    together: {},
+};

package/dist/{src → commonjs}/providers/fal-ai.d.ts

@@ -1,7 +1,7 @@
 import type { AutomaticSpeechRecognitionOutput } from "@huggingface/tasks";
-import type { BodyParams, HeaderParams, RequestArgs, UrlParams } from "../types";
-import { type AutomaticSpeechRecognitionTaskHelper, TaskProviderHelper, type TextToImageTaskHelper, type TextToVideoTaskHelper } from "./providerHelper";
-import type { AutomaticSpeechRecognitionArgs } from "../tasks/audio/automaticSpeechRecognition";
+import type { BodyParams, HeaderParams, RequestArgs, UrlParams } from "../types.js";
+import { type AutomaticSpeechRecognitionTaskHelper, TaskProviderHelper, type TextToImageTaskHelper, type TextToVideoTaskHelper } from "./providerHelper.js";
+import type { AutomaticSpeechRecognitionArgs } from "../tasks/audio/automaticSpeechRecognition.js";
 export interface FalAiQueueOutput {
     request_id: string;
     status: string;

package/dist/{src → commonjs}/providers/fal-ai.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fal-ai.d.ts","sourceRoot":"","sources":["../../../src/providers/fal-ai.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAC;AAG3E,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAW,WAAW,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAG1F,OAAO,EACN,KAAK,oCAAoC,EACzC,kBAAkB,EAClB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,MAAM,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,2CAA2C,CAAC;AAEhG,MAAM,WAAW,gBAAgB;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,sBAAsB;IAC/B,MAAM,EAAE,KAAK,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC,CAAC;CACH;AAYD,eAAO,MAAM,2BAA2B,UAA0D,CAAC;AAEnG,uBAAe,SAAU,SAAQ,kBAAkB;gBACtC,GAAG,CAAC,EAAE,MAAM;IAIxB,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAG3D,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM;IAG3B,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAUtF;AAMD,qBAAa,oBAAqB,SAAQ,SAAU,YAAW,qBAAqB;IAC1E,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAuBrD,WAAW,CAAC,QAAQ,EAAE,sBAAsB,EAAE,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CAkBjH;AAED,qBAAa,oBAAqB,SAAQ,SAAU,YAAW,qBAAqB;;IAI1E,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM;IAMpC,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAQrD,WAAW,CACzB,QAAQ,EAAE,gBAAgB,EAC1B,GAAG,CAAC,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC9B,OAAO,CAAC,IAAI,CAAC;CA8DhB;AAED,qBAAa,mCAAoC,SAAQ,SAAU,YAAW,oCAAoC;IACxG,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAKvE,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,gCAAgC,CAAC;IAUlF,mBAAmB,CAAC,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,WAAW,CAAC;CAqBrF;AAED,qBAAa,qBAAsB,SAAQ,SAAS;IAC1C,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAQrD,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAqB5D"}
+{"version":3,"file":"fal-ai.d.ts","sourceRoot":"","sources":["../../../src/providers/fal-ai.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAC;AAG3E,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAW,WAAW,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAG7F,OAAO,EACN,KAAK,oCAAoC,EACzC,kBAAkB,EAClB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,8CAA8C,CAAC;AAEnG,MAAM,WAAW,gBAAgB;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,sBAAsB;IAC/B,MAAM,EAAE,KAAK,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC,CAAC;CACH;AAYD,eAAO,MAAM,2BAA2B,UAA0D,CAAC;AAEnG,uBAAe,SAAU,SAAQ,kBAAkB;gBACtC,GAAG,CAAC,EAAE,MAAM;IAIxB,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAG3D,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM;IAG3B,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAUtF;AAMD,qBAAa,oBAAqB,SAAQ,SAAU,YAAW,qBAAqB;IAC1E,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAuBrD,WAAW,CAAC,QAAQ,EAAE,sBAAsB,EAAE,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CAkBjH;AAED,qBAAa,oBAAqB,SAAQ,SAAU,YAAW,qBAAqB;;IAI1E,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM;IAMpC,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAQrD,WAAW,CACzB,QAAQ,EAAE,gBAAgB,EAC1B,GAAG,CAAC,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC9B,OAAO,CAAC,IAAI,CAAC;CA8DhB;AAED,qBAAa,mCAAoC,SAAQ,SAAU,YAAW,oCAAoC;IACxG,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAKvE,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,gCAAgC,CAAC;IAUlF,mBAAmB,CAAC,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,WAAW,CAAC;CAqBrF;AAED,qBAAa,qBAAsB,SAAQ,SAAS;IAC1C,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAQrD,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAqB5D"}

package/dist/commonjs/providers/fal-ai.js

@@ -0,0 +1,216 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FalAITextToSpeechTask = exports.FalAIAutomaticSpeechRecognitionTask = exports.FalAITextToVideoTask = exports.FalAITextToImageTask = exports.FAL_AI_SUPPORTED_BLOB_TYPES = void 0;
+/**
+ * See the registered mapping of HF model ID => Fal model ID here:
+ *
+ * https://huggingface.co/api/partners/fal-ai/models
+ *
+ * This is a publicly available mapping.
+ *
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co,
+ * you can add it to the dictionary "HARDCODED_MODEL_ID_MAPPING" in consts.ts, for dev purposes.
+ *
+ * - If you work at Fal and want to update this mapping, please use the model mapping API we provide on huggingface.co
+ * - If you're a community member and want to add a new supported HF model to Fal, please open an issue on the present repo
+ * and we will tag Fal team members.
+ *
+ * Thanks!
+ */
+const base64FromBytes_js_1 = require("../utils/base64FromBytes.js");
+const InferenceOutputError_js_1 = require("../lib/InferenceOutputError.js");
+const isUrl_js_1 = require("../lib/isUrl.js");
+const delay_js_1 = require("../utils/delay.js");
+const omit_js_1 = require("../utils/omit.js");
+const providerHelper_js_1 = require("./providerHelper.js");
+const config_js_1 = require("../config.js");
+exports.FAL_AI_SUPPORTED_BLOB_TYPES = ["audio/mpeg", "audio/mp4", "audio/wav", "audio/x-wav"];
+class FalAITask extends providerHelper_js_1.TaskProviderHelper {
+    constructor(url) {
+        super("fal-ai", url || "https://fal.run");
+    }
+    preparePayload(params) {
+        return params.args;
+    }
+    makeRoute(params) {
+        return `/${params.model}`;
+    }
+    prepareHeaders(params, binary) {
+        const headers = {
+            Authorization: params.authMethod !== "provider-key" ? `Bearer ${params.accessToken}` : `Key ${params.accessToken}`,
+        };
+        if (!binary) {
+            headers["Content-Type"] = "application/json";
+        }
+        return headers;
+    }
+}
+function buildLoraPath(modelId, adapterWeightsPath) {
+    return `${config_js_1.HF_HUB_URL}/${modelId}/resolve/main/${adapterWeightsPath}`;
+}
+class FalAITextToImageTask extends FalAITask {
+    preparePayload(params) {
+        const payload = {
+            ...(0, omit_js_1.omit)(params.args, ["inputs", "parameters"]),
+            ...params.args.parameters,
+            sync_mode: true,
+            prompt: params.args.inputs,
+        };
+        if (params.mapping?.adapter === "lora" && params.mapping.adapterWeightsPath) {
+            payload.loras = [
+                {
+                    path: buildLoraPath(params.mapping.hfModelId, params.mapping.adapterWeightsPath),
+                    scale: 1,
+                },
+            ];
+            if (params.mapping.providerId === "fal-ai/lora") {
+                payload.model_name = "stabilityai/stable-diffusion-xl-base-1.0";
+            }
+        }
+        return payload;
+    }
+    async getResponse(response, outputType) {
+        if (typeof response === "object" &&
+            "images" in response &&
+            Array.isArray(response.images) &&
+            response.images.length > 0 &&
+            "url" in response.images[0] &&
+            typeof response.images[0].url === "string") {
+            if (outputType === "url") {
+                return response.images[0].url;
+            }
+            const urlResponse = await fetch(response.images[0].url);
+            return await urlResponse.blob();
+        }
+        throw new InferenceOutputError_js_1.InferenceOutputError("Expected Fal.ai text-to-image response format");
+    }
+}
+exports.FalAITextToImageTask = FalAITextToImageTask;
+class FalAITextToVideoTask extends FalAITask {
+    constructor() {
+        super("https://queue.fal.run");
+    }
+    makeRoute(params) {
+        if (params.authMethod !== "provider-key") {
+            return `/${params.model}?_subdomain=queue`;
+        }
+        return `/${params.model}`;
+    }
+    preparePayload(params) {
+        return {
+            ...(0, omit_js_1.omit)(params.args, ["inputs", "parameters"]),
+            ...params.args.parameters,
+            prompt: params.args.inputs,
+        };
+    }
+    async getResponse(response, url, headers) {
+        if (!url || !headers) {
+            throw new InferenceOutputError_js_1.InferenceOutputError("URL and headers are required for text-to-video task");
+        }
+        const requestId = response.request_id;
+        if (!requestId) {
+            throw new InferenceOutputError_js_1.InferenceOutputError("No request ID found in the response");
+        }
+        let status = response.status;
+        const parsedUrl = new URL(url);
+        const baseUrl = `${parsedUrl.protocol}//${parsedUrl.host}${parsedUrl.host === "router.huggingface.co" ? "/fal-ai" : ""}`;
+        // extracting the provider model id for status and result urls
+        // from the response as it might be different from the mapped model in `url`
+        const modelId = new URL(response.response_url).pathname;
+        const queryParams = parsedUrl.search;
+        const statusUrl = `${baseUrl}${modelId}/status${queryParams}`;
+        const resultUrl = `${baseUrl}${modelId}${queryParams}`;
+        while (status !== "COMPLETED") {
+            await (0, delay_js_1.delay)(500);
+            const statusResponse = await fetch(statusUrl, { headers });
+            if (!statusResponse.ok) {
+                throw new InferenceOutputError_js_1.InferenceOutputError("Failed to fetch response status from fal-ai API");
+            }
+            try {
+                status = (await statusResponse.json()).status;
+            }
+            catch (error) {
+                throw new InferenceOutputError_js_1.InferenceOutputError("Failed to parse status response from fal-ai API");
+            }
+        }
+        const resultResponse = await fetch(resultUrl, { headers });
+        let result;
+        try {
+            result = await resultResponse.json();
+        }
+        catch (error) {
+            throw new InferenceOutputError_js_1.InferenceOutputError("Failed to parse result response from fal-ai API");
+        }
+        if (typeof result === "object" &&
+            !!result &&
+            "video" in result &&
+            typeof result.video === "object" &&
+            !!result.video &&
+            "url" in result.video &&
+            typeof result.video.url === "string" &&
+            (0, isUrl_js_1.isUrl)(result.video.url)) {
+            const urlResponse = await fetch(result.video.url);
+            return await urlResponse.blob();
+        }
+        else {
+            throw new InferenceOutputError_js_1.InferenceOutputError("Expected { video: { url: string } } result format, got instead: " + JSON.stringify(result));
+        }
+    }
+}
+exports.FalAITextToVideoTask = FalAITextToVideoTask;
+class FalAIAutomaticSpeechRecognitionTask extends FalAITask {
+    prepareHeaders(params, binary) {
+        const headers = super.prepareHeaders(params, binary);
+        headers["Content-Type"] = "application/json";
+        return headers;
+    }
+    async getResponse(response) {
+        const res = response;
+        if (typeof res?.text !== "string") {
+            throw new InferenceOutputError_js_1.InferenceOutputError(`Expected { text: string } format from Fal.ai Automatic Speech Recognition, got: ${JSON.stringify(response)}`);
+        }
+        return { text: res.text };
+    }
+    async preparePayloadAsync(args) {
+        const blob = "data" in args && args.data instanceof Blob ? args.data : "inputs" in args ? args.inputs : undefined;
+        const contentType = blob?.type;
+        if (!contentType) {
+            throw new Error(`Unable to determine the input's content-type. Make sure your are passing a Blob when using provider fal-ai.`);
+        }
+        if (!exports.FAL_AI_SUPPORTED_BLOB_TYPES.includes(contentType)) {
+            throw new Error(`Provider fal-ai does not support blob type ${contentType} - supported content types are: ${exports.FAL_AI_SUPPORTED_BLOB_TYPES.join(", ")}`);
+        }
+        const base64audio = (0, base64FromBytes_js_1.base64FromBytes)(new Uint8Array(await blob.arrayBuffer()));
+        return {
+            ...("data" in args ? (0, omit_js_1.omit)(args, "data") : (0, omit_js_1.omit)(args, "inputs")),
+            audio_url: `data:${contentType};base64,${base64audio}`,
+        };
+    }
+}
+exports.FalAIAutomaticSpeechRecognitionTask = FalAIAutomaticSpeechRecognitionTask;
+class FalAITextToSpeechTask extends FalAITask {
+    preparePayload(params) {
+        return {
+            ...(0, omit_js_1.omit)(params.args, ["inputs", "parameters"]),
+            ...params.args.parameters,
+            text: params.args.inputs,
+        };
+    }
+    async getResponse(response) {
+        const res = response;
+        if (typeof res?.audio?.url !== "string") {
+            throw new InferenceOutputError_js_1.InferenceOutputError(`Expected { audio: { url: string } } format from Fal.ai Text-to-Speech, got: ${JSON.stringify(response)}`);
+        }
+        try {
+            const urlResponse = await fetch(res.audio.url);
+            if (!urlResponse.ok) {
+                throw new Error(`Failed to fetch audio from ${res.audio.url}: ${urlResponse.statusText}`);
+            }
+            return await urlResponse.blob();
+        }
+        catch (error) {
+            throw new InferenceOutputError_js_1.InferenceOutputError(`Error fetching or processing audio from Fal.ai Text-to-Speech URL: ${res.audio.url}. ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+}
+exports.FalAITextToSpeechTask = FalAITextToSpeechTask;