@huggingface/inference 3.13.2 → 3.14.0

package/dist/commonjs/providers/replicate.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReplicateTextToVideoTask = exports.ReplicateTextToSpeechTask = exports.ReplicateTextToImageTask = void 0;
+/**
+ * See the registered mapping of HF model ID => Replicate model ID here:
+ *
+ * https://huggingface.co/api/partners/replicate/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 Replicate 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 Replicate, please open an issue on the present repo
+ * and we will tag Replicate team members.
+ *
+ * Thanks!
+ */
+const InferenceOutputError_js_1 = require("../lib/InferenceOutputError.js");
+const isUrl_js_1 = require("../lib/isUrl.js");
+const omit_js_1 = require("../utils/omit.js");
+const providerHelper_js_1 = require("./providerHelper.js");
+class ReplicateTask extends providerHelper_js_1.TaskProviderHelper {
+    constructor(url) {
+        super("replicate", url || "https://api.replicate.com");
+    }
+    makeRoute(params) {
+        if (params.model.includes(":")) {
+            return "v1/predictions";
+        }
+        return `v1/models/${params.model}/predictions`;
+    }
+    preparePayload(params) {
+        return {
+            input: {
+                ...(0, omit_js_1.omit)(params.args, ["inputs", "parameters"]),
+                ...params.args.parameters,
+                prompt: params.args.inputs,
+            },
+            version: params.model.includes(":") ? params.model.split(":")[1] : undefined,
+        };
+    }
+    prepareHeaders(params, binary) {
+        const headers = { Authorization: `Bearer ${params.accessToken}`, Prefer: "wait" };
+        if (!binary) {
+            headers["Content-Type"] = "application/json";
+        }
+        return headers;
+    }
+    makeUrl(params) {
+        const baseUrl = this.makeBaseUrl(params);
+        if (params.model.includes(":")) {
+            return `${baseUrl}/v1/predictions`;
+        }
+        return `${baseUrl}/v1/models/${params.model}/predictions`;
+    }
+}
+class ReplicateTextToImageTask extends ReplicateTask {
+    preparePayload(params) {
+        return {
+            input: {
+                ...(0, omit_js_1.omit)(params.args, ["inputs", "parameters"]),
+                ...params.args.parameters,
+                prompt: params.args.inputs,
+                lora_weights: params.mapping?.adapter === "lora" && params.mapping.adapterWeightsPath
+                    ? `https://huggingface.co/${params.mapping.hfModelId}`
+                    : undefined,
+            },
+            version: params.model.includes(":") ? params.model.split(":")[1] : undefined,
+        };
+    }
+    async getResponse(res, url, headers, outputType) {
+        void url;
+        void headers;
+        if (typeof res === "object" &&
+            "output" in res &&
+            Array.isArray(res.output) &&
+            res.output.length > 0 &&
+            typeof res.output[0] === "string") {
+            if (outputType === "url") {
+                return res.output[0];
+            }
+            const urlResponse = await fetch(res.output[0]);
+            return await urlResponse.blob();
+        }
+        throw new InferenceOutputError_js_1.InferenceOutputError("Expected Replicate text-to-image response format");
+    }
+}
+exports.ReplicateTextToImageTask = ReplicateTextToImageTask;
+class ReplicateTextToSpeechTask extends ReplicateTask {
+    preparePayload(params) {
+        const payload = super.preparePayload(params);
+        const input = payload["input"];
+        if (typeof input === "object" && input !== null && "prompt" in input) {
+            const inputObj = input;
+            inputObj["text"] = inputObj["prompt"];
+            delete inputObj["prompt"];
+        }
+        return payload;
+    }
+    async getResponse(response) {
+        if (response instanceof Blob) {
+            return response;
+        }
+        if (response && typeof response === "object") {
+            if ("output" in response) {
+                if (typeof response.output === "string") {
+                    const urlResponse = await fetch(response.output);
+                    return await urlResponse.blob();
+                }
+                else if (Array.isArray(response.output)) {
+                    const urlResponse = await fetch(response.output[0]);
+                    return await urlResponse.blob();
+                }
+            }
+        }
+        throw new InferenceOutputError_js_1.InferenceOutputError("Expected Blob or object with output");
+    }
+}
+exports.ReplicateTextToSpeechTask = ReplicateTextToSpeechTask;
+class ReplicateTextToVideoTask extends ReplicateTask {
+    async getResponse(response) {
+        if (typeof response === "object" &&
+            !!response &&
+            "output" in response &&
+            typeof response.output === "string" &&
+            (0, isUrl_js_1.isUrl)(response.output)) {
+            const urlResponse = await fetch(response.output);
+            return await urlResponse.blob();
+        }
+        throw new InferenceOutputError_js_1.InferenceOutputError("Expected { output: string }");
+    }
+}
+exports.ReplicateTextToVideoTask = ReplicateTextToVideoTask;

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

