@huggingface/inference 4.3.2 → 4.5.0

package/dist/esm/tasks/custom/request.js

@@ -1,12 +1,14 @@
 import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
 import { getProviderHelper } from "../../lib/getProviderHelper.js";
 import { innerRequest } from "../../utils/request.js";
+import { getLogger } from "../../lib/logger.js";
 /**
  * Primitive to make custom calls to the inference provider
  * @deprecated Use specific task functions instead. This function will be removed in a future version.
  */
 export async function request(args, options) {
-    console.warn("The request method is deprecated and will be removed in a future version of huggingface.js. Use specific task functions instead.");
+    const logger = getLogger();
+    logger.warn("The request method is deprecated and will be removed in a future version of huggingface.js. Use specific task functions instead.");
     const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
     const providerHelper = getProviderHelper(provider, options?.task);
     const result = await innerRequest(args, providerHelper, options);

package/dist/esm/tasks/custom/streamingRequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"streamingRequest.d.ts","sourceRoot":"","sources":["../../../../src/tasks/custom/streamingRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG1E;;;GAGG;AACH,wBAAuB,gBAAgB,CAAC,CAAC,EACxC,IAAI,EAAE,WAAW,EACjB,OAAO,CAAC,EAAE,OAAO,GAAG;IACnB,oEAAoE;IACpE,IAAI,CAAC,EAAE,aAAa,CAAC;CACrB,GACC,cAAc,CAAC,CAAC,CAAC,CAOnB"}
+{"version":3,"file":"streamingRequest.d.ts","sourceRoot":"","sources":["../../../../src/tasks/custom/streamingRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAI1E;;;GAGG;AACH,wBAAuB,gBAAgB,CAAC,CAAC,EACxC,IAAI,EAAE,WAAW,EACjB,OAAO,CAAC,EAAE,OAAO,GAAG;IACnB,oEAAoE;IACpE,IAAI,CAAC,EAAE,aAAa,CAAC;CACrB,GACC,cAAc,CAAC,CAAC,CAAC,CAQnB"}

package/dist/esm/tasks/custom/streamingRequest.js

@@ -1,12 +1,14 @@
 import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
 import { getProviderHelper } from "../../lib/getProviderHelper.js";
 import { innerStreamingRequest } from "../../utils/request.js";
+import { getLogger } from "../../lib/logger.js";
 /**
  * Primitive to make custom inference calls that expect server-sent events, and returns the response through a generator
  * @deprecated Use specific task functions instead. This function will be removed in a future version.
  */
 export async function* streamingRequest(args, options) {
-    console.warn("The streamingRequest method is deprecated and will be removed in a future version of huggingface.js. Use specific task functions instead.");
+    const logger = getLogger();
+    logger.warn("The streamingRequest method is deprecated and will be removed in a future version of huggingface.js. Use specific task functions instead.");
     const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
     const providerHelper = getProviderHelper(provider, options?.task);
     yield* innerStreamingRequest(args, providerHelper, options);

package/dist/esm/tasks/cv/imageSegmentation.d.ts

@@ -1,7 +1,6 @@
 import type { ImageSegmentationInput, ImageSegmentationOutput } from "@huggingface/tasks";
 import type { BaseArgs, Options } from "../../types.js";
-import { type LegacyImageInput } from "./utils.js";
-export type ImageSegmentationArgs = BaseArgs & (ImageSegmentationInput | LegacyImageInput);
+export type ImageSegmentationArgs = BaseArgs & ImageSegmentationInput;
 /**
  * This task reads some image input and outputs the likelihood of classes & bounding boxes of detected objects.
  * Recommended model: facebook/detr-resnet-50-panoptic

package/dist/esm/tasks/cv/imageSegmentation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"imageSegmentation.d.ts","sourceRoot":"","sources":["../../../../src/tasks/cv/imageSegmentation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAG1F,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAExD,OAAO,EAAkB,KAAK,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnE,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,CAAC,sBAAsB,GAAG,gBAAgB,CAAC,CAAC;AAE3F;;;GAGG;AACH,wBAAsB,iBAAiB,CACtC,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,uBAAuB,CAAC,CASlC"}
+{"version":3,"file":"imageSegmentation.d.ts","sourceRoot":"","sources":["../../../../src/tasks/cv/imageSegmentation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAG1F,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAIxD,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,sBAAsB,CAAC;AAEtE;;;GAGG;AACH,wBAAsB,iBAAiB,CACtC,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,uBAAuB,CAAC,CAUlC"}

package/dist/esm/tasks/cv/imageSegmentation.js

@@ -1,7 +1,7 @@
 import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
 import { getProviderHelper } from "../../lib/getProviderHelper.js";
 import { innerRequest } from "../../utils/request.js";
-import { preparePayload } from "./utils.js";
+import { makeRequestOptions } from "../../lib/makeRequestOptions.js";
 /**
  * This task reads some image input and outputs the likelihood of classes & bounding boxes of detected objects.
  * Recommended model: facebook/detr-resnet-50-panoptic
@@ -9,10 +9,11 @@ import { preparePayload } from "./utils.js";
 export async function imageSegmentation(args, options) {
     const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
     const providerHelper = getProviderHelper(provider, "image-segmentation");
-    const payload = preparePayload(args);
+    const payload = await providerHelper.preparePayloadAsync(args);
     const { data: res } = await innerRequest(payload, providerHelper, {
         ...options,
         task: "image-segmentation",
     });
-    return providerHelper.getResponse(res);
+    const { url, info } = await makeRequestOptions(args, providerHelper, { ...options, task: "image-segmentation" });
+    return providerHelper.getResponse(res, url, info.headers);
 }

package/dist/esm/types.d.ts

@@ -3,6 +3,13 @@ import type { ChatCompletionInput, PipelineType, WidgetType } from "@huggingface
  * HF model id, like "meta-llama/Llama-3.3-70B-Instruct"
  */
 export type ModelId = string;
+export interface Logger {
+    debug: (message: string, ...args: unknown[]) => void;
+    info: (message: string, ...args: unknown[]) => void;
+    warn: (message: string, ...args: unknown[]) => void;
+    error: (message: string, ...args: unknown[]) => void;
+    log: (message: string, ...args: unknown[]) => void;
+}
 export interface Options {
     /**
      * (Default: true) Boolean. If a request 503s, the request will be retried with the same parameters.

package/dist/esm/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,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAExF;;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,kOAkBtB,CAAC;AAEX,eAAO,MAAM,qBAAqB,0OAA4C,CAAC;AAE/E,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAErE,MAAM,MAAM,yBAAyB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/E,MAAM,WAAW,6BAA6B;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,CAAC,EAAE,cAAc,GAAG,YAAY,CAAC;CACrC;AAED,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,yBAAyB,CAAC;CACrC;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,OAAO,CAAC,EAAE,6BAA6B,GAAG,SAAS,CAAC;IACpD,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,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAExF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B,MAAM,WAAW,MAAM;IACtB,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACrD,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACpD,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACpD,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACrD,GAAG,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;CACnD;AAED,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,kOAkBtB,CAAC;AAEX,eAAO,MAAM,qBAAqB,0OAA4C,CAAC;AAE/E,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAErE,MAAM,MAAM,yBAAyB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/E,MAAM,WAAW,6BAA6B;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,CAAC,EAAE,cAAc,GAAG,YAAY,CAAC;CACrC;AAED,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,yBAAyB,CAAC;CACrC;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,OAAO,CAAC,EAAE,6BAA6B,GAAG,SAAS,CAAC;IACpD,IAAI,CAAC,EAAE,aAAa,CAAC;CACrB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@huggingface/inference",
-  "version": "4.3.2",
+  "version": "4.5.0",
   "license": "MIT",
   "author": "Hugging Face and Tim Mikeladze <tim.mikeladze@gmail.com>",
   "description": "Typescript client for the Hugging Face Inference Providers and Inference Endpoints",
@@ -40,8 +40,8 @@
   },
   "type": "module",
   "dependencies": {
-    "@huggingface/tasks": "^0.19.22",
-    "@huggingface/jinja": "^0.5.0"
+    "@huggingface/tasks": "^0.19.23",
+    "@huggingface/jinja": "^0.5.1"
   },
   "devDependencies": {
     "@types/node": "18.13.0"

package/src/index.ts

@@ -5,5 +5,6 @@ export * from "./tasks/index.js";
 import * as snippets from "./snippets/index.js";
 export * from "./lib/getProviderHelper.js";
 export * from "./lib/makeRequestOptions.js";
+export { setLogger } from "./lib/logger.js";
 
 export { snippets };

package/src/lib/getInferenceProviderMapping.ts

@@ -5,6 +5,7 @@ import { EQUIVALENT_SENTENCE_TRANSFORMERS_TASKS } from "../providers/hf-inferenc
 import type { InferenceProvider, InferenceProviderMappingEntry, InferenceProviderOrPolicy, ModelId } from "../types.js";
 import { typedInclude } from "../utils/typedInclude.js";
 import { InferenceClientHubApiError, InferenceClientInputError } from "../errors.js";
+import { getLogger } from "./logger.js";
 
 export const inferenceProviderMappingCache = new Map<ModelId, InferenceProviderMappingEntry[]>();
 
@@ -122,6 +123,7 @@ export async function getInferenceProviderMapping(
 		fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
 	}
 ): Promise<InferenceProviderMappingEntry | null> {
+	const logger = getLogger();
 	if (HARDCODED_MODEL_INFERENCE_MAPPING[params.provider][params.modelId]) {
 		return HARDCODED_MODEL_INFERENCE_MAPPING[params.provider][params.modelId];
 	}
@@ -138,7 +140,7 @@ export async function getInferenceProviderMapping(
 			);
 		}
 		if (providerMapping.status === "staging") {
-			console.warn(
+			logger.warn(
 				`Model ${params.modelId} is in staging mode for provider ${params.provider}. Meant for test purposes only.`
 			);
 		}
@@ -152,6 +154,7 @@ export async function resolveProvider(
 	modelId?: string,
 	endpointUrl?: string
 ): Promise<InferenceProvider> {
+	const logger = getLogger();
 	if (endpointUrl) {
 		if (provider) {
 			throw new InferenceClientInputError("Specifying both endpointUrl and provider is not supported.");
@@ -160,7 +163,7 @@ export async function resolveProvider(
 		return "hf-inference";
 	}
 	if (!provider) {
-		console.log(
+		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."
 		);
 		provider = "auto";
@@ -171,7 +174,7 @@ export async function resolveProvider(
 		}
 		const mappings = await fetchInferenceProviderMappingForModel(modelId);
 		provider = mappings[0]?.provider as InferenceProvider | undefined;
-		console.log("Auto selected provider:", provider);
+		logger.log("Auto selected provider:", provider);
 	}
 	if (!provider) {
 		throw new InferenceClientInputError(`No Inference Provider available for model ${modelId}.`);

package/src/lib/getProviderHelper.ts

@@ -67,6 +67,7 @@ export const PROVIDERS: Record<InferenceProvider, Partial<Record<InferenceTask,
 		"text-to-video": new FalAI.FalAITextToVideoTask(),
 		"image-to-image": new FalAI.FalAIImageToImageTask(),
 		"automatic-speech-recognition": new FalAI.FalAIAutomaticSpeechRecognitionTask(),
+		"image-segmentation": new FalAI.FalAIImageSegmentationTask(),
 	},
 	"featherless-ai": {
 		conversational: new FeatherlessAI.FeatherlessAIConversationalTask(),

package/src/lib/logger.ts

@@ -0,0 +1,11 @@
+import type { Logger } from "../types.js";
+
+let globalLogger: Logger = console;
+
+export function setLogger(logger: Logger): void {
+	globalLogger = logger;
+}
+
+export function getLogger(): Logger {
+	return globalLogger;
+}

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.3.2";
+export const PACKAGE_VERSION = "4.5.0";
 export const PACKAGE_NAME = "@huggingface/inference";

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

@@ -19,6 +19,7 @@ import {
 	InferenceClientProviderApiError,
 	InferenceClientProviderOutputError,
 } from "../errors.js";
+import { getLogger } from "../lib/logger.js";
 import type { BodyParams, HeaderParams, UrlParams } from "../types.js";
 import { delay } from "../utils/delay.js";
 import { omit } from "../utils/omit.js";
@@ -67,10 +68,11 @@ export class BlackForestLabsTextToImageTask extends TaskProviderHelper implement
 		headers?: HeadersInit,
 		outputType?: "url" | "blob"
 	): Promise<string | Blob> {
+		const logger = getLogger();
 		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`);
+			logger.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) {

package/src/providers/fal-ai.ts

@@ -16,12 +16,12 @@
  */
 import { base64FromBytes } from "../utils/base64FromBytes.js";
 
-import type { AutomaticSpeechRecognitionOutput } from "@huggingface/tasks";
+import type { AutomaticSpeechRecognitionOutput, ImageSegmentationOutput } from "@huggingface/tasks";
 import { isUrl } from "../lib/isUrl.js";
 import type { BodyParams, HeaderParams, InferenceTask, ModelId, RequestArgs, UrlParams } from "../types.js";
 import { delay } from "../utils/delay.js";
 import { omit } from "../utils/omit.js";
-import type { ImageToImageTaskHelper } from "./providerHelper.js";
+import type { ImageSegmentationTaskHelper, ImageToImageTaskHelper } from "./providerHelper.js";
 import {
 	type AutomaticSpeechRecognitionTaskHelper,
 	TaskProviderHelper,
@@ -36,6 +36,7 @@ import {
 	InferenceClientProviderOutputError,
 } from "../errors.js";
 import type { ImageToImageArgs } from "../tasks/index.js";
+import type { ImageSegmentationArgs } from "../tasks/cv/imageSegmentation.js";
 
 export interface FalAiQueueOutput {
 	request_id: string;
@@ -406,3 +407,87 @@ export class FalAITextToSpeechTask extends FalAITask {
 		}
 	}
 }
+export class FalAIImageSegmentationTask extends FalAiQueueTask implements ImageSegmentationTaskHelper {
+	task: InferenceTask;
+	constructor() {
+		super("https://queue.fal.run");
+		this.task = "image-segmentation";
+	}
+
+	override makeRoute(params: UrlParams): string {
+		if (params.authMethod !== "provider-key") {
+			return `/${params.model}?_subdomain=queue`;
+		}
+		return `/${params.model}`;
+	}
+
+	override preparePayload(params: BodyParams): Record<string, unknown> {
+		return {
+			...omit(params.args, ["inputs", "parameters"]),
+			...(params.args.parameters as Record<string, unknown>),
+			sync_mode: true,
+		};
+	}
+
+	async preparePayloadAsync(args: ImageSegmentationArgs): Promise<RequestArgs> {
+		const blob = "data" in args && args.data instanceof Blob ? args.data : "inputs" in args ? args.inputs : undefined;
+		const mimeType = blob instanceof Blob ? blob.type : "image/png";
+		const base64Image = base64FromBytes(
+			new Uint8Array(blob instanceof ArrayBuffer ? blob : await (blob as Blob).arrayBuffer())
+		);
+		return {
+			...omit(args, ["inputs", "parameters", "data"]),
+			...args.parameters,
+			...args,
+			image_url: `data:${mimeType};base64,${base64Image}`,
+			sync_mode: true,
+		};
+	}
+
+	override async getResponse(
+		response: FalAiQueueOutput,
+		url?: string,
+		headers?: Record<string, string>
+	): Promise<ImageSegmentationOutput> {
+		const result = await this.getResponseFromQueueApi(response, url, headers);
+		if (
+			typeof result === "object" &&
+			result !== null &&
+			"image" in result &&
+			typeof result.image === "object" &&
+			result.image !== null &&
+			"url" in result.image &&
+			typeof result.image.url === "string"
+		) {
+			const maskResponse = await fetch(result.image.url);
+			if (!maskResponse.ok) {
+				throw new InferenceClientProviderApiError(
+					`Failed to fetch segmentation mask from ${result.image.url}`,
+					{ url: result.image.url, method: "GET" },
+					{
+						requestId: maskResponse.headers.get("x-request-id") ?? "",
+						status: maskResponse.status,
+						body: await maskResponse.text(),
+					}
+				);
+			}
+			const maskBlob = await maskResponse.blob();
+			const maskArrayBuffer = await maskBlob.arrayBuffer();
+			const maskBase64 = base64FromBytes(new Uint8Array(maskArrayBuffer));
+
+			return [
+				{
+					label: "mask", // placeholder label, as Fal does not provide labels in the response(?)
+					score: 1.0, // placeholder score, as Fal does not provide scores in the response(?)
+					mask: maskBase64,
+				},
+			];
+		}
+
+		throw new InferenceClientProviderOutputError(
+			`Received malformed response from Fal.ai image-segmentation API: expected { image: { url: string } } format, got instead: ${JSON.stringify(
+				response
+			)}`
+		);
+	}
+}

package/src/providers/hf-inference.ts

@@ -22,6 +22,7 @@ import type {
 	ImageToTextOutput,
 	ObjectDetectionOutput,
 	QuestionAnsweringOutput,
+	QuestionAnsweringOutputElement,
 	SentenceSimilarityOutput,
 	SummarizationOutput,
 	TableQuestionAnsweringOutput,
@@ -31,6 +32,7 @@ import type {
 	TranslationOutput,
 	VisualQuestionAnsweringOutput,
 	ZeroShotClassificationOutput,
+	ZeroShotClassificationOutputElement,
 	ZeroShotImageClassificationOutput,
 } from "@huggingface/tasks";
 import { HF_ROUTER_URL } from "../config.js";
@@ -74,6 +76,7 @@ import { base64FromBytes } from "../utils/base64FromBytes.js";
 import type { ImageToImageArgs } from "../tasks/cv/imageToImage.js";
 import type { AutomaticSpeechRecognitionArgs } from "../tasks/audio/automaticSpeechRecognition.js";
 import { omit } from "../utils/omit.js";
+import type { ImageSegmentationArgs } from "../tasks/cv/imageSegmentation.js";
 interface Base64ImageGeneration {
 	data: Array<{
 		b64_json: string;
@@ -343,6 +346,15 @@ export class HFInferenceImageSegmentationTask extends HFInferenceTask implements
 			"Received malformed response from HF-Inference image-segmentation API: expected Array<{label: string, mask: string, score: number}>"
 		);
 	}
+
+	async preparePayloadAsync(args: ImageSegmentationArgs): Promise<RequestArgs> {
+		return {
+			...args,
+			inputs: base64FromBytes(
+				new Uint8Array(args.inputs instanceof ArrayBuffer ? args.inputs : await (args.inputs as Blob).arrayBuffer())
+			),
+		};
+	}
 }
 
 export class HFInferenceImageToTextTask extends HFInferenceTask implements ImageToTextTaskHelper {
@@ -435,7 +447,7 @@ export class HFInferenceTextClassificationTask extends HFInferenceTask implement
 export class HFInferenceQuestionAnsweringTask extends HFInferenceTask implements QuestionAnsweringTaskHelper {
 	override async getResponse(
 		response: QuestionAnsweringOutput | QuestionAnsweringOutput[number]
-	): Promise<QuestionAnsweringOutput[number]> {
+	): Promise<QuestionAnsweringOutputElement> {
 		if (
 			Array.isArray(response)
 				? response.every(
@@ -483,22 +495,42 @@ export class HFInferenceFillMaskTask extends HFInferenceTask implements FillMask
 }
 
 export class HFInferenceZeroShotClassificationTask extends HFInferenceTask implements ZeroShotClassificationTaskHelper {
-	override async getResponse(response: ZeroShotClassificationOutput): Promise<ZeroShotClassificationOutput> {
+	override async getResponse(response: unknown): Promise<ZeroShotClassificationOutput> {
+		/// Handle Legacy response format from Inference API
 		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"
-			)
+			typeof response === "object" &&
+			response !== null &&
+			"labels" in response &&
+			"scores" in response &&
+			Array.isArray(response.labels) &&
+			Array.isArray(response.scores) &&
+			response.labels.length === response.scores.length &&
+			response.labels.every((label: unknown): label is string => typeof label === "string") &&
+			response.scores.every((score: unknown): score is number => typeof score === "number")
 		) {
+			const scores = response.scores;
+			return response.labels.map((label: string, index: number) => ({
+				label,
+				score: scores[index],
+			}));
+		}
+
+		if (Array.isArray(response) && response.every(HFInferenceZeroShotClassificationTask.validateOutputElement)) {
 			return response;
 		}
 		throw new InferenceClientProviderOutputError(
-			"Received malformed response from HF-Inference zero-shot-classification API: expected Array<{labels: string[], scores: number[], sequence: string}>"
+			"Received malformed response from HF-Inference zero-shot-classification API: expected Array<{label: string, score: number}>"
+		);
+	}
+
+	private static validateOutputElement(elem: unknown): elem is ZeroShotClassificationOutputElement {
+		return (
+			typeof elem === "object" &&
+			!!elem &&
+			"label" in elem &&
+			"score" in elem &&
+			typeof elem.label === "string" &&
+			typeof elem.score === "number"
 		);
 	}
 }

package/src/providers/providerHelper.ts

@@ -54,6 +54,7 @@ import { toArray } from "../utils/toArray.js";
 import type { ImageToImageArgs } from "../tasks/cv/imageToImage.js";
 import type { AutomaticSpeechRecognitionArgs } from "../tasks/audio/automaticSpeechRecognition.js";
 import type { ImageToVideoArgs } from "../tasks/cv/imageToVideo.js";
+import type { ImageSegmentationArgs } from "../tasks/cv/imageSegmentation.js";
 
 /**
  * Base class for task-specific provider helpers
@@ -161,6 +162,7 @@ export interface ImageToVideoTaskHelper {
 export interface ImageSegmentationTaskHelper {
 	getResponse(response: unknown, url?: string, headers?: HeadersInit): Promise<ImageSegmentationOutput>;
 	preparePayload(params: BodyParams<ImageSegmentationInput & BaseArgs>): Record<string, unknown> | BodyInit;
+	preparePayloadAsync(args: ImageSegmentationArgs): Promise<RequestArgs>;
 }
 
 export interface ImageClassificationTaskHelper {

package/src/snippets/getInferenceSnippets.ts

@@ -12,6 +12,7 @@ import { getProviderHelper } from "../lib/getProviderHelper.js";
 import { makeRequestOptionsFromResolvedModel } from "../lib/makeRequestOptions.js";
 import type { InferenceProviderMappingEntry, InferenceProviderOrPolicy, InferenceTask, RequestArgs } from "../types.js";
 import { templates } from "./templates.exported.js";
+import { getLogger } from "../lib/logger.js";
 
 export type InferenceSnippetOptions = {
 	streaming?: boolean;
@@ -121,7 +122,6 @@ const HF_JS_METHODS: Partial<Record<WidgetType, string>> = {
 	"table-question-answering": "tableQuestionAnswering",
 	"text-classification": "textClassification",
 	"text-generation": "textGeneration",
-	"text2text-generation": "textGeneration",
 	"token-classification": "tokenClassification",
 	"text-to-speech": "textToSpeech",
 	translation: "translation",
@@ -140,6 +140,7 @@ const snippetGenerator = (templateName: string, inputPreparationFn?: InputPrepar
 		inferenceProviderMapping?: InferenceProviderMappingEntry,
 		opts?: InferenceSnippetOptions
 	): InferenceSnippet[] => {
+		const logger = getLogger();
 		const providerModelId = inferenceProviderMapping?.providerId ?? model.id;
 		/// Hacky: hard-code conversational templates here
 		let task = model.pipeline_tag as InferenceTask;
@@ -156,7 +157,7 @@ const snippetGenerator = (templateName: string, inputPreparationFn?: InputPrepar
 		try {
 			providerHelper = getProviderHelper(provider, task);
 		} catch (e) {
-			console.error(`Failed to get provider helper for ${provider} (${task})`, e);
+			logger.error(`Failed to get provider helper for ${provider} (${task})`, e);
 			return [];
 		}
 
@@ -191,7 +192,7 @@ const snippetGenerator = (templateName: string, inputPreparationFn?: InputPrepar
 			try {
 				providerInputs = JSON.parse(bodyAsObj);
 			} catch (e) {
-				console.error("Failed to parse body as JSON", e);
+				logger.error("Failed to parse body as JSON", e);
 			}
 		}
 
@@ -359,7 +360,6 @@ const snippets: Partial<
 	"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"),

package/src/tasks/custom/request.ts

@@ -2,6 +2,7 @@ import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
 import { getProviderHelper } from "../../lib/getProviderHelper.js";
 import type { InferenceTask, Options, RequestArgs } from "../../types.js";
 import { innerRequest } from "../../utils/request.js";
+import { getLogger } from "../../lib/logger.js";
 
 /**
  * Primitive to make custom calls to the inference provider
@@ -14,7 +15,8 @@ export async function request<T>(
 		task?: InferenceTask;
 	}
 ): Promise<T> {
-	console.warn(
+	const logger = getLogger();
+	logger.warn(
 		"The request method is deprecated and will be removed in a future version of huggingface.js. Use specific task functions instead."
 	);
 	const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);

package/src/tasks/custom/streamingRequest.ts

@@ -2,6 +2,7 @@ import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
 import { getProviderHelper } from "../../lib/getProviderHelper.js";
 import type { InferenceTask, Options, RequestArgs } from "../../types.js";
 import { innerStreamingRequest } from "../../utils/request.js";
+import { getLogger } from "../../lib/logger.js";
 
 /**
  * Primitive to make custom inference calls that expect server-sent events, and returns the response through a generator
@@ -14,7 +15,8 @@ export async function* streamingRequest<T>(
 		task?: InferenceTask;
 	}
 ): AsyncGenerator<T> {
-	console.warn(
+	const logger = getLogger();
+	logger.warn(
 		"The streamingRequest method is deprecated and will be removed in a future version of huggingface.js. Use specific task functions instead."
 	);
 	const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);

package/src/tasks/cv/imageSegmentation.ts

@@ -3,9 +3,9 @@ import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
 import { getProviderHelper } from "../../lib/getProviderHelper.js";
 import type { BaseArgs, Options } from "../../types.js";
 import { innerRequest } from "../../utils/request.js";
-import { preparePayload, type LegacyImageInput } from "./utils.js";
+import { makeRequestOptions } from "../../lib/makeRequestOptions.js";
 
-export type ImageSegmentationArgs = BaseArgs & (ImageSegmentationInput | LegacyImageInput);
+export type ImageSegmentationArgs = BaseArgs & ImageSegmentationInput;
 
 /**
  * This task reads some image input and outputs the likelihood of classes & bounding boxes of detected objects.
@@ -17,10 +17,11 @@ export async function imageSegmentation(
 ): Promise<ImageSegmentationOutput> {
 	const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
 	const providerHelper = getProviderHelper(provider, "image-segmentation");
-	const payload = preparePayload(args);
+	const payload = await providerHelper.preparePayloadAsync(args);
 	const { data: res } = await innerRequest<ImageSegmentationOutput>(payload, providerHelper, {
 		...options,
 		task: "image-segmentation",
 	});
-	return providerHelper.getResponse(res);
+	const { url, info } = await makeRequestOptions(args, providerHelper, { ...options, task: "image-segmentation" });
+	return providerHelper.getResponse(res, url, info.headers as Record<string, string>);
 }

package/src/types.ts

@@ -5,6 +5,14 @@ import type { ChatCompletionInput, PipelineType, WidgetType } from "@huggingface
  */
 export type ModelId = string;
 
+export interface Logger {
+	debug: (message: string, ...args: unknown[]) => void;
+	info: (message: string, ...args: unknown[]) => void;
+	warn: (message: string, ...args: unknown[]) => void;
+	error: (message: string, ...args: unknown[]) => void;
+	log: (message: string, ...args: unknown[]) => void;
+}
+
 export interface Options {
 	/**
 	 * (Default: true) Boolean. If a request 503s, the request will be retried with the same parameters.