@huggingface/inference 3.13.2 → 3.14.0

package/dist/esm/providers/hf-inference.d.ts

@@ -0,0 +1,131 @@
+/**
+ * HF-Inference do not have a mapping since all models use IDs from the Hub.
+ *
+ * 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 HF 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 HF, please open an issue on the present repo
+ * and we will tag HF team members.
+ *
+ * Thanks!
+ */
+import type { AudioClassificationOutput, AutomaticSpeechRecognitionOutput, ChatCompletionOutput, DocumentQuestionAnsweringOutput, FeatureExtractionOutput, FillMaskOutput, ImageClassificationOutput, ImageSegmentationOutput, ImageToTextOutput, ObjectDetectionOutput, QuestionAnsweringOutput, SentenceSimilarityOutput, SummarizationOutput, TableQuestionAnsweringOutput, TextClassificationOutput, TextGenerationOutput, TokenClassificationOutput, TranslationOutput, VisualQuestionAnsweringOutput, ZeroShotClassificationOutput, ZeroShotImageClassificationOutput } from "@huggingface/tasks";
+import type { TabularClassificationOutput } from "../tasks/tabular/tabularClassification.js";
+import type { BodyParams, RequestArgs, UrlParams } from "../types.js";
+import type { AudioClassificationTaskHelper, AudioToAudioTaskHelper, AutomaticSpeechRecognitionTaskHelper, ConversationalTaskHelper, DocumentQuestionAnsweringTaskHelper, FeatureExtractionTaskHelper, FillMaskTaskHelper, ImageClassificationTaskHelper, ImageSegmentationTaskHelper, ImageToImageTaskHelper, ImageToTextTaskHelper, ObjectDetectionTaskHelper, QuestionAnsweringTaskHelper, SentenceSimilarityTaskHelper, SummarizationTaskHelper, TableQuestionAnsweringTaskHelper, TabularClassificationTaskHelper, TabularRegressionTaskHelper, TextClassificationTaskHelper, TextGenerationTaskHelper, TextToAudioTaskHelper, TextToImageTaskHelper, TextToSpeechTaskHelper, TokenClassificationTaskHelper, TranslationTaskHelper, VisualQuestionAnsweringTaskHelper, ZeroShotClassificationTaskHelper, ZeroShotImageClassificationTaskHelper } from "./providerHelper.js";
+import { TaskProviderHelper } from "./providerHelper.js";
+import type { ImageToImageArgs } from "../tasks/cv/imageToImage.js";
+import type { AutomaticSpeechRecognitionArgs } from "../tasks/audio/automaticSpeechRecognition.js";
+interface Base64ImageGeneration {
+    data: Array<{
+        b64_json: string;
+    }>;
+}
+interface OutputUrlImageGeneration {
+    output: string[];
+}
+interface AudioToAudioOutput {
+    blob: string;
+    "content-type": string;
+    label: string;
+}
+export declare const EQUIVALENT_SENTENCE_TRANSFORMERS_TASKS: readonly ["feature-extraction", "sentence-similarity"];
+export declare class HFInferenceTask extends TaskProviderHelper {
+    constructor();
+    preparePayload(params: BodyParams): Record<string, unknown>;
+    makeUrl(params: UrlParams): string;
+    makeRoute(params: UrlParams): string;
+    getResponse(response: unknown): Promise<unknown>;
+}
+export declare class HFInferenceTextToImageTask extends HFInferenceTask implements TextToImageTaskHelper {
+    getResponse(response: Base64ImageGeneration | OutputUrlImageGeneration, url?: string, headers?: HeadersInit, outputType?: "url" | "blob"): Promise<string | Blob>;
+}
+export declare class HFInferenceConversationalTask extends HFInferenceTask implements ConversationalTaskHelper {
+    makeUrl(params: UrlParams): string;
+    preparePayload(params: BodyParams): Record<string, unknown>;
+    getResponse(response: ChatCompletionOutput): Promise<ChatCompletionOutput>;
+}
+export declare class HFInferenceTextGenerationTask extends HFInferenceTask implements TextGenerationTaskHelper {
+    getResponse(response: TextGenerationOutput | TextGenerationOutput[]): Promise<TextGenerationOutput>;
+}
+export declare class HFInferenceAudioClassificationTask extends HFInferenceTask implements AudioClassificationTaskHelper {
+    getResponse(response: unknown): Promise<AudioClassificationOutput>;
+}
+export declare class HFInferenceAutomaticSpeechRecognitionTask extends HFInferenceTask implements AutomaticSpeechRecognitionTaskHelper {
+    getResponse(response: AutomaticSpeechRecognitionOutput): Promise<AutomaticSpeechRecognitionOutput>;
+    preparePayloadAsync(args: AutomaticSpeechRecognitionArgs): Promise<RequestArgs>;
+}
+export declare class HFInferenceAudioToAudioTask extends HFInferenceTask implements AudioToAudioTaskHelper {
+    getResponse(response: AudioToAudioOutput[]): Promise<AudioToAudioOutput[]>;
+}
+export declare class HFInferenceDocumentQuestionAnsweringTask extends HFInferenceTask implements DocumentQuestionAnsweringTaskHelper {
+    getResponse(response: DocumentQuestionAnsweringOutput): Promise<DocumentQuestionAnsweringOutput[number]>;
+}
+export declare class HFInferenceFeatureExtractionTask extends HFInferenceTask implements FeatureExtractionTaskHelper {
+    getResponse(response: FeatureExtractionOutput): Promise<FeatureExtractionOutput>;
+}
+export declare class HFInferenceImageClassificationTask extends HFInferenceTask implements ImageClassificationTaskHelper {
+    getResponse(response: ImageClassificationOutput): Promise<ImageClassificationOutput>;
+}
+export declare class HFInferenceImageSegmentationTask extends HFInferenceTask implements ImageSegmentationTaskHelper {
+    getResponse(response: ImageSegmentationOutput): Promise<ImageSegmentationOutput>;
+}
+export declare class HFInferenceImageToTextTask extends HFInferenceTask implements ImageToTextTaskHelper {
+    getResponse(response: ImageToTextOutput): Promise<ImageToTextOutput>;
+}
+export declare class HFInferenceImageToImageTask extends HFInferenceTask implements ImageToImageTaskHelper {
+    preparePayloadAsync(args: ImageToImageArgs): Promise<RequestArgs>;
+    getResponse(response: Blob): Promise<Blob>;
+}
+export declare class HFInferenceObjectDetectionTask extends HFInferenceTask implements ObjectDetectionTaskHelper {
+    getResponse(response: ObjectDetectionOutput): Promise<ObjectDetectionOutput>;
+}
+export declare class HFInferenceZeroShotImageClassificationTask extends HFInferenceTask implements ZeroShotImageClassificationTaskHelper {
+    getResponse(response: ZeroShotImageClassificationOutput): Promise<ZeroShotImageClassificationOutput>;
+}
+export declare class HFInferenceTextClassificationTask extends HFInferenceTask implements TextClassificationTaskHelper {
+    getResponse(response: TextClassificationOutput): Promise<TextClassificationOutput>;
+}
+export declare class HFInferenceQuestionAnsweringTask extends HFInferenceTask implements QuestionAnsweringTaskHelper {
+    getResponse(response: QuestionAnsweringOutput | QuestionAnsweringOutput[number]): Promise<QuestionAnsweringOutput[number]>;
+}
+export declare class HFInferenceFillMaskTask extends HFInferenceTask implements FillMaskTaskHelper {
+    getResponse(response: FillMaskOutput): Promise<FillMaskOutput>;
+}
+export declare class HFInferenceZeroShotClassificationTask extends HFInferenceTask implements ZeroShotClassificationTaskHelper {
+    getResponse(response: ZeroShotClassificationOutput): Promise<ZeroShotClassificationOutput>;
+}
+export declare class HFInferenceSentenceSimilarityTask extends HFInferenceTask implements SentenceSimilarityTaskHelper {
+    getResponse(response: SentenceSimilarityOutput): Promise<SentenceSimilarityOutput>;
+}
+export declare class HFInferenceTableQuestionAnsweringTask extends HFInferenceTask implements TableQuestionAnsweringTaskHelper {
+    static validate(elem: unknown): elem is TableQuestionAnsweringOutput[number];
+    getResponse(response: TableQuestionAnsweringOutput): Promise<TableQuestionAnsweringOutput[number]>;
+}
+export declare class HFInferenceTokenClassificationTask extends HFInferenceTask implements TokenClassificationTaskHelper {
+    getResponse(response: TokenClassificationOutput): Promise<TokenClassificationOutput>;
+}
+export declare class HFInferenceTranslationTask extends HFInferenceTask implements TranslationTaskHelper {
+    getResponse(response: TranslationOutput): Promise<TranslationOutput>;
+}
+export declare class HFInferenceSummarizationTask extends HFInferenceTask implements SummarizationTaskHelper {
+    getResponse(response: SummarizationOutput): Promise<SummarizationOutput>;
+}
+export declare class HFInferenceTextToSpeechTask extends HFInferenceTask implements TextToSpeechTaskHelper {
+    getResponse(response: Blob): Promise<Blob>;
+}
+export declare class HFInferenceTabularClassificationTask extends HFInferenceTask implements TabularClassificationTaskHelper {
+    getResponse(response: TabularClassificationOutput): Promise<TabularClassificationOutput>;
+}
+export declare class HFInferenceVisualQuestionAnsweringTask extends HFInferenceTask implements VisualQuestionAnsweringTaskHelper {
+    getResponse(response: VisualQuestionAnsweringOutput): Promise<VisualQuestionAnsweringOutput[number]>;
+}
+export declare class HFInferenceTabularRegressionTask extends HFInferenceTask implements TabularRegressionTaskHelper {
+    getResponse(response: number[]): Promise<number[]>;
+}
+export declare class HFInferenceTextToAudioTask extends HFInferenceTask implements TextToAudioTaskHelper {
+    getResponse(response: Blob): Promise<Blob>;
+}
+export {};
+//# sourceMappingURL=hf-inference.d.ts.map