@@ -1,7 +1,7 @@
 import type { FeatureExtractionOutput } from "@huggingface/tasks";
-import type { BodyParams } from "../types";
-import type { FeatureExtractionTaskHelper } from "./providerHelper";
-import { BaseConversationalTask, TaskProviderHelper } from "./providerHelper";
+import type { BodyParams } from "../types.js";
+import type { FeatureExtractionTaskHelper } from "./providerHelper.js";
+import { BaseConversationalTask, TaskProviderHelper } from "./providerHelper.js";
 export declare class SambanovaConversationalTask extends BaseConversationalTask {
     constructor();
 }

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

@@ -1 +1 @@
-{"version":3,"file":"sambanova.d.ts","sourceRoot":"","sources":["../../../src/providers/sambanova.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE9E,qBAAa,2BAA4B,SAAQ,sBAAsB;;CAItE;AAED,qBAAa,8BAA+B,SAAQ,kBAAmB,YAAW,2BAA2B;;IAKnG,SAAS,IAAI,MAAM;IAIb,WAAW,CAAC,QAAQ,EAAE,uBAAuB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAStF,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAOpE"}
+{"version":3,"file":"sambanova.d.ts","sourceRoot":"","sources":["../../../src/providers/sambanova.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAEjF,qBAAa,2BAA4B,SAAQ,sBAAsB;;CAItE;AAED,qBAAa,8BAA+B,SAAQ,kBAAmB,YAAW,2BAA2B;;IAKnG,SAAS,IAAI,MAAM;IAIb,WAAW,CAAC,QAAQ,EAAE,uBAAuB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAStF,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAOpE"}

package/dist/commonjs/providers/sambanova.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SambanovaFeatureExtractionTask = exports.SambanovaConversationalTask = void 0;
+/**
+ * See the registered mapping of HF model ID => Sambanova model ID here:
+ *
+ * https://huggingface.co/api/partners/sambanova/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 Sambanova 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 Sambanova, please open an issue on the present repo
+ * and we will tag Sambanova team members.
+ *
+ * Thanks!
+ */
+const InferenceOutputError_js_1 = require("../lib/InferenceOutputError.js");
+const providerHelper_js_1 = require("./providerHelper.js");
+class SambanovaConversationalTask extends providerHelper_js_1.BaseConversationalTask {
+    constructor() {
+        super("sambanova", "https://api.sambanova.ai");
+    }
+}
+exports.SambanovaConversationalTask = SambanovaConversationalTask;
+class SambanovaFeatureExtractionTask extends providerHelper_js_1.TaskProviderHelper {
+    constructor() {
+        super("sambanova", "https://api.sambanova.ai");
+    }
+    makeRoute() {
+        return `/v1/embeddings`;
+    }
+    async getResponse(response) {
+        if (typeof response === "object" && "data" in response && Array.isArray(response.data)) {
+            return response.data.map((item) => item.embedding);
+        }
+        throw new InferenceOutputError_js_1.InferenceOutputError("Expected Sambanova feature-extraction (embeddings) response format to be {'data' : list of {'embedding' : number[]}}");
+    }
+    preparePayload(params) {
+        return {
+            model: params.model,
+            input: params.args.inputs,
+            ...params.args,
+        };
+    }
+}
+exports.SambanovaFeatureExtractionTask = SambanovaFeatureExtractionTask;

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

@@ -15,8 +15,8 @@
  * Thanks!
  */
 import type { ChatCompletionOutput, TextGenerationOutput, TextGenerationOutputFinishReason } from "@huggingface/tasks";
-import type { BodyParams } from "../types";
-import { BaseConversationalTask, BaseTextGenerationTask, TaskProviderHelper, type TextToImageTaskHelper } from "./providerHelper";
+import type { BodyParams } from "../types.js";
+import { BaseConversationalTask, BaseTextGenerationTask, TaskProviderHelper, type TextToImageTaskHelper } from "./providerHelper.js";
 interface TogetherTextCompletionOutput extends Omit<ChatCompletionOutput, "choices"> {
     choices: Array<{
         text: string;

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

@@ -1 +1 @@
-{"version":3,"file":"together.d.ts","sourceRoot":"","sources":["../../../src/providers/together.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAC;AAEvH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3C,OAAO,EACN,sBAAsB,EACtB,sBAAsB,EACtB,kBAAkB,EAClB,KAAK,qBAAqB,EAC1B,MAAM,kBAAkB,CAAC;AAI1B,UAAU,4BAA6B,SAAQ,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC;IACnF,OAAO,EAAE,KAAK,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,aAAa,EAAE,gCAAgC,CAAC;QAChD,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,OAAO,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;KACd,CAAC,CAAC;CACH;AAED,UAAU,6BAA6B;IACtC,IAAI,EAAE,KAAK,CAAC;QACX,QAAQ,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;CACH;AAED,qBAAa,0BAA2B,SAAQ,sBAAsB;;CAIrE;AAED,qBAAa,0BAA2B,SAAQ,sBAAsB;;IAK5D,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAQrD,WAAW,CAAC,QAAQ,EAAE,4BAA4B,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAcjG;AAED,qBAAa,uBAAwB,SAAQ,kBAAmB,YAAW,qBAAqB;;IAK/F,SAAS,IAAI,MAAM;IAInB,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAUrD,WAAW,CAAC,QAAQ,EAAE,6BAA6B,EAAE,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CAkB/G"}
+{"version":3,"file":"together.d.ts","sourceRoot":"","sources":["../../../src/providers/together.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAC;AAEvH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,OAAO,EACN,sBAAsB,EACtB,sBAAsB,EACtB,kBAAkB,EAClB,KAAK,qBAAqB,EAC1B,MAAM,qBAAqB,CAAC;AAI7B,UAAU,4BAA6B,SAAQ,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC;IACnF,OAAO,EAAE,KAAK,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,aAAa,EAAE,gCAAgC,CAAC;QAChD,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,OAAO,CAAC;QAClB,KAAK,EAAE,MAAM,CAAC;KACd,CAAC,CAAC;CACH;AAED,UAAU,6BAA6B;IACtC,IAAI,EAAE,KAAK,CAAC;QACX,QAAQ,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;CACH;AAED,qBAAa,0BAA2B,SAAQ,sBAAsB;;CAIrE;AAED,qBAAa,0BAA2B,SAAQ,sBAAsB;;IAK5D,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAQrD,WAAW,CAAC,QAAQ,EAAE,4BAA4B,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAcjG;AAED,qBAAa,uBAAwB,SAAQ,kBAAmB,YAAW,qBAAqB;;IAK/F,SAAS,IAAI,MAAM;IAInB,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAUrD,WAAW,CAAC,QAAQ,EAAE,6BAA6B,EAAE,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CAkB/G"}

package/dist/commonjs/providers/together.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TogetherTextToImageTask = exports.TogetherTextGenerationTask = exports.TogetherConversationalTask = void 0;
+const InferenceOutputError_js_1 = require("../lib/InferenceOutputError.js");
+const omit_js_1 = require("../utils/omit.js");
+const providerHelper_js_1 = require("./providerHelper.js");
+const TOGETHER_API_BASE_URL = "https://api.together.xyz";
+class TogetherConversationalTask extends providerHelper_js_1.BaseConversationalTask {
+    constructor() {
+        super("together", TOGETHER_API_BASE_URL);
+    }
+}
+exports.TogetherConversationalTask = TogetherConversationalTask;
+class TogetherTextGenerationTask extends providerHelper_js_1.BaseTextGenerationTask {
+    constructor() {
+        super("together", TOGETHER_API_BASE_URL);
+    }
+    preparePayload(params) {
+        return {
+            model: params.model,
+            ...params.args,
+            prompt: params.args.inputs,
+        };
+    }
+    async getResponse(response) {
+        if (typeof response === "object" &&
+            "choices" in response &&
+            Array.isArray(response?.choices) &&
+            typeof response?.model === "string") {
+            const completion = response.choices[0];
+            return {
+                generated_text: completion.text,
+            };
+        }
+        throw new InferenceOutputError_js_1.InferenceOutputError("Expected Together text generation response format");
+    }
+}
+exports.TogetherTextGenerationTask = TogetherTextGenerationTask;
+class TogetherTextToImageTask extends providerHelper_js_1.TaskProviderHelper {
+    constructor() {
+        super("together", TOGETHER_API_BASE_URL);
+    }
+    makeRoute() {
+        return "v1/images/generations";
+    }
+    preparePayload(params) {
+        return {
+            ...(0, omit_js_1.omit)(params.args, ["inputs", "parameters"]),
+            ...params.args.parameters,
+            prompt: params.args.inputs,
+            response_format: "base64",
+            model: params.model,
+        };
+    }
+    async getResponse(response, outputType) {
+        if (typeof response === "object" &&
+            "data" in response &&
+            Array.isArray(response.data) &&
+            response.data.length > 0 &&
+            "b64_json" in response.data[0] &&
+            typeof response.data[0].b64_json === "string") {
+            const base64Data = response.data[0].b64_json;
+            if (outputType === "url") {
+                return `data:image/jpeg;base64,${base64Data}`;
+            }
+            return fetch(`data:image/jpeg;base64,${base64Data}`).then((res) => res.blob());
+        }
+        throw new InferenceOutputError_js_1.InferenceOutputError("Expected Together text-to-image response format");
+    }
+}
+exports.TogetherTextToImageTask = TogetherTextToImageTask;

package/dist/{src → commonjs}/snippets/getInferenceSnippets.d.ts

@@ -1,6 +1,6 @@
 import { type InferenceSnippet, type ModelDataMinimal } from "@huggingface/tasks";
-import type { InferenceProviderModelMapping } from "../lib/getInferenceProviderMapping";
-import type { InferenceProviderOrPolicy } from "../types";
+import type { InferenceProviderModelMapping } from "../lib/getInferenceProviderMapping.js";
+import type { InferenceProviderOrPolicy } from "../types.js";
 export type InferenceSnippetOptions = {
     streaming?: boolean;
     billTo?: string;

package/dist/{src → commonjs}/snippets/getInferenceSnippets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getInferenceSnippets.d.ts","sourceRoot":"","sources":["../../../src/snippets/getInferenceSnippets.ts"],"names":[],"mappings":"AACA,OAAO,EACN,KAAK,gBAAgB,EAErB,KAAK,gBAAgB,EAGrB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AAGxF,OAAO,KAAK,EAAE,yBAAyB,EAA8B,MAAM,UAAU,CAAC;AAGtF,MAAM,MAAM,uBAAuB,GAAG;IAAE,SAAS,CAAC,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAmUzG,wBAAgB,oBAAoB,CACnC,KAAK,EAAE,gBAAgB,EACvB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,yBAAyB,EACnC,wBAAwB,CAAC,EAAE,6BAA6B,EACxD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,gBAAgB,EAAE,CAIpB"}
+{"version":3,"file":"getInferenceSnippets.d.ts","sourceRoot":"","sources":["../../../src/snippets/getInferenceSnippets.ts"],"names":[],"mappings":"AACA,OAAO,EACN,KAAK,gBAAgB,EAErB,KAAK,gBAAgB,EAGrB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,uCAAuC,CAAC;AAG3F,OAAO,KAAK,EAAE,yBAAyB,EAA8B,MAAM,aAAa,CAAC;AAGzF,MAAM,MAAM,uBAAuB,GAAG;IAAE,SAAS,CAAC,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAmUzG,wBAAgB,oBAAoB,CACnC,KAAK,EAAE,gBAAgB,EACvB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,yBAAyB,EACnC,wBAAwB,CAAC,EAAE,6BAA6B,EACxD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,gBAAgB,EAAE,CAIpB"}

package/dist/commonjs/snippets/getInferenceSnippets.js

@@ -0,0 +1,312 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInferenceSnippets = getInferenceSnippets;
+const jinja_1 = require("@huggingface/jinja");
+const tasks_1 = require("@huggingface/tasks");
+const getProviderHelper_js_1 = require("../lib/getProviderHelper.js");
+const makeRequestOptions_js_1 = require("../lib/makeRequestOptions.js");
+const templates_exported_js_1 = require("./templates.exported.js");
+const PYTHON_CLIENTS = ["huggingface_hub", "fal_client", "requests", "openai"];
+const JS_CLIENTS = ["fetch", "huggingface.js", "openai"];
+const SH_CLIENTS = ["curl"];
+const CLIENTS = {
+    js: [...JS_CLIENTS],
+    python: [...PYTHON_CLIENTS],
+    sh: [...SH_CLIENTS],
+};
+const CLIENTS_AUTO_POLICY = {
+    js: ["huggingface.js"],
+    python: ["huggingface_hub"],
+};
+// Helpers to find + load templates
+const hasTemplate = (language, client, templateName) => templates_exported_js_1.templates[language]?.[client]?.[templateName] !== undefined;
+const loadTemplate = (language, client, templateName) => {
+    const template = templates_exported_js_1.templates[language]?.[client]?.[templateName];
+    if (!template) {
+        throw new Error(`Template not found: ${language}/${client}/${templateName}`);
+    }
+    return (data) => new jinja_1.Template(template).render({ ...data });
+};
+const snippetImportPythonInferenceClient = loadTemplate("python", "huggingface_hub", "importInferenceClient");
+const snippetImportRequests = loadTemplate("python", "requests", "importRequests");
+// Needed for huggingface_hub basic snippets
+const HF_PYTHON_METHODS = {
+    "audio-classification": "audio_classification",
+    "audio-to-audio": "audio_to_audio",
+    "automatic-speech-recognition": "automatic_speech_recognition",
+    "document-question-answering": "document_question_answering",
+    "feature-extraction": "feature_extraction",
+    "fill-mask": "fill_mask",
+    "image-classification": "image_classification",
+    "image-segmentation": "image_segmentation",
+    "image-to-image": "image_to_image",
+    "image-to-text": "image_to_text",
+    "object-detection": "object_detection",
+    "question-answering": "question_answering",
+    "sentence-similarity": "sentence_similarity",
+    summarization: "summarization",
+    "table-question-answering": "table_question_answering",
+    "tabular-classification": "tabular_classification",
+    "tabular-regression": "tabular_regression",
+    "text-classification": "text_classification",
+    "text-generation": "text_generation",
+    "text-to-image": "text_to_image",
+    "text-to-speech": "text_to_speech",
+    "text-to-video": "text_to_video",
+    "token-classification": "token_classification",
+    translation: "translation",
+    "visual-question-answering": "visual_question_answering",
+    "zero-shot-classification": "zero_shot_classification",
+    "zero-shot-image-classification": "zero_shot_image_classification",
+};
+// Needed for huggingface.js basic snippets
+const HF_JS_METHODS = {
+    "automatic-speech-recognition": "automaticSpeechRecognition",
+    "feature-extraction": "featureExtraction",
+    "fill-mask": "fillMask",
+    "image-classification": "imageClassification",
+    "question-answering": "questionAnswering",
+    "sentence-similarity": "sentenceSimilarity",
+    summarization: "summarization",
+    "table-question-answering": "tableQuestionAnswering",
+    "text-classification": "textClassification",
+    "text-generation": "textGeneration",
+    "text2text-generation": "textGeneration",
+    "token-classification": "tokenClassification",
+    "text-to-speech": "textToSpeech",
+    translation: "translation",
+};
+// Snippet generators
+const snippetGenerator = (templateName, inputPreparationFn) => {
+    return (model, accessToken, provider, inferenceProviderMapping, opts) => {
+        const providerModelId = inferenceProviderMapping?.providerId ?? model.id;
+        /// Hacky: hard-code conversational templates here
+        let task = model.pipeline_tag;
+        if (model.pipeline_tag &&
+            ["text-generation", "image-text-to-text"].includes(model.pipeline_tag) &&
+            model.tags.includes("conversational")) {
+            templateName = opts?.streaming ? "conversationalStream" : "conversational";
+            inputPreparationFn = prepareConversationalInput;
+            task = "conversational";
+        }
+        let providerHelper;
+        try {
+            providerHelper = (0, getProviderHelper_js_1.getProviderHelper)(provider, task);
+        }
+        catch (e) {
+            console.error(`Failed to get provider helper for ${provider} (${task})`, e);
+            return [];
+        }
+        /// Prepare inputs + make request
+        const inputs = inputPreparationFn ? inputPreparationFn(model, opts) : { inputs: (0, tasks_1.getModelInputSnippet)(model) };
+        const request = (0, makeRequestOptions_js_1.makeRequestOptionsFromResolvedModel)(providerModelId, providerHelper, {
+            accessToken,
+            provider,
+            ...inputs,
+        }, inferenceProviderMapping, {
+            task,
+            billTo: opts?.billTo,
+        });
+        /// Parse request.info.body if not a binary.
+        /// This is the body sent to the provider. Important for snippets with raw payload (e.g curl, requests, etc.)
+        let providerInputs = inputs;
+        const bodyAsObj = request.info.body;
+        if (typeof bodyAsObj === "string") {
+            try {
+                providerInputs = JSON.parse(bodyAsObj);
+            }
+            catch (e) {
+                console.error("Failed to parse body as JSON", e);
+            }
+        }
+        /// Prepare template injection data
+        const params = {
+            accessToken,
+            authorizationHeader: request.info.headers?.Authorization,
+            baseUrl: removeSuffix(request.url, "/chat/completions"),
+            fullUrl: request.url,
+            inputs: {
+                asObj: inputs,
+                asCurlString: formatBody(inputs, "curl"),
+                asJsonString: formatBody(inputs, "json"),
+                asPythonString: formatBody(inputs, "python"),
+                asTsString: formatBody(inputs, "ts"),
+            },
+            providerInputs: {
+                asObj: providerInputs,
+                asCurlString: formatBody(providerInputs, "curl"),
+                asJsonString: formatBody(providerInputs, "json"),
+                asPythonString: formatBody(providerInputs, "python"),
+                asTsString: formatBody(providerInputs, "ts"),
+            },
+            model,
+            provider,
+            providerModelId: providerModelId ?? model.id,
+            billTo: opts?.billTo,
+        };
+        /// Iterate over clients => check if a snippet exists => generate
+        const clients = provider === "auto" ? CLIENTS_AUTO_POLICY : CLIENTS;
+        return tasks_1.inferenceSnippetLanguages
+            .map((language) => {
+            const langClients = clients[language] ?? [];
+            return langClients
+                .map((client) => {
+                if (!hasTemplate(language, client, templateName)) {
+                    return;
+                }
+                const template = loadTemplate(language, client, templateName);
+                if (client === "huggingface_hub" && templateName.includes("basic")) {
+                    if (!(model.pipeline_tag && model.pipeline_tag in HF_PYTHON_METHODS)) {
+                        return;
+                    }
+                    params["methodName"] = HF_PYTHON_METHODS[model.pipeline_tag];
+                }
+                if (client === "huggingface.js" && templateName.includes("basic")) {
+                    if (!(model.pipeline_tag && model.pipeline_tag in HF_JS_METHODS)) {
+                        return;
+                    }
+                    params["methodName"] = HF_JS_METHODS[model.pipeline_tag];
+                }
+                /// Generate snippet
+                let snippet = template(params).trim();
+                if (!snippet) {
+                    return;
+                }
+                /// Add import section separately
+                if (client === "huggingface_hub") {
+                    const importSection = snippetImportPythonInferenceClient({ ...params });
+                    snippet = `${importSection}\n\n${snippet}`;
+                }
+                else if (client === "requests") {
+                    const importSection = snippetImportRequests({
+                        ...params,
+                        importBase64: snippet.includes("base64"),
+                        importJson: snippet.includes("json."),
+                    });
+                    snippet = `${importSection}\n\n${snippet}`;
+                }
+                /// Snippet is ready!
+                return { language, client: client, content: snippet };
+            })
+                .filter((snippet) => snippet !== undefined);
+        })
+            .flat();
+    };
+};
+const prepareDocumentQuestionAnsweringInput = (model) => {
+    return JSON.parse((0, tasks_1.getModelInputSnippet)(model));
+};
+const prepareImageToImageInput = (model) => {
+    const data = JSON.parse((0, tasks_1.getModelInputSnippet)(model));
+    return { inputs: data.image, parameters: { prompt: data.prompt } };
+};
+const prepareConversationalInput = (model, opts) => {
+    return {
+        messages: opts?.messages ?? (0, tasks_1.getModelInputSnippet)(model),
+        ...(opts?.temperature ? { temperature: opts?.temperature } : undefined),
+        ...(opts?.max_tokens ? { max_tokens: opts?.max_tokens } : undefined),
+        ...(opts?.top_p ? { top_p: opts?.top_p } : undefined),
+    };
+};
+const prepareQuestionAnsweringInput = (model) => {
+    const data = JSON.parse((0, tasks_1.getModelInputSnippet)(model));
+    return { question: data.question, context: data.context };
+};
+const prepareTableQuestionAnsweringInput = (model) => {
+    const data = JSON.parse((0, tasks_1.getModelInputSnippet)(model));
+    return { query: data.query, table: JSON.stringify(data.table) };
+};
+const snippets = {
+    "audio-classification": snippetGenerator("basicAudio"),
+    "audio-to-audio": snippetGenerator("basicAudio"),
+    "automatic-speech-recognition": snippetGenerator("basicAudio"),
+    "document-question-answering": snippetGenerator("documentQuestionAnswering", prepareDocumentQuestionAnsweringInput),
+    "feature-extraction": snippetGenerator("basic"),
+    "fill-mask": snippetGenerator("basic"),
+    "image-classification": snippetGenerator("basicImage"),
+    "image-segmentation": snippetGenerator("basicImage"),
+    "image-text-to-text": snippetGenerator("conversational"),
+    "image-to-image": snippetGenerator("imageToImage", prepareImageToImageInput),
+    "image-to-text": snippetGenerator("basicImage"),
+    "object-detection": snippetGenerator("basicImage"),
+    "question-answering": snippetGenerator("questionAnswering", prepareQuestionAnsweringInput),
+    "sentence-similarity": snippetGenerator("basic"),
+    summarization: snippetGenerator("basic"),
+    "tabular-classification": snippetGenerator("tabular"),
+    "tabular-regression": snippetGenerator("tabular"),
+    "table-question-answering": snippetGenerator("tableQuestionAnswering", prepareTableQuestionAnsweringInput),
+    "text-classification": snippetGenerator("basic"),
+    "text-generation": snippetGenerator("basic"),
+    "text-to-audio": snippetGenerator("textToAudio"),
+    "text-to-image": snippetGenerator("textToImage"),
+    "text-to-speech": snippetGenerator("textToSpeech"),
+    "text-to-video": snippetGenerator("textToVideo"),
+    "text2text-generation": snippetGenerator("basic"),
+    "token-classification": snippetGenerator("basic"),
+    translation: snippetGenerator("basic"),
+    "zero-shot-classification": snippetGenerator("zeroShotClassification"),
+    "zero-shot-image-classification": snippetGenerator("zeroShotImageClassification"),
+};
+function getInferenceSnippets(model, accessToken, provider, inferenceProviderMapping, opts) {
+    return model.pipeline_tag && model.pipeline_tag in snippets
+        ? snippets[model.pipeline_tag]?.(model, accessToken, provider, inferenceProviderMapping, opts) ?? []
+        : [];
+}
+// String manipulation helpers
+function formatBody(obj, format) {
+    switch (format) {
+        case "curl":
+            return indentString(formatBody(obj, "json"));
+        case "json":
+            /// Hacky: remove outer brackets to make is extendable in templates
+            return JSON.stringify(obj, null, 4).split("\n").slice(1, -1).join("\n");
+        case "python":
+            return indentString(Object.entries(obj)
+                .map(([key, value]) => {
+                const formattedValue = JSON.stringify(value, null, 4).replace(/"/g, '"');
+                return `${key}=${formattedValue},`;
+            })
+                .join("\n"));
+        case "ts":
+            /// Hacky: remove outer brackets to make is extendable in templates
+            return formatTsObject(obj).split("\n").slice(1, -1).join("\n");
+        default:
+            throw new Error(`Unsupported format: ${format}`);
+    }
+}
+function formatTsObject(obj, depth) {
+    depth = depth ?? 0;
+    /// Case int, boolean, string, etc.
+    if (typeof obj !== "object" || obj === null) {
+        return JSON.stringify(obj);
+    }
+    /// Case array
+    if (Array.isArray(obj)) {
+        const items = obj
+            .map((item) => {
+            const formatted = formatTsObject(item, depth + 1);
+            return `${" ".repeat(4 * (depth + 1))}${formatted},`;
+        })
+            .join("\n");
+        return `[\n${items}\n${" ".repeat(4 * depth)}]`;
+    }
+    /// Case mapping
+    const entries = Object.entries(obj);
+    const lines = entries
+        .map(([key, value]) => {
+        const formattedValue = formatTsObject(value, depth + 1);
+        const keyStr = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(key) ? key : `"${key}"`;
+        return `${" ".repeat(4 * (depth + 1))}${keyStr}: ${formattedValue},`;
+    })
+        .join("\n");
+    return `{\n${lines}\n${" ".repeat(4 * depth)}}`;
+}
+function indentString(str) {
+    return str
+        .split("\n")
+        .map((line) => " ".repeat(4) + line)
+        .join("\n");
+}
+function removeSuffix(str, suffix) {
+    return str.endsWith(suffix) ? str.slice(0, -suffix.length) : str;
+}

package/dist/commonjs/snippets/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInferenceSnippets = void 0;
+var getInferenceSnippets_js_1 = require("./getInferenceSnippets.js");
+Object.defineProperty(exports, "getInferenceSnippets", { enumerable: true, get: function () { return getInferenceSnippets_js_1.getInferenceSnippets; } });