@huggingface/inference 3.7.0 → 3.7.1

package/dist/src/tasks/tabular/tabularRegression.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tabularRegression.d.ts","sourceRoot":"","sources":["../../../../src/tasks/tabular/tabularRegression.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAGrD,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG;IAC9C,MAAM,EAAE;QACP;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;KAC/B,CAAC;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,EAAE,CAAC;AAE/C;;;;GAIG;AACH,wBAAsB,iBAAiB,CACtC,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,uBAAuB,CAAC,CAUlC"}
+{"version":3,"file":"tabularRegression.d.ts","sourceRoot":"","sources":["../../../../src/tasks/tabular/tabularRegression.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAGrD,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG;IAC9C,MAAM,EAAE;QACP;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;KAC/B,CAAC;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,EAAE,CAAC;AAE/C;;;;GAIG;AACH,wBAAsB,iBAAiB,CACtC,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,uBAAuB,CAAC,CAOlC"}

package/dist/src/types.d.ts

@@ -28,7 +28,7 @@ export interface Options {
      */
     billTo?: string;
 }
-export type InferenceTask = Exclude<PipelineType, "other">;
+export type InferenceTask = Exclude<PipelineType, "other"> | "conversational";
 export declare const INFERENCE_PROVIDERS: readonly ["black-forest-labs", "cerebras", "cohere", "fal-ai", "fireworks-ai", "hf-inference", "hyperbolic", "nebius", "novita", "openai", "replicate", "sambanova", "together"];
 export type InferenceProvider = (typeof INFERENCE_PROVIDERS)[number];
 export interface BaseArgs {
@@ -75,13 +75,6 @@ export type RequestArgs = BaseArgs & ({
 } | ChatCompletionInput) & {
     parameters?: Record<string, unknown>;
 };
-export interface ProviderConfig {
-    makeBaseUrl: ((task?: InferenceTask) => string) | (() => string);
-    makeBody: (params: BodyParams) => Record<string, unknown>;
-    makeHeaders: (params: HeaderParams) => Record<string, string>;
-    makeUrl: (params: UrlParams) => string;
-    clientSideRoutingOnly?: boolean;
-}
 export type AuthMethod = "none" | "hf-token" | "credentials-include" | "provider-key";
 export interface HeaderParams {
     accessToken?: string;
@@ -89,14 +82,11 @@ export interface HeaderParams {
 }
 export interface UrlParams {
     authMethod: AuthMethod;
-    baseUrl: string;
     model: string;
     task?: InferenceTask;
-    chatCompletion?: boolean;
 }
-export interface BodyParams {
-    args: Record<string, unknown>;
-    chatCompletion?: boolean;
+export interface BodyParams<T extends Record<string, unknown> = Record<string, unknown>> {
+    args: T;
     model: string;
     task?: InferenceTask;
 }

package/dist/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAEtC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;AAE3D,eAAO,MAAM,mBAAmB,kLActB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAErE,MAAM,WAAW,QAAQ;IACxB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAC;CAC7B;AAED,MAAM,MAAM,WAAW,GAAG,QAAQ,GACjC,CACG;IAAE,IAAI,EAAE,IAAI,GAAG,WAAW,CAAA;CAAE,GAC5B;IAAE,MAAM,EAAE,OAAO,CAAA;CAAE,GACnB;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GACrB,mBAAmB,CACrB,GAAG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACrC,CAAC;AAEH,MAAM,WAAW,cAAc;IAC9B,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,aAAa,KAAK,MAAM,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IACjE,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1D,WAAW,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9D,OAAO,EAAE,CAAC,MAAM,EAAE,SAAS,KAAK,MAAM,CAAC;IACvC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,UAAU,GAAG,qBAAqB,GAAG,cAAc,CAAC;AAEtF,MAAM,WAAW,YAAY;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,UAAU,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACzB,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,aAAa,CAAC;CACrB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAEtC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,GAAG,gBAAgB,CAAC;AAE9E,eAAO,MAAM,mBAAmB,kLActB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAErE,MAAM,WAAW,QAAQ;IACxB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAC;CAC7B;AAED,MAAM,MAAM,WAAW,GAAG,QAAQ,GACjC,CACG;IAAE,IAAI,EAAE,IAAI,GAAG,WAAW,CAAA;CAAE,GAC5B;IAAE,MAAM,EAAE,OAAO,CAAA;CAAE,GACnB;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GACrB,mBAAmB,CACrB,GAAG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACrC,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,UAAU,GAAG,qBAAqB,GAAG,cAAc,CAAC;AAEtF,MAAM,WAAW,YAAY;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,UAAU,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACzB,UAAU,EAAE,UAAU,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACtF,IAAI,EAAE,CAAC,CAAC;IACR,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,aAAa,CAAC;CACrB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@huggingface/inference",
-  "version": "3.7.0",
+  "version": "3.7.1",
   "packageManager": "pnpm@8.10.5",
   "license": "MIT",
   "author": "Hugging Face and Tim Mikeladze <tim.mikeladze@gmail.com>",
@@ -40,8 +40,8 @@
   },
   "type": "module",
   "dependencies": {
-    "@huggingface/tasks": "^0.18.6",
-    "@huggingface/jinja": "^0.3.3"
+    "@huggingface/jinja": "^0.3.3",
+    "@huggingface/tasks": "^0.18.7"
   },
   "devDependencies": {
     "@types/node": "18.13.0"

package/src/lib/getProviderHelper.ts

@@ -0,0 +1,270 @@
+import * as BlackForestLabs from "../providers/black-forest-labs";
+import * as Cerebras from "../providers/cerebras";
+import * as Cohere from "../providers/cohere";
+import * as FalAI from "../providers/fal-ai";
+import * as Fireworks from "../providers/fireworks-ai";
+import * as HFInference from "../providers/hf-inference";
+
+import * as Hyperbolic from "../providers/hyperbolic";
+import * as Nebius from "../providers/nebius";
+import * as Novita from "../providers/novita";
+import * as OpenAI from "../providers/openai";
+import type {
+	AudioClassificationTaskHelper,
+	AudioToAudioTaskHelper,
+	AutomaticSpeechRecognitionTaskHelper,
+	ConversationalTaskHelper,
+	DocumentQuestionAnsweringTaskHelper,
+	FeatureExtractionTaskHelper,
+	FillMaskTaskHelper,
+	ImageClassificationTaskHelper,
+	ImageSegmentationTaskHelper,
+	ImageToImageTaskHelper,
+	ImageToTextTaskHelper,
+	ObjectDetectionTaskHelper,
+	QuestionAnsweringTaskHelper,
+	SentenceSimilarityTaskHelper,
+	SummarizationTaskHelper,
+	TableQuestionAnsweringTaskHelper,
+	TabularClassificationTaskHelper,
+	TabularRegressionTaskHelper,
+	TaskProviderHelper,
+	TextClassificationTaskHelper,
+	TextGenerationTaskHelper,
+	TextToAudioTaskHelper,
+	TextToImageTaskHelper,
+	TextToSpeechTaskHelper,
+	TextToVideoTaskHelper,
+	TokenClassificationTaskHelper,
+	TranslationTaskHelper,
+	VisualQuestionAnsweringTaskHelper,
+	ZeroShotClassificationTaskHelper,
+	ZeroShotImageClassificationTaskHelper,
+} from "../providers/providerHelper";
+import * as Replicate from "../providers/replicate";
+import * as Sambanova from "../providers/sambanova";
+import * as Together from "../providers/together";
+import type { InferenceProvider, InferenceTask } from "../types";
+
+export const PROVIDERS: Record<InferenceProvider, Partial<Record<InferenceTask, TaskProviderHelper>>> = {
+	"black-forest-labs": {
+		"text-to-image": new BlackForestLabs.BlackForestLabsTextToImageTask(),
+	},
+	cerebras: {
+		conversational: new Cerebras.CerebrasConversationalTask(),
+	},
+	cohere: {
+		conversational: new Cohere.CohereConversationalTask(),
+	},
+	"fal-ai": {
+		"text-to-image": new FalAI.FalAITextToImageTask(),
+		"text-to-speech": new FalAI.FalAITextToSpeechTask(),
+		"text-to-video": new FalAI.FalAITextToVideoTask(),
+		"automatic-speech-recognition": new FalAI.FalAIAutomaticSpeechRecognitionTask(),
+	},
+	"hf-inference": {
+		"text-to-image": new HFInference.HFInferenceTextToImageTask(),
+		conversational: new HFInference.HFInferenceConversationalTask(),
+		"text-generation": new HFInference.HFInferenceTextGenerationTask(),
+		"text-classification": new HFInference.HFInferenceTextClassificationTask(),
+		"question-answering": new HFInference.HFInferenceQuestionAnsweringTask(),
+		"audio-classification": new HFInference.HFInferenceAudioClassificationTask(),
+		"automatic-speech-recognition": new HFInference.HFInferenceAutomaticSpeechRecognitionTask(),
+		"fill-mask": new HFInference.HFInferenceFillMaskTask(),
+		"feature-extraction": new HFInference.HFInferenceFeatureExtractionTask(),
+		"image-classification": new HFInference.HFInferenceImageClassificationTask(),
+		"image-segmentation": new HFInference.HFInferenceImageSegmentationTask(),
+		"document-question-answering": new HFInference.HFInferenceDocumentQuestionAnsweringTask(),
+		"image-to-text": new HFInference.HFInferenceImageToTextTask(),
+		"object-detection": new HFInference.HFInferenceObjectDetectionTask(),
+		"audio-to-audio": new HFInference.HFInferenceAudioToAudioTask(),
+		"zero-shot-image-classification": new HFInference.HFInferenceZeroShotImageClassificationTask(),
+		"zero-shot-classification": new HFInference.HFInferenceZeroShotClassificationTask(),
+		"image-to-image": new HFInference.HFInferenceImageToImageTask(),
+		"sentence-similarity": new HFInference.HFInferenceSentenceSimilarityTask(),
+		"table-question-answering": new HFInference.HFInferenceTableQuestionAnsweringTask(),
+		"tabular-classification": new HFInference.HFInferenceTabularClassificationTask(),
+		"text-to-speech": new HFInference.HFInferenceTextToSpeechTask(),
+		"token-classification": new HFInference.HFInferenceTokenClassificationTask(),
+		translation: new HFInference.HFInferenceTranslationTask(),
+		summarization: new HFInference.HFInferenceSummarizationTask(),
+		"visual-question-answering": new HFInference.HFInferenceVisualQuestionAnsweringTask(),
+		"tabular-regression": new HFInference.HFInferenceTabularRegressionTask(),
+		"text-to-audio": new HFInference.HFInferenceTextToAudioTask(),
+	},
+	"fireworks-ai": {
+		conversational: new Fireworks.FireworksConversationalTask(),
+	},
+	hyperbolic: {
+		"text-to-image": new Hyperbolic.HyperbolicTextToImageTask(),
+		conversational: new Hyperbolic.HyperbolicConversationalTask(),
+		"text-generation": new Hyperbolic.HyperbolicTextGenerationTask(),
+	},
+	nebius: {
+		"text-to-image": new Nebius.NebiusTextToImageTask(),
+		conversational: new Nebius.NebiusConversationalTask(),
+		"text-generation": new Nebius.NebiusTextGenerationTask(),
+	},
+	novita: {
+		conversational: new Novita.NovitaConversationalTask(),
+		"text-generation": new Novita.NovitaTextGenerationTask(),
+	},
+	openai: {
+		conversational: new OpenAI.OpenAIConversationalTask(),
+	},
+	replicate: {
+		"text-to-image": new Replicate.ReplicateTextToImageTask(),
+		"text-to-speech": new Replicate.ReplicateTextToSpeechTask(),
+		"text-to-video": new Replicate.ReplicateTextToVideoTask(),
+	},
+	sambanova: {
+		conversational: new Sambanova.SambanovaConversationalTask(),
+	},
+	together: {
+		"text-to-image": new Together.TogetherTextToImageTask(),
+		conversational: new Together.TogetherConversationalTask(),
+		"text-generation": new Together.TogetherTextGenerationTask(),
+	},
+};
+
+/**
+ * Get provider helper instance by name and task
+ */
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "text-to-image"
+): TextToImageTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "conversational"
+): ConversationalTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "text-generation"
+): TextGenerationTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "text-to-speech"
+): TextToSpeechTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "text-to-audio"
+): TextToAudioTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "automatic-speech-recognition"
+): AutomaticSpeechRecognitionTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "text-to-video"
+): TextToVideoTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "text-classification"
+): TextClassificationTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "question-answering"
+): QuestionAnsweringTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "audio-classification"
+): AudioClassificationTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "audio-to-audio"
+): AudioToAudioTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "fill-mask"
+): FillMaskTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "feature-extraction"
+): FeatureExtractionTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "image-classification"
+): ImageClassificationTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "image-segmentation"
+): ImageSegmentationTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "document-question-answering"
+): DocumentQuestionAnsweringTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "image-to-text"
+): ImageToTextTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "object-detection"
+): ObjectDetectionTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "zero-shot-image-classification"
+): ZeroShotImageClassificationTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "zero-shot-classification"
+): ZeroShotClassificationTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "image-to-image"
+): ImageToImageTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "sentence-similarity"
+): SentenceSimilarityTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "table-question-answering"
+): TableQuestionAnsweringTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "tabular-classification"
+): TabularClassificationTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "tabular-regression"
+): TabularRegressionTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "token-classification"
+): TokenClassificationTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "translation"
+): TranslationTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "summarization"
+): SummarizationTaskHelper & TaskProviderHelper;
+export function getProviderHelper(
+	provider: InferenceProvider,
+	task: "visual-question-answering"
+): VisualQuestionAnsweringTaskHelper & TaskProviderHelper;
+export function getProviderHelper(provider: InferenceProvider, task: InferenceTask | undefined): TaskProviderHelper;
+
+export function getProviderHelper(provider: InferenceProvider, task: InferenceTask | undefined): TaskProviderHelper {
+	if (provider === "hf-inference") {
+		if (!task) {
+			return new HFInference.HFInferenceTask();
+		}
+	}
+	if (!task) {
+		throw new Error("you need to provide a task name when using an external provider, e.g. 'text-to-image'");
+	}
+	if (!(provider in PROVIDERS)) {
+		throw new Error(`Provider '${provider}' not supported. Available providers: ${Object.keys(PROVIDERS)}`);
+	}
+	const providerTasks = PROVIDERS[provider];
+	if (!providerTasks || !(task in providerTasks)) {
+		throw new Error(
+			`Task '${task}' not supported for provider '${provider}'. Available tasks: ${Object.keys(providerTasks ?? {})}`
+		);
+	}
+	return providerTasks[task] as TaskProviderHelper;
+}

package/src/lib/makeRequestOptions.ts

@@ -1,23 +1,9 @@
-import { HF_HUB_URL, HF_ROUTER_URL, HF_HEADER_X_BILL_TO } from "../config";
-import { BLACK_FOREST_LABS_CONFIG } from "../providers/black-forest-labs";
-import { CEREBRAS_CONFIG } from "../providers/cerebras";
-import { COHERE_CONFIG } from "../providers/cohere";
-import { FAL_AI_CONFIG } from "../providers/fal-ai";
-import { FIREWORKS_AI_CONFIG } from "../providers/fireworks-ai";
-import { HF_INFERENCE_CONFIG } from "../providers/hf-inference";
-import { HYPERBOLIC_CONFIG } from "../providers/hyperbolic";
-import { NEBIUS_CONFIG } from "../providers/nebius";
-import { NOVITA_CONFIG } from "../providers/novita";
-import { REPLICATE_CONFIG } from "../providers/replicate";
-import { SAMBANOVA_CONFIG } from "../providers/sambanova";
-import { TOGETHER_CONFIG } from "../providers/together";
-import { OPENAI_CONFIG } from "../providers/openai";
-import type { InferenceProvider, InferenceTask, Options, ProviderConfig, RequestArgs } from "../types";
-import { isUrl } from "./isUrl";
-import { version as packageVersion, name as packageName } from "../../package.json";
+import { name as packageName, version as packageVersion } from "../../package.json";
+import { HF_HEADER_X_BILL_TO, HF_HUB_URL } from "../config";
+import type { InferenceTask, Options, RequestArgs } from "../types";
+import { getProviderHelper } from "./getProviderHelper";
 import { getProviderModelId } from "./getProviderModelId";
-
-const HF_HUB_INFERENCE_PROXY_TEMPLATE = `${HF_ROUTER_URL}/{{PROVIDER}}`;
+import { isUrl } from "./isUrl";
 
 /**
  * Lazy-loaded from huggingface.co/api/tasks when needed
@@ -25,25 +11,6 @@ const HF_HUB_INFERENCE_PROXY_TEMPLATE = `${HF_ROUTER_URL}/{{PROVIDER}}`;
  */
 let tasks: Record<string, { models: { id: string }[] }> | null = null;
 
-/**
- * Config to define how to serialize requests for each provider
- */
-const providerConfigs: Record<InferenceProvider, ProviderConfig> = {
-	"black-forest-labs": BLACK_FOREST_LABS_CONFIG,
-	cerebras: CEREBRAS_CONFIG,
-	cohere: COHERE_CONFIG,
-	"fal-ai": FAL_AI_CONFIG,
-	"fireworks-ai": FIREWORKS_AI_CONFIG,
-	"hf-inference": HF_INFERENCE_CONFIG,
-	hyperbolic: HYPERBOLIC_CONFIG,
-	openai: OPENAI_CONFIG,
-	nebius: NEBIUS_CONFIG,
-	novita: NOVITA_CONFIG,
-	replicate: REPLICATE_CONFIG,
-	sambanova: SAMBANOVA_CONFIG,
-	together: TOGETHER_CONFIG,
-};
-
 /**
  * Helper that prepares request arguments.
  * This async version handle the model ID resolution step.
@@ -56,14 +23,11 @@ export async function makeRequestOptions(
 	options?: Options & {
 		/** In most cases (unless we pass a endpointUrl) we know the task */
 		task?: InferenceTask;
-		chatCompletion?: boolean;
 	}
 ): Promise<{ url: string; info: RequestInit }> {
 	const { provider: maybeProvider, model: maybeModel } = args;
 	const provider = maybeProvider ?? "hf-inference";
-	const providerConfig = providerConfigs[provider];
-	const { task, chatCompletion } = options ?? {};
-
+	const { task } = options ?? {};
 	// Validate inputs
 	if (args.endpointUrl && provider !== "hf-inference") {
 		throw new Error(`Cannot use endpointUrl with a third-party provider.`);
@@ -74,21 +38,20 @@ export async function makeRequestOptions(
 	if (!maybeModel && !task) {
 		throw new Error("No model provided, and no task has been specified.");
 	}
-	if (!providerConfig) {
-		throw new Error(`No provider config found for provider ${provider}`);
-	}
-	if (providerConfig.clientSideRoutingOnly && !maybeModel) {
-		throw new Error(`Provider ${provider} requires a model ID to be passed directly.`);
-	}
 
 	// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 	const hfModel = maybeModel ?? (await loadDefaultModel(task!));
-	const resolvedModel = providerConfig.clientSideRoutingOnly
+	const providerHelper = getProviderHelper(provider, task);
+
+	if (providerHelper.clientSideRoutingOnly && !maybeModel) {
+		throw new Error(`Provider ${provider} requires a model ID to be passed directly.`);
+	}
+
+	const resolvedModel = providerHelper.clientSideRoutingOnly
 		? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 		  removeProviderPrefix(maybeModel!, provider)
 		: await getProviderModelId({ model: hfModel, provider }, args, {
 				task,
-				chatCompletion,
 				fetch: options?.fetch,
 		  });
 
@@ -108,19 +71,17 @@ export function makeRequestOptionsFromResolvedModel(
 	},
 	options?: Options & {
 		task?: InferenceTask;
-		chatCompletion?: boolean;
 	}
 ): { url: string; info: RequestInit } {
 	const { accessToken, endpointUrl, provider: maybeProvider, model, ...remainingArgs } = args;
 	void model;
 
 	const provider = maybeProvider ?? "hf-inference";
-	const providerConfig = providerConfigs[provider];
-
-	const { includeCredentials, task, chatCompletion, signal, billTo } = options ?? {};
 
+	const { includeCredentials, task, signal, billTo } = options ?? {};
+	const providerHelper = getProviderHelper(provider, task);
 	const authMethod = (() => {
-		if (providerConfig.clientSideRoutingOnly) {
+		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.`);
@@ -138,36 +99,25 @@ export function makeRequestOptionsFromResolvedModel(
 	})();
 
 	// Make URL
-	const url = endpointUrl
-		? chatCompletion
-			? endpointUrl + `/v1/chat/completions`
-			: endpointUrl
-		: providerConfig.makeUrl({
-				authMethod,
-				baseUrl:
-					authMethod !== "provider-key"
-						? HF_HUB_INFERENCE_PROXY_TEMPLATE.replace("{{PROVIDER}}", provider)
-						: providerConfig.makeBaseUrl(task),
-				model: resolvedModel,
-				chatCompletion,
-				task,
-		  });
 
-	// Make headers
-	const binary = "data" in args && !!args.data;
-	const headers = providerConfig.makeHeaders({
-		accessToken,
+	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[HF_HEADER_X_BILL_TO] = billTo;
 	}
 
-	// Add content-type to headers
-	if (!binary) {
-		headers["Content-Type"] = "application/json";
-	}
-
 	// Add user-agent to headers
 	// e.g. @huggingface/inference/3.1.3
 	const ownUserAgent = `${packageName}/${packageVersion}`;
@@ -177,17 +127,11 @@ export function makeRequestOptionsFromResolvedModel(
 	headers["User-Agent"] = userAgent;
 
 	// Make body
-	const body = binary
-		? args.data
-		: JSON.stringify(
-				providerConfig.makeBody({
-					args: remainingArgs as Record<string, unknown>,
-					model: resolvedModel,
-					task,
-					chatCompletion,
-				})
-		  );
-
+	const body = providerHelper.makeBody({
+		args: remainingArgs as Record<string, unknown>,
+		model: resolvedModel,
+		task,
+	});
 	/**
 	 * For edge runtimes, leave 'credentials' undefined, otherwise cloudflare workers will error
 	 */
@@ -201,11 +145,10 @@ export function makeRequestOptionsFromResolvedModel(
 	const info: RequestInit = {
 		headers,
 		method: "POST",
-		body,
+		body: body,
 		...(credentials ? { credentials } : undefined),
 		signal,
 	};
-
 	return { url, info };
 }
 

package/src/providers/black-forest-labs.ts

@@ -14,33 +14,84 @@
  *
  * Thanks!
  */
-import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
+import { InferenceOutputError } from "../lib/InferenceOutputError";
+import type { BodyParams, HeaderParams, UrlParams } from "../types";
+import { delay } from "../utils/delay";
+import { omit } from "../utils/omit";
+import { TaskProviderHelper, type TextToImageTaskHelper } from "./providerHelper";
 
 const BLACK_FOREST_LABS_AI_API_BASE_URL = "https://api.us1.bfl.ai";
+interface BlackForestLabsResponse {
+	id: string;
+	polling_url: string;
+}
 
-const makeBaseUrl = (): string => {
-	return BLACK_FOREST_LABS_AI_API_BASE_URL;
-};
+export class BlackForestLabsTextToImageTask extends TaskProviderHelper implements TextToImageTaskHelper {
+	constructor() {
+		super("black-forest-labs", BLACK_FOREST_LABS_AI_API_BASE_URL);
+	}
 
-const makeBody = (params: BodyParams): Record<string, unknown> => {
-	return params.args;
-};
+	preparePayload(params: BodyParams): Record<string, unknown> {
+		return {
+			...omit(params.args, ["inputs", "parameters"]),
+			...(params.args.parameters as Record<string, unknown>),
+			prompt: params.args.inputs,
+		};
+	}
 
-const makeHeaders = (params: HeaderParams): Record<string, string> => {
-	if (params.authMethod === "provider-key") {
-		return { "X-Key": `${params.accessToken}` };
-	} else {
-		return { Authorization: `Bearer ${params.accessToken}` };
+	override prepareHeaders(params: HeaderParams, binary: boolean): Record<string, string> {
+		const headers: Record<string, string> = {
+			Authorization:
+				params.authMethod !== "provider-key" ? `Bearer ${params.accessToken}` : `X-Key ${params.accessToken}`,
+		};
+		if (!binary) {
+			headers["Content-Type"] = "application/json";
+		}
+		return headers;
 	}
-};
 
-const makeUrl = (params: UrlParams): string => {
-	return `${params.baseUrl}/v1/${params.model}`;
-};
+	makeRoute(params: UrlParams): string {
+		if (!params) {
+			throw new Error("Params are required");
+		}
+		return `/v1/${params.model}`;
+	}
 
-export const BLACK_FOREST_LABS_CONFIG: ProviderConfig = {
-	makeBaseUrl,
-	makeBody,
-	makeHeaders,
-	makeUrl,
-};
+	async getResponse(
+		response: BlackForestLabsResponse,
+		url?: string,
+		headers?: HeadersInit,
+		outputType?: "url" | "blob"
+	): Promise<string | Blob> {
+		const urlObj = new URL(response.polling_url);
+		for (let step = 0; step < 5; step++) {
+			await 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("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("Failed to fetch result from black forest labs API");
+	}
+}