package/dist/esm/providers/hf-inference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hf-inference.d.ts","sourceRoot":"","sources":["../../../src/providers/hf-inference.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,KAAK,EACX,yBAAyB,EACzB,gCAAgC,EAChC,oBAAoB,EACpB,+BAA+B,EAC/B,uBAAuB,EACvB,cAAc,EACd,yBAAyB,EACzB,uBAAuB,EACvB,iBAAiB,EACjB,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACxB,mBAAmB,EACnB,4BAA4B,EAC5B,wBAAwB,EACxB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,6BAA6B,EAC7B,4BAA4B,EAC5B,iCAAiC,EACjC,MAAM,oBAAoB,CAAC;AAG5B,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAC;AAC7F,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAEtE,OAAO,KAAK,EACX,6BAA6B,EAC7B,sBAAsB,EACtB,oCAAoC,EACpC,wBAAwB,EACxB,mCAAmC,EACnC,2BAA2B,EAC3B,kBAAkB,EAClB,6BAA6B,EAC7B,2BAA2B,EAC3B,sBAAsB,EACtB,qBAAqB,EACrB,yBAAyB,EACzB,2BAA2B,EAC3B,4BAA4B,EAC5B,uBAAuB,EACvB,gCAAgC,EAChC,+BAA+B,EAC/B,2BAA2B,EAC3B,4BAA4B,EAC5B,wBAAwB,EACxB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,6BAA6B,EAC7B,qBAAqB,EACrB,iCAAiC,EACjC,gCAAgC,EAChC,qCAAqC,EACrC,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,8CAA8C,CAAC;AAEnG,UAAU,qBAAqB;IAC9B,IAAI,EAAE,KAAK,CAAC;QACX,QAAQ,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;CACH;AAED,UAAU,wBAAwB;IACjC,MAAM,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,UAAU,kBAAkB;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;CACd;AAED,eAAO,MAAM,sCAAsC,wDAAyD,CAAC;AAE7G,qBAAa,eAAgB,SAAQ,kBAAkB;;IAItD,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAGlD,OAAO,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM;IAO3C,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM;IAQrB,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;CAG/D;AAED,qBAAa,0BAA2B,SAAQ,eAAgB,YAAW,qBAAqB;IAChF,WAAW,CACzB,QAAQ,EAAE,qBAAqB,GAAG,wBAAwB,EAC1D,GAAG,CAAC,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,WAAW,EACrB,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,GACzB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CA+BzB;AAED,qBAAa,6BAA8B,SAAQ,eAAgB,YAAW,wBAAwB;IAC5F,OAAO,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM;IAkBlC,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAOrD,WAAW,CAAC,QAAQ,EAAE,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAGzF;AAED,qBAAa,6BAA8B,SAAQ,eAAgB,YAAW,wBAAwB;IACtF,WAAW,CAAC,QAAQ,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAOlH;AAED,qBAAa,kCAAmC,SAAQ,eAAgB,YAAW,6BAA6B;IAChG,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,yBAAyB,CAAC;CAejF;AAED,qBAAa,yCACZ,SAAQ,eACR,YAAW,oCAAoC;IAEhC,WAAW,CAAC,QAAQ,EAAE,gCAAgC,GAAG,OAAO,CAAC,gCAAgC,CAAC;IAI3G,mBAAmB,CAAC,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,WAAW,CAAC;CAQrF;AAED,qBAAa,2BAA4B,SAAQ,eAAgB,YAAW,sBAAsB;IAClF,WAAW,CAAC,QAAQ,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;CAsBzF;AAED,qBAAa,wCACZ,SAAQ,eACR,YAAW,mCAAmC;IAE/B,WAAW,CACzB,QAAQ,EAAE,+BAA+B,GACvC,OAAO,CAAC,+BAA+B,CAAC,MAAM,CAAC,CAAC;CAiBnD;AAED,qBAAa,gCAAiC,SAAQ,eAAgB,YAAW,2BAA2B;IAC5F,WAAW,CAAC,QAAQ,EAAE,uBAAuB,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAc/F;AAED,qBAAa,kCAAmC,SAAQ,eAAgB,YAAW,6BAA6B;IAChG,WAAW,CAAC,QAAQ,EAAE,yBAAyB,GAAG,OAAO,CAAC,yBAAyB,CAAC;CAMnG;AAED,qBAAa,gCAAiC,SAAQ,eAAgB,YAAW,2BAA2B;IAC5F,WAAW,CAAC,QAAQ,EAAE,uBAAuB,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAc/F;AAED,qBAAa,0BAA2B,SAAQ,eAAgB,YAAW,qBAAqB;IAChF,WAAW,CAAC,QAAQ,EAAE,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAMnF;AAED,qBAAa,2BAA4B,SAAQ,eAAgB,YAAW,sBAAsB;IAC3F,mBAAmB,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,WAAW,CAAC;IAiBxD,WAAW,CAAC,QAAQ,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAMzD;AAED,qBAAa,8BAA+B,SAAQ,eAAgB,YAAW,yBAAyB;IACxF,WAAW,CAAC,QAAQ,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAmB3F;AAED,qBAAa,0CACZ,SAAQ,eACR,YAAW,qCAAqC;IAEjC,WAAW,CAAC,QAAQ,EAAE,iCAAiC,GAAG,OAAO,CAAC,iCAAiC,CAAC;CAMnH;AAED,qBAAa,iCAAkC,SAAQ,eAAgB,YAAW,4BAA4B;IAC9F,WAAW,CAAC,QAAQ,EAAE,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAOjG;AAED,qBAAa,gCAAiC,SAAQ,eAAgB,YAAW,2BAA2B;IAC5F,WAAW,CACzB,QAAQ,EAAE,uBAAuB,GAAG,uBAAuB,CAAC,MAAM,CAAC,GACjE,OAAO,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;CAuB3C;AAED,qBAAa,uBAAwB,SAAQ,eAAgB,YAAW,kBAAkB;IAC1E,WAAW,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;CAiB7E;AAED,qBAAa,qCAAsC,SAAQ,eAAgB,YAAW,gCAAgC;IACtG,WAAW,CAAC,QAAQ,EAAE,4BAA4B,GAAG,OAAO,CAAC,4BAA4B,CAAC;CAgBzG;AAED,qBAAa,iCAAkC,SAAQ,eAAgB,YAAW,4BAA4B;IAC9F,WAAW,CAAC,QAAQ,EAAE,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAMjG;AAED,qBAAa,qCAAsC,SAAQ,eAAgB,YAAW,gCAAgC;IACrH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,4BAA4B,CAAC,MAAM,CAAC;IAkB7D,WAAW,CAAC,QAAQ,EAAE,4BAA4B,GAAG,OAAO,CAAC,4BAA4B,CAAC,MAAM,CAAC,CAAC;CAYjH;AAED,qBAAa,kCAAmC,SAAQ,eAAgB,YAAW,6BAA6B;IAChG,WAAW,CAAC,QAAQ,EAAE,yBAAyB,GAAG,OAAO,CAAC,yBAAyB,CAAC;CAkBnG;AAED,qBAAa,0BAA2B,SAAQ,eAAgB,YAAW,qBAAqB;IAChF,WAAW,CAAC,QAAQ,EAAE,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAMnF;AAED,qBAAa,4BAA6B,SAAQ,eAAgB,YAAW,uBAAuB;IACpF,WAAW,CAAC,QAAQ,EAAE,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAMvF;AAED,qBAAa,2BAA4B,SAAQ,eAAgB,YAAW,sBAAsB;IAClF,WAAW,CAAC,QAAQ,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAGzD;AAED,qBAAa,oCAAqC,SAAQ,eAAgB,YAAW,+BAA+B;IACpG,WAAW,CAAC,QAAQ,EAAE,2BAA2B,GAAG,OAAO,CAAC,2BAA2B,CAAC;CAMvG;AAED,qBAAa,sCACZ,SAAQ,eACR,YAAW,iCAAiC;IAE7B,WAAW,CAAC,QAAQ,EAAE,6BAA6B,GAAG,OAAO,CAAC,6BAA6B,CAAC,MAAM,CAAC,CAAC;CAYnH;AAED,qBAAa,gCAAiC,SAAQ,eAAgB,YAAW,2BAA2B;IAC5F,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAMjE;AAED,qBAAa,0BAA2B,SAAQ,eAAgB,YAAW,qBAAqB;IAChF,WAAW,CAAC,QAAQ,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAGzD"}

package/dist/esm/providers/hf-inference.js

@@ -0,0 +1,400 @@
+import { HF_ROUTER_URL } from "../config.js";
+import { InferenceOutputError } from "../lib/InferenceOutputError.js";
+import { toArray } from "../utils/toArray.js";
+import { TaskProviderHelper } from "./providerHelper.js";
+import { base64FromBytes } from "../utils/base64FromBytes.js";
+import { omit } from "../utils/omit.js";
+export const EQUIVALENT_SENTENCE_TRANSFORMERS_TASKS = ["feature-extraction", "sentence-similarity"];
+export class HFInferenceTask extends TaskProviderHelper {
+    constructor() {
+        super("hf-inference", `${HF_ROUTER_URL}/hf-inference`);
+    }
+    preparePayload(params) {
+        return params.args;
+    }
+    makeUrl(params) {
+        if (params.model.startsWith("http://") || params.model.startsWith("https://")) {
+            return params.model;
+        }
+        return super.makeUrl(params);
+    }
+    makeRoute(params) {
+        if (params.task && ["feature-extraction", "sentence-similarity"].includes(params.task)) {
+            // when deployed on hf-inference, those two tasks are automatically compatible with one another.
+            return `models/${params.model}/pipeline/${params.task}`;
+        }
+        return `models/${params.model}`;
+    }
+    async getResponse(response) {
+        return response;
+    }
+}
+export class HFInferenceTextToImageTask extends HFInferenceTask {
+    async getResponse(response, url, headers, outputType) {
+        if (!response) {
+            throw new InferenceOutputError("response is undefined");
+        }
+        if (typeof response == "object") {
+            if ("data" in response && Array.isArray(response.data) && response.data[0].b64_json) {
+                const base64Data = response.data[0].b64_json;
+                if (outputType === "url") {
+                    return `data:image/jpeg;base64,${base64Data}`;
+                }
+                const base64Response = await fetch(`data:image/jpeg;base64,${base64Data}`);
+                return await base64Response.blob();
+            }
+            if ("output" in response && Array.isArray(response.output)) {
+                if (outputType === "url") {
+                    return response.output[0];
+                }
+                const urlResponse = await fetch(response.output[0]);
+                const blob = await urlResponse.blob();
+                return blob;
+            }
+        }
+        if (response instanceof Blob) {
+            if (outputType === "url") {
+                const b64 = await response.arrayBuffer().then((buf) => Buffer.from(buf).toString("base64"));
+                return `data:image/jpeg;base64,${b64}`;
+            }
+            return response;
+        }
+        throw new InferenceOutputError("Expected a Blob ");
+    }
+}
+export class HFInferenceConversationalTask extends HFInferenceTask {
+    makeUrl(params) {
+        let url;
+        if (params.model.startsWith("http://") || params.model.startsWith("https://")) {
+            url = params.model.trim();
+        }
+        else {
+            url = `${this.makeBaseUrl(params)}/models/${params.model}`;
+        }
+        url = url.replace(/\/+$/, "");
+        if (url.endsWith("/v1")) {
+            url += "/chat/completions";
+        }
+        else if (!url.endsWith("/chat/completions")) {
+            url += "/v1/chat/completions";
+        }
+        return url;
+    }
+    preparePayload(params) {
+        return {
+            ...params.args,
+            model: params.model,
+        };
+    }
+    async getResponse(response) {
+        return response;
+    }
+}
+export class HFInferenceTextGenerationTask extends HFInferenceTask {
+    async getResponse(response) {
+        const res = toArray(response);
+        if (Array.isArray(res) && res.every((x) => "generated_text" in x && typeof x?.generated_text === "string")) {
+            return res?.[0];
+        }
+        throw new InferenceOutputError("Expected Array<{generated_text: string}>");
+    }
+}
+export class HFInferenceAudioClassificationTask extends HFInferenceTask {
+    async getResponse(response) {
+        // Add type checking/validation for the 'unknown' input
+        if (Array.isArray(response) &&
+            response.every((x) => typeof x === "object" && x !== null && typeof x.label === "string" && typeof x.score === "number")) {
+            // If validation passes, it's safe to return as AudioClassificationOutput
+            return response;
+        }
+        // If validation fails, throw an error
+        throw new InferenceOutputError("Expected Array<{label: string, score: number}> but received different format");
+    }
+}
+export class HFInferenceAutomaticSpeechRecognitionTask extends HFInferenceTask {
+    async getResponse(response) {
+        return response;
+    }
+    async preparePayloadAsync(args) {
+        return "data" in args
+            ? args
+            : {
+                ...omit(args, "inputs"),
+                data: args.inputs,
+            };
+    }
+}
+export class HFInferenceAudioToAudioTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (!Array.isArray(response)) {
+            throw new InferenceOutputError("Expected Array");
+        }
+        if (!response.every((elem) => {
+            return (typeof elem === "object" &&
+                elem &&
+                "label" in elem &&
+                typeof elem.label === "string" &&
+                "content-type" in elem &&
+                typeof elem["content-type"] === "string" &&
+                "blob" in elem &&
+                typeof elem.blob === "string");
+        })) {
+            throw new InferenceOutputError("Expected Array<{label: string, audio: Blob}>");
+        }
+        return response;
+    }
+}
+export class HFInferenceDocumentQuestionAnsweringTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (Array.isArray(response) &&
+            response.every((elem) => typeof elem === "object" &&
+                !!elem &&
+                typeof elem?.answer === "string" &&
+                (typeof elem.end === "number" || typeof elem.end === "undefined") &&
+                (typeof elem.score === "number" || typeof elem.score === "undefined") &&
+                (typeof elem.start === "number" || typeof elem.start === "undefined"))) {
+            return response[0];
+        }
+        throw new InferenceOutputError("Expected Array<{answer: string, end: number, score: number, start: number}>");
+    }
+}
+export class HFInferenceFeatureExtractionTask extends HFInferenceTask {
+    async getResponse(response) {
+        const isNumArrayRec = (arr, maxDepth, curDepth = 0) => {
+            if (curDepth > maxDepth)
+                return false;
+            if (arr.every((x) => Array.isArray(x))) {
+                return arr.every((x) => isNumArrayRec(x, maxDepth, curDepth + 1));
+            }
+            else {
+                return arr.every((x) => typeof x === "number");
+            }
+        };
+        if (Array.isArray(response) && isNumArrayRec(response, 3, 0)) {
+            return response;
+        }
+        throw new InferenceOutputError("Expected Array<number[][][] | number[][] | number[] | number>");
+    }
+}
+export class HFInferenceImageClassificationTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (Array.isArray(response) && response.every((x) => typeof x.label === "string" && typeof x.score === "number")) {
+            return response;
+        }
+        throw new InferenceOutputError("Expected Array<{label: string, score: number}>");
+    }
+}
+export class HFInferenceImageSegmentationTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (Array.isArray(response) &&
+            response.every((x) => typeof x.label === "string" &&
+                typeof x.mask === "string" &&
+                (x.score === undefined || typeof x.score === "number"))) {
+            return response;
+        }
+        throw new InferenceOutputError("Expected Array<{label: string, mask: string, score: number}>");
+    }
+}
+export class HFInferenceImageToTextTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (typeof response?.generated_text !== "string") {
+            throw new InferenceOutputError("Expected {generated_text: string}");
+        }
+        return response;
+    }
+}
+export class HFInferenceImageToImageTask extends HFInferenceTask {
+    async preparePayloadAsync(args) {
+        if (!args.parameters) {
+            return {
+                ...args,
+                model: args.model,
+                data: args.inputs,
+            };
+        }
+        else {
+            return {
+                ...args,
+                inputs: base64FromBytes(new Uint8Array(args.inputs instanceof ArrayBuffer ? args.inputs : await args.inputs.arrayBuffer())),
+            };
+        }
+    }
+    async getResponse(response) {
+        if (response instanceof Blob) {
+            return response;
+        }
+        throw new InferenceOutputError("Expected Blob");
+    }
+}
+export class HFInferenceObjectDetectionTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (Array.isArray(response) &&
+            response.every((x) => typeof x.label === "string" &&
+                typeof x.score === "number" &&
+                typeof x.box.xmin === "number" &&
+                typeof x.box.ymin === "number" &&
+                typeof x.box.xmax === "number" &&
+                typeof x.box.ymax === "number")) {
+            return response;
+        }
+        throw new InferenceOutputError("Expected Array<{label: string, score: number, box: {xmin: number, ymin: number, xmax: number, ymax: number}}>");
+    }
+}
+export class HFInferenceZeroShotImageClassificationTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (Array.isArray(response) && response.every((x) => typeof x.label === "string" && typeof x.score === "number")) {
+            return response;
+        }
+        throw new InferenceOutputError("Expected Array<{label: string, score: number}>");
+    }
+}
+export class HFInferenceTextClassificationTask extends HFInferenceTask {
+    async getResponse(response) {
+        const output = response?.[0];
+        if (Array.isArray(output) && output.every((x) => typeof x?.label === "string" && typeof x.score === "number")) {
+            return output;
+        }
+        throw new InferenceOutputError("Expected Array<{label: string, score: number}>");
+    }
+}
+export class HFInferenceQuestionAnsweringTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (Array.isArray(response)
+            ? response.every((elem) => typeof elem === "object" &&
+                !!elem &&
+                typeof elem.answer === "string" &&
+                typeof elem.end === "number" &&
+                typeof elem.score === "number" &&
+                typeof elem.start === "number")
+            : typeof response === "object" &&
+                !!response &&
+                typeof response.answer === "string" &&
+                typeof response.end === "number" &&
+                typeof response.score === "number" &&
+                typeof response.start === "number") {
+            return Array.isArray(response) ? response[0] : response;
+        }
+        throw new InferenceOutputError("Expected Array<{answer: string, end: number, score: number, start: number}>");
+    }
+}
+export class HFInferenceFillMaskTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (Array.isArray(response) &&
+            response.every((x) => typeof x.score === "number" &&
+                typeof x.sequence === "string" &&
+                typeof x.token === "number" &&
+                typeof x.token_str === "string")) {
+            return response;
+        }
+        throw new InferenceOutputError("Expected Array<{score: number, sequence: string, token: number, token_str: string}>");
+    }
+}
+export class HFInferenceZeroShotClassificationTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (Array.isArray(response) &&
+            response.every((x) => Array.isArray(x.labels) &&
+                x.labels.every((_label) => typeof _label === "string") &&
+                Array.isArray(x.scores) &&
+                x.scores.every((_score) => typeof _score === "number") &&
+                typeof x.sequence === "string")) {
+            return response;
+        }
+        throw new InferenceOutputError("Expected Array<{labels: string[], scores: number[], sequence: string}>");
+    }
+}
+export class HFInferenceSentenceSimilarityTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (Array.isArray(response) && response.every((x) => typeof x === "number")) {
+            return response;
+        }
+        throw new InferenceOutputError("Expected Array<number>");
+    }
+}
+export class HFInferenceTableQuestionAnsweringTask extends HFInferenceTask {
+    static validate(elem) {
+        return (typeof elem === "object" &&
+            !!elem &&
+            "aggregator" in elem &&
+            typeof elem.aggregator === "string" &&
+            "answer" in elem &&
+            typeof elem.answer === "string" &&
+            "cells" in elem &&
+            Array.isArray(elem.cells) &&
+            elem.cells.every((x) => typeof x === "string") &&
+            "coordinates" in elem &&
+            Array.isArray(elem.coordinates) &&
+            elem.coordinates.every((coord) => Array.isArray(coord) && coord.every((x) => typeof x === "number")));
+    }
+    async getResponse(response) {
+        if (Array.isArray(response) && Array.isArray(response)
+            ? response.every((elem) => HFInferenceTableQuestionAnsweringTask.validate(elem))
+            : HFInferenceTableQuestionAnsweringTask.validate(response)) {
+            return Array.isArray(response) ? response[0] : response;
+        }
+        throw new InferenceOutputError("Expected {aggregator: string, answer: string, cells: string[], coordinates: number[][]}");
+    }
+}
+export class HFInferenceTokenClassificationTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (Array.isArray(response) &&
+            response.every((x) => typeof x.end === "number" &&
+                typeof x.entity_group === "string" &&
+                typeof x.score === "number" &&
+                typeof x.start === "number" &&
+                typeof x.word === "string")) {
+            return response;
+        }
+        throw new InferenceOutputError("Expected Array<{end: number, entity_group: string, score: number, start: number, word: string}>");
+    }
+}
+export class HFInferenceTranslationTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (Array.isArray(response) && response.every((x) => typeof x?.translation_text === "string")) {
+            return response?.length === 1 ? response?.[0] : response;
+        }
+        throw new InferenceOutputError("Expected Array<{translation_text: string}>");
+    }
+}
+export class HFInferenceSummarizationTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (Array.isArray(response) && response.every((x) => typeof x?.summary_text === "string")) {
+            return response?.[0];
+        }
+        throw new InferenceOutputError("Expected Array<{summary_text: string}>");
+    }
+}
+export class HFInferenceTextToSpeechTask extends HFInferenceTask {
+    async getResponse(response) {
+        return response;
+    }
+}
+export class HFInferenceTabularClassificationTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (Array.isArray(response) && response.every((x) => typeof x === "number")) {
+            return response;
+        }
+        throw new InferenceOutputError("Expected Array<number>");
+    }
+}
+export class HFInferenceVisualQuestionAnsweringTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (Array.isArray(response) &&
+            response.every((elem) => typeof elem === "object" && !!elem && typeof elem?.answer === "string" && typeof elem.score === "number")) {
+            return response[0];
+        }
+        throw new InferenceOutputError("Expected Array<{answer: string, score: number}>");
+    }
+}
+export class HFInferenceTabularRegressionTask extends HFInferenceTask {
+    async getResponse(response) {
+        if (Array.isArray(response) && response.every((x) => typeof x === "number")) {
+            return response;
+        }
+        throw new InferenceOutputError("Expected Array<number>");
+    }
+}
+export class HFInferenceTextToAudioTask extends HFInferenceTask {
+    async getResponse(response) {
+        return response;
+    }
+}

package/dist/esm/providers/hyperbolic.d.ts

@@ -0,0 +1,48 @@
+/**
+ * See the registered mapping of HF model ID => Hyperbolic model ID here:
+ *
+ * https://huggingface.co/api/partners/hyperbolic/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 Hyperbolic 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 Hyperbolic, please open an issue on the present repo
+ * and we will tag Hyperbolic team members.
+ *
+ * Thanks!
+ */
+import type { ChatCompletionOutput, TextGenerationOutput } from "@huggingface/tasks";
+import type { BodyParams, UrlParams } from "../types.js";
+import { BaseConversationalTask, BaseTextGenerationTask, TaskProviderHelper, type TextToImageTaskHelper } from "./providerHelper.js";
+export interface HyperbolicTextCompletionOutput extends Omit<ChatCompletionOutput, "choices"> {
+    choices: Array<{
+        message: {
+            content: string;
+        };
+    }>;
+}
+interface HyperbolicTextToImageOutput {
+    images: Array<{
+        image: string;
+    }>;
+}
+export declare class HyperbolicConversationalTask extends BaseConversationalTask {
+    constructor();
+}
+export declare class HyperbolicTextGenerationTask extends BaseTextGenerationTask {
+    constructor();
+    makeRoute(): string;
+    preparePayload(params: BodyParams): Record<string, unknown>;
+    getResponse(response: HyperbolicTextCompletionOutput): Promise<TextGenerationOutput>;
+}
+export declare class HyperbolicTextToImageTask extends TaskProviderHelper implements TextToImageTaskHelper {
+    constructor();
+    makeRoute(params: UrlParams): string;
+    preparePayload(params: BodyParams): Record<string, unknown>;
+    getResponse(response: HyperbolicTextToImageOutput, url?: string, headers?: HeadersInit, outputType?: "url" | "blob"): Promise<string | Blob>;
+}
+export {};
+//# sourceMappingURL=hyperbolic.d.ts.map

package/dist/esm/providers/hyperbolic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hyperbolic.d.ts","sourceRoot":"","sources":["../../../src/providers/hyperbolic.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAErF,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAEzD,OAAO,EACN,sBAAsB,EACtB,sBAAsB,EACtB,kBAAkB,EAClB,KAAK,qBAAqB,EAC1B,MAAM,qBAAqB,CAAC;AAI7B,MAAM,WAAW,8BAA+B,SAAQ,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC;IAC5F,OAAO,EAAE,KAAK,CAAC;QACd,OAAO,EAAE;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,CAAC;KAC7B,CAAC,CAAC;CACH;AAED,UAAU,2BAA2B;IACpC,MAAM,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACjC;AAED,qBAAa,4BAA6B,SAAQ,sBAAsB;;CAIvE;AAED,qBAAa,4BAA6B,SAAQ,sBAAsB;;IAK9D,SAAS,IAAI,MAAM;IAInB,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAcrD,WAAW,CAAC,QAAQ,EAAE,8BAA8B,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAenG;AAED,qBAAa,yBAA0B,SAAQ,kBAAmB,YAAW,qBAAqB;;IAKjG,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM;IAKpC,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IASrD,WAAW,CAChB,QAAQ,EAAE,2BAA2B,EACrC,GAAG,CAAC,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,WAAW,EACrB,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,GACzB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CAgBzB"}

package/dist/esm/providers/hyperbolic.js

@@ -0,0 +1,72 @@
+import { InferenceOutputError } from "../lib/InferenceOutputError.js";
+import { omit } from "../utils/omit.js";
+import { BaseConversationalTask, BaseTextGenerationTask, TaskProviderHelper, } from "./providerHelper.js";
+const HYPERBOLIC_API_BASE_URL = "https://api.hyperbolic.xyz";
+export class HyperbolicConversationalTask extends BaseConversationalTask {
+    constructor() {
+        super("hyperbolic", HYPERBOLIC_API_BASE_URL);
+    }
+}
+export class HyperbolicTextGenerationTask extends BaseTextGenerationTask {
+    constructor() {
+        super("hyperbolic", HYPERBOLIC_API_BASE_URL);
+    }
+    makeRoute() {
+        return "v1/chat/completions";
+    }
+    preparePayload(params) {
+        return {
+            messages: [{ content: params.args.inputs, role: "user" }],
+            ...(params.args.parameters
+                ? {
+                    max_tokens: params.args.parameters.max_new_tokens,
+                    ...omit(params.args.parameters, "max_new_tokens"),
+                }
+                : undefined),
+            ...omit(params.args, ["inputs", "parameters"]),
+            model: params.model,
+        };
+    }
+    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.message.content,
+            };
+        }
+        throw new InferenceOutputError("Expected Hyperbolic text generation response format");
+    }
+}
+export class HyperbolicTextToImageTask extends TaskProviderHelper {
+    constructor() {
+        super("hyperbolic", HYPERBOLIC_API_BASE_URL);
+    }
+    makeRoute(params) {
+        void params;
+        return `/v1/images/generations`;
+    }
+    preparePayload(params) {
+        return {
+            ...omit(params.args, ["inputs", "parameters"]),
+            ...params.args.parameters,
+            prompt: params.args.inputs,
+            model_name: params.model,
+        };
+    }
+    async getResponse(response, url, headers, outputType) {
+        if (typeof response === "object" &&
+            "images" in response &&
+            Array.isArray(response.images) &&
+            response.images[0] &&
+            typeof response.images[0].image === "string") {
+            if (outputType === "url") {
+                return `data:image/jpeg;base64,${response.images[0].image}`;
+            }
+            return fetch(`data:image/jpeg;base64,${response.images[0].image}`).then((res) => res.blob());
+        }
+        throw new InferenceOutputError("Expected Hyperbolic text-to-image response format");
+    }
+}