@huggingface/inference 4.13.9 → 4.13.11

package/src/lib/getInferenceProviderMapping.ts

@@ -28,7 +28,7 @@ function normalizeInferenceProviderMapping(
 					adapter?: string;
 					adapterWeightsPath?: string;
 				}
-		  >
+		  >,
 ): InferenceProviderMappingEntry[] {
 	if (!inferenceProviderMapping) {
 		return [];
@@ -56,7 +56,7 @@ export async function fetchInferenceProviderMappingForModel(
 	accessToken?: string,
 	options?: {
 		fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
-	}
+	},
 ): Promise<InferenceProviderMappingEntry[]> {
 	let inferenceProviderMapping: InferenceProviderMappingEntry[] | null;
 	if (inferenceProviderMappingCache.has(modelId)) {
@@ -74,14 +74,14 @@ export async function fetchInferenceProviderMappingForModel(
 					throw new InferenceClientHubApiError(
 						`Failed to fetch inference provider mapping for model ${modelId}: ${error.error}`,
 						{ url, method: "GET" },
-						{ requestId: resp.headers.get("x-request-id") ?? "", status: resp.status, body: error }
+						{ requestId: resp.headers.get("x-request-id") ?? "", status: resp.status, body: error },
 					);
 				}
 			} else {
 				throw new InferenceClientHubApiError(
 					`Failed to fetch inference provider mapping for model ${modelId}`,
 					{ url, method: "GET" },
-					{ requestId: resp.headers.get("x-request-id") ?? "", status: resp.status, body: await resp.text() }
+					{ requestId: resp.headers.get("x-request-id") ?? "", status: resp.status, body: await resp.text() },
 				);
 			}
 		}
@@ -96,14 +96,14 @@ export async function fetchInferenceProviderMappingForModel(
 			throw new InferenceClientHubApiError(
 				`Failed to fetch inference provider mapping for model ${modelId}: malformed API response, invalid JSON`,
 				{ url, method: "GET" },
-				{ requestId: resp.headers.get("x-request-id") ?? "", status: resp.status, body: await resp.text() }
+				{ requestId: resp.headers.get("x-request-id") ?? "", status: resp.status, body: await resp.text() },
 			);
 		}
 		if (!payload?.inferenceProviderMapping) {
 			throw new InferenceClientHubApiError(
 				`We have not been able to find inference provider information for model ${modelId}.`,
 				{ url, method: "GET" },
-				{ requestId: resp.headers.get("x-request-id") ?? "", status: resp.status, body: await resp.text() }
+				{ requestId: resp.headers.get("x-request-id") ?? "", status: resp.status, body: await resp.text() },
 			);
 		}
 		inferenceProviderMapping = normalizeInferenceProviderMapping(modelId, payload.inferenceProviderMapping);
@@ -121,7 +121,7 @@ export async function getInferenceProviderMapping(
 	},
 	options: {
 		fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
-	}
+	},
 ): Promise<InferenceProviderMappingEntry | null> {
 	const logger = getLogger();
 	if (params.provider === ("auto" as InferenceProvider) && params.task === "conversational") {
@@ -147,12 +147,12 @@ export async function getInferenceProviderMapping(
 				: [params.task];
 		if (!typedInclude(equivalentTasks, providerMapping.task)) {
 			throw new InferenceClientInputError(
-				`Model ${params.modelId} is not supported for task ${params.task} and provider ${params.provider}. Supported task: ${providerMapping.task}.`
+				`Model ${params.modelId} is not supported for task ${params.task} and provider ${params.provider}. Supported task: ${providerMapping.task}.`,
 			);
 		}
 		if (providerMapping.status === "staging") {
 			logger.warn(
-				`Model ${params.modelId} is in staging mode for provider ${params.provider}. Meant for test purposes only.`
+				`Model ${params.modelId} is in staging mode for provider ${params.provider}. Meant for test purposes only.`,
 			);
 		}
 		return providerMapping;
@@ -163,7 +163,7 @@ export async function getInferenceProviderMapping(
 export async function resolveProvider(
 	provider?: InferenceProviderOrPolicy,
 	modelId?: string,
-	endpointUrl?: string
+	endpointUrl?: string,
 ): Promise<InferenceProvider> {
 	const logger = getLogger();
 	if (endpointUrl) {
@@ -175,7 +175,7 @@ export async function resolveProvider(
 	}
 	if (!provider) {
 		logger.log(
-			"Defaulting to 'auto' which will select the first provider available for the model, sorted by the user's order in https://hf.co/settings/inference-providers."
+			"Defaulting to 'auto' which will select the first provider available for the model, sorted by the user's order in https://hf.co/settings/inference-providers.",
 		);
 		provider = "auto";
 	}

package/src/lib/getProviderHelper.ts

@@ -76,13 +76,15 @@ export const PROVIDERS: Record<InferenceProvider, Partial<Record<InferenceTask,
 		conversational: new Cohere.CohereConversationalTask(),
 	},
 	"fal-ai": {
-		"text-to-image": new FalAI.FalAITextToImageTask(),
-		"text-to-speech": new FalAI.FalAITextToSpeechTask(),
-		"text-to-video": new FalAI.FalAITextToVideoTask(),
-		"image-to-image": new FalAI.FalAIImageToImageTask(),
 		"automatic-speech-recognition": new FalAI.FalAIAutomaticSpeechRecognitionTask(),
+		"image-text-to-image": new FalAI.FalAIImageTextToImageTask(),
+		"image-text-to-video": new FalAI.FalAIImageTextToVideoTask(),
+		"image-to-image": new FalAI.FalAIImageToImageTask(),
 		"image-segmentation": new FalAI.FalAIImageSegmentationTask(),
 		"image-to-video": new FalAI.FalAIImageToVideoTask(),
+		"text-to-image": new FalAI.FalAITextToImageTask(),
+		"text-to-speech": new FalAI.FalAITextToSpeechTask(),
+		"text-to-video": new FalAI.FalAITextToVideoTask(),
 	},
 	"featherless-ai": {
 		conversational: new FeatherlessAI.FeatherlessAIConversationalTask(),
@@ -181,6 +183,8 @@ export const PROVIDERS: Record<InferenceProvider, Partial<Record<InferenceTask,
 		"text-to-video": new Wavespeed.WavespeedAITextToVideoTask(),
 		"image-to-image": new Wavespeed.WavespeedAIImageToImageTask(),
 		"image-to-video": new Wavespeed.WavespeedAIImageToVideoTask(),
+		"image-text-to-image": new Wavespeed.WavespeedAIImageTextToImageTask(),
+		"image-text-to-video": new Wavespeed.WavespeedAIImageTextToVideoTask(),
 	},
 	"zai-org": {
 		conversational: new Zai.ZaiConversationalTask(),
@@ -193,157 +197,157 @@ export const PROVIDERS: Record<InferenceProvider, Partial<Record<InferenceTask,
  */
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "text-to-image"
+	task: "text-to-image",
 ): TextToImageTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "conversational"
+	task: "conversational",
 ): ConversationalTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "text-generation"
+	task: "text-generation",
 ): TextGenerationTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "text-to-speech"
+	task: "text-to-speech",
 ): TextToSpeechTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "text-to-audio"
+	task: "text-to-audio",
 ): TextToAudioTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "automatic-speech-recognition"
+	task: "automatic-speech-recognition",
 ): AutomaticSpeechRecognitionTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "text-to-video"
+	task: "text-to-video",
 ): TextToVideoTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "text-classification"
+	task: "text-classification",
 ): TextClassificationTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "question-answering"
+	task: "question-answering",
 ): QuestionAnsweringTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "audio-classification"
+	task: "audio-classification",
 ): AudioClassificationTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "audio-to-audio"
+	task: "audio-to-audio",
 ): AudioToAudioTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "fill-mask"
+	task: "fill-mask",
 ): FillMaskTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "feature-extraction"
+	task: "feature-extraction",
 ): FeatureExtractionTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "image-classification"
+	task: "image-classification",
 ): ImageClassificationTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "image-segmentation"
+	task: "image-segmentation",
 ): ImageSegmentationTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "document-question-answering"
+	task: "document-question-answering",
 ): DocumentQuestionAnsweringTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "image-to-text"
+	task: "image-to-text",
 ): ImageToTextTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "object-detection"
+	task: "object-detection",
 ): ObjectDetectionTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "zero-shot-image-classification"
+	task: "zero-shot-image-classification",
 ): ZeroShotImageClassificationTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "zero-shot-classification"
+	task: "zero-shot-classification",
 ): ZeroShotClassificationTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "image-to-image"
+	task: "image-to-image",
 ): ImageToImageTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "image-to-video"
+	task: "image-to-video",
 ): ImageToVideoTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "image-text-to-image"
+	task: "image-text-to-image",
 ): ImageTextToImageTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "image-text-to-video"
+	task: "image-text-to-video",
 ): ImageTextToVideoTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "sentence-similarity"
+	task: "sentence-similarity",
 ): SentenceSimilarityTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "table-question-answering"
+	task: "table-question-answering",
 ): TableQuestionAnsweringTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "tabular-classification"
+	task: "tabular-classification",
 ): TabularClassificationTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "tabular-regression"
+	task: "tabular-regression",
 ): TabularRegressionTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "token-classification"
+	task: "token-classification",
 ): TokenClassificationTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "translation"
+	task: "translation",
 ): TranslationTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "summarization"
+	task: "summarization",
 ): SummarizationTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: "visual-question-answering"
+	task: "visual-question-answering",
 ): VisualQuestionAnsweringTaskHelper & TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: InferenceTask | undefined
+	task: InferenceTask | undefined,
 ): TaskProviderHelper;
 export function getProviderHelper(
 	provider: InferenceProviderOrPolicy,
-	task: InferenceTask | undefined
+	task: InferenceTask | undefined,
 ): TaskProviderHelper {
 	if ((provider === "hf-inference" && !task) || provider === "auto") {
 		return new HFInference.HFInferenceTask();
 	}
 	if (!task) {
 		throw new InferenceClientInputError(
-			"you need to provide a task name when using an external provider, e.g. 'text-to-image'"
+			"you need to provide a task name when using an external provider, e.g. 'text-to-image'",
 		);
 	}
 	if (!(provider in PROVIDERS)) {
 		throw new InferenceClientInputError(
-			`Provider '${provider}' not supported. Available providers: ${Object.keys(PROVIDERS)}`
+			`Provider '${provider}' not supported. Available providers: ${Object.keys(PROVIDERS)}`,
 		);
 	}
 	const providerTasks = PROVIDERS[provider];
 	if (!providerTasks || !(task in providerTasks)) {
 		throw new InferenceClientInputError(
-			`Task '${task}' not supported for provider '${provider}'. Available tasks: ${Object.keys(providerTasks ?? {})}`
+			`Task '${task}' not supported for provider '${provider}'. Available tasks: ${Object.keys(providerTasks ?? {})}`,
 		);
 	}
 	return providerTasks[task] as TaskProviderHelper;

package/src/lib/makeRequestOptions.ts

@@ -1,6 +1,6 @@
 import { HF_HEADER_X_BILL_TO, HF_HUB_URL } from "../config.js";
 import { PACKAGE_NAME, PACKAGE_VERSION } from "../package.js";
-import type { InferenceTask, InferenceProviderMappingEntry, Options, RequestArgs } from "../types.js";
+import type { InferenceTask, InferenceProviderMappingEntry, Options, OutputType, RequestArgs } from "../types.js";
 import { getInferenceProviderMapping } from "./getInferenceProviderMapping.js";
 import type { getProviderHelper } from "./getProviderHelper.js";
 import { isUrl } from "./isUrl.js";
@@ -25,7 +25,7 @@ export async function makeRequestOptions(
 	options?: Options & {
 		/** In most cases (unless we pass a endpointUrl) we know the task */
 		task?: InferenceTask;
-	}
+	},
 ): Promise<{ url: string; info: RequestInit }> {
 	const { model: maybeModel } = args;
 	const provider = providerHelper.provider;
@@ -46,7 +46,7 @@ export async function makeRequestOptions(
 			providerHelper,
 			args,
 			undefined,
-			options
+			options,
 		);
 	}
 
@@ -71,7 +71,7 @@ export async function makeRequestOptions(
 				status: "live",
 				// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 				task: task!,
-		  } satisfies InferenceProviderMappingEntry)
+			} satisfies InferenceProviderMappingEntry)
 		: await getInferenceProviderMapping(
 				{
 					modelId: hfModel,
@@ -80,11 +80,11 @@ export async function makeRequestOptions(
 					provider,
 					accessToken: args.accessToken,
 				},
-				{ fetch: options?.fetch }
-		  );
+				{ fetch: options?.fetch },
+			);
 	if (!inferenceProviderMapping) {
 		throw new InferenceClientInputError(
-			`We have not been able to find inference provider information for model ${hfModel}.`
+			`We have not been able to find inference provider information for model ${hfModel}.`,
 		);
 	}
 
@@ -94,7 +94,7 @@ export async function makeRequestOptions(
 		providerHelper,
 		args,
 		inferenceProviderMapping,
-		options
+		options,
 	);
 }
 
@@ -112,15 +112,16 @@ export function makeRequestOptionsFromResolvedModel(
 	mapping: InferenceProviderMappingEntry | undefined,
 	options?: Options & {
 		task?: InferenceTask;
-	}
+		outputType?: OutputType;
+	},
 ): { url: string; info: RequestInit } {
-	const { accessToken, endpointUrl, provider: maybeProvider, model, ...remainingArgs } = args;
+	const { accessToken, endpointUrl, provider: maybeProvider, model, urlTransform, ...remainingArgs } = args;
 	void model;
 	void maybeProvider;
 
 	const provider = providerHelper.provider;
 
-	const { includeCredentials, task, signal, billTo } = options ?? {};
+	const { includeCredentials, task, signal, billTo, outputType } = options ?? {};
 	const authMethod = (() => {
 		if (providerHelper.clientSideRoutingOnly) {
 			// Closed-source providers require an accessToken (cannot be routed).
@@ -145,6 +146,7 @@ export function makeRequestOptionsFromResolvedModel(
 		authMethod,
 		model: modelId,
 		task,
+		urlTransform,
 	});
 	// Make headers
 	const headers = providerHelper.prepareHeaders(
@@ -152,7 +154,7 @@ export function makeRequestOptionsFromResolvedModel(
 			accessToken,
 			authMethod,
 		},
-		"data" in args && !!args.data
+		"data" in args && !!args.data,
 	);
 	if (billTo) {
 		headers[HF_HEADER_X_BILL_TO] = billTo;
@@ -172,6 +174,7 @@ export function makeRequestOptionsFromResolvedModel(
 		model: resolvedModel,
 		task,
 		mapping,
+		outputType,
 	});
 	/**
 	 * For edge runtimes, leave 'credentials' undefined, otherwise cloudflare workers will error
@@ -200,7 +203,7 @@ async function loadDefaultModel(task: InferenceTask): Promise<string> {
 	const taskInfo = tasks[task];
 	if ((taskInfo?.models.length ?? 0) <= 0) {
 		throw new InferenceClientInputError(
-			`No default model defined for task ${task}, please define the model explicitly.`
+			`No default model defined for task ${task}, please define the model explicitly.`,
 		);
 	}
 	return taskInfo.models[0].id;
@@ -214,7 +217,7 @@ async function loadTaskInfo(): Promise<Record<string, { models: { id: string }[]
 		throw new InferenceClientHubApiError(
 			"Failed to load tasks definitions from Hugging Face Hub.",
 			{ url, method: "GET" },
-			{ requestId: res.headers.get("x-request-id") ?? "", status: res.status, body: await res.text() }
+			{ requestId: res.headers.get("x-request-id") ?? "", status: res.status, body: await res.text() },
 		);
 	}
 	return await res.json();

package/src/package.ts

@@ -1,3 +1,3 @@
 // Generated file from package.json. Issues importing JSON directly when publishing on commonjs/ESM - see https://github.com/microsoft/TypeScript/issues/51783
-export const PACKAGE_VERSION = "4.13.9";
+export const PACKAGE_VERSION = "4.13.11";
 export const PACKAGE_NAME = "@huggingface/inference";

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

@@ -66,7 +66,7 @@ export class BlackForestLabsTextToImageTask extends TaskProviderHelper implement
 		response: BlackForestLabsResponse,
 		url?: string,
 		headers?: HeadersInit,
-		outputType?: "url" | "blob" | "json"
+		outputType?: "url" | "blob" | "json",
 	): Promise<string | Blob | Record<string, unknown>> {
 		const logger = getLogger();
 		const urlObj = new URL(response.polling_url);
@@ -79,7 +79,7 @@ export class BlackForestLabsTextToImageTask extends TaskProviderHelper implement
 				throw new InferenceClientProviderApiError(
 					"Failed to fetch result from black forest labs API",
 					{ url: urlObj.toString(), method: "GET", headers: { "Content-Type": "application/json" } },
-					{ requestId: resp.headers.get("x-request-id") ?? "", status: resp.status, body: await resp.text() }
+					{ requestId: resp.headers.get("x-request-id") ?? "", status: resp.status, body: await resp.text() },
 				);
 			}
 			const payload = await resp.json();
@@ -106,7 +106,7 @@ export class BlackForestLabsTextToImageTask extends TaskProviderHelper implement
 			}
 		}
 		throw new InferenceClientProviderOutputError(
-			`Timed out while waiting for the result from black forest labs API - aborting after 5 attempts`
+			`Timed out while waiting for the result from black forest labs API - aborting after 5 attempts`,
 		);
 	}
 }