@huggingface/inference 3.6.1 → 3.7.0

package/src/providers/fal-ai.ts

@@ -14,9 +14,17 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import { InferenceOutputError } from "../lib/InferenceOutputError";
+import { isUrl } from "../lib/isUrl";
+import type { BodyParams, HeaderParams, InferenceTask, ProviderConfig, UrlParams } from "../types";
+import { delay } from "../utils/delay";
 
 const FAL_AI_API_BASE_URL = "https://fal.run";
+const FAL_AI_API_BASE_URL_QUEUE = "https://queue.fal.run";
+
+const makeBaseUrl = (task?: InferenceTask): string => {
+	return task === "text-to-video" ? FAL_AI_API_BASE_URL_QUEUE : FAL_AI_API_BASE_URL;
+};
 
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return params.args;
@@ -29,12 +37,86 @@ const makeHeaders = (params: HeaderParams): Record<string, string> => {
 };
 
 const makeUrl = (params: UrlParams): string => {
-	return `${params.baseUrl}/${params.model}`;
+	const baseUrl = `${params.baseUrl}/${params.model}`;
+	if (params.authMethod !== "provider-key" && params.task === "text-to-video") {
+		return `${baseUrl}?_subdomain=queue`;
+	}
+	return baseUrl;
 };
 
 export const FAL_AI_CONFIG: ProviderConfig = {
-	baseUrl: FAL_AI_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,
 };
+
+export interface FalAiQueueOutput {
+	request_id: string;
+	status: string;
+	response_url: string;
+}
+
+export async function pollFalResponse(
+	res: FalAiQueueOutput,
+	url: string,
+	headers: Record<string, string>
+): Promise<Blob> {
+	const requestId = res.request_id;
+	if (!requestId) {
+		throw new InferenceOutputError("No request ID found in the response");
+	}
+	let status = res.status;
+
+	const parsedUrl = new URL(url);
+	const baseUrl = `${parsedUrl.protocol}//${parsedUrl.host}${
+		parsedUrl.host === "router.huggingface.co" ? "/fal-ai" : ""
+	}`;
+
+	// extracting the provider model id for status and result urls
+	// from the response as it might be different from the mapped model in `url`
+	const modelId = new URL(res.response_url).pathname;
+	const queryParams = parsedUrl.search;
+
+	const statusUrl = `${baseUrl}${modelId}/status${queryParams}`;
+	const resultUrl = `${baseUrl}${modelId}${queryParams}`;
+
+	while (status !== "COMPLETED") {
+		await delay(500);
+		const statusResponse = await fetch(statusUrl, { headers });
+
+		if (!statusResponse.ok) {
+			throw new InferenceOutputError("Failed to fetch response status from fal-ai API");
+		}
+		try {
+			status = (await statusResponse.json()).status;
+		} catch (error) {
+			throw new InferenceOutputError("Failed to parse status response from fal-ai API");
+		}
+	}
+
+	const resultResponse = await fetch(resultUrl, { headers });
+	let result: unknown;
+	try {
+		result = await resultResponse.json();
+	} catch (error) {
+		throw new InferenceOutputError("Failed to parse result response from fal-ai API");
+	}
+	if (
+		typeof result === "object" &&
+		!!result &&
+		"video" in result &&
+		typeof result.video === "object" &&
+		!!result.video &&
+		"url" in result.video &&
+		typeof result.video.url === "string" &&
+		isUrl(result.video.url)
+	) {
+		const urlResponse = await fetch(result.video.url);
+		return await urlResponse.blob();
+	} else {
+		throw new InferenceOutputError(
+			"Expected { video: { url: string } } result format, got instead: " + JSON.stringify(result)
+		);
+	}
+}

package/src/providers/fireworks-ai.ts

@@ -14,10 +14,14 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 const FIREWORKS_AI_API_BASE_URL = "https://api.fireworks.ai";
 
+const makeBaseUrl = (): string => {
+	return FIREWORKS_AI_API_BASE_URL;
+};
+
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
 		...params.args,
@@ -37,7 +41,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const FIREWORKS_AI_CONFIG: ProviderConfig = {
-	baseUrl: FIREWORKS_AI_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/hf-inference.ts

@@ -11,7 +11,11 @@
  * Thanks!
  */
 import { HF_ROUTER_URL } from "../config";
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
+
+const makeBaseUrl = (): string => {
+	return `${HF_ROUTER_URL}/hf-inference`;
+};
 
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
@@ -36,7 +40,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const HF_INFERENCE_CONFIG: ProviderConfig = {
-	baseUrl: `${HF_ROUTER_URL}/hf-inference`,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/hyperbolic.ts

@@ -14,10 +14,14 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 const HYPERBOLIC_API_BASE_URL = "https://api.hyperbolic.xyz";
 
+const makeBaseUrl = (): string => {
+	return HYPERBOLIC_API_BASE_URL;
+};
+
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
 		...params.args,
@@ -37,7 +41,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const HYPERBOLIC_CONFIG: ProviderConfig = {
-	baseUrl: HYPERBOLIC_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/nebius.ts

@@ -14,10 +14,14 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 const NEBIUS_API_BASE_URL = "https://api.studio.nebius.ai";
 
+const makeBaseUrl = (): string => {
+	return NEBIUS_API_BASE_URL;
+};
+
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
 		...params.args,
@@ -43,7 +47,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const NEBIUS_CONFIG: ProviderConfig = {
-	baseUrl: NEBIUS_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/novita.ts

@@ -14,10 +14,13 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 const NOVITA_API_BASE_URL = "https://api.novita.ai";
 
+const makeBaseUrl = (): string => {
+	return NOVITA_API_BASE_URL;
+};
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
 		...params.args,
@@ -41,7 +44,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const NOVITA_CONFIG: ProviderConfig = {
-	baseUrl: NOVITA_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/openai.ts

@@ -1,10 +1,14 @@
 /**
  * Special case: provider configuration for a private models provider (OpenAI in this case).
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 const OPENAI_API_BASE_URL = "https://api.openai.com";
 
+const makeBaseUrl = (): string => {
+	return OPENAI_API_BASE_URL;
+};
+
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	if (!params.chatCompletion) {
 		throw new Error("OpenAI only supports chat completions.");
@@ -27,7 +31,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const OPENAI_CONFIG: ProviderConfig = {
-	baseUrl: OPENAI_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/replicate.ts

@@ -14,10 +14,14 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 export const REPLICATE_API_BASE_URL = "https://api.replicate.com";
 
+const makeBaseUrl = (): string => {
+	return REPLICATE_API_BASE_URL;
+};
+
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
 		input: params.args,
@@ -39,7 +43,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const REPLICATE_CONFIG: ProviderConfig = {
-	baseUrl: REPLICATE_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/sambanova.ts

@@ -14,10 +14,14 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 const SAMBANOVA_API_BASE_URL = "https://api.sambanova.ai";
 
+const makeBaseUrl = (): string => {
+	return SAMBANOVA_API_BASE_URL;
+};
+
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
 		...params.args,
@@ -37,7 +41,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const SAMBANOVA_CONFIG: ProviderConfig = {
-	baseUrl: SAMBANOVA_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/together.ts

@@ -14,10 +14,14 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 const TOGETHER_API_BASE_URL = "https://api.together.xyz";
 
+const makeBaseUrl = (): string => {
+	return TOGETHER_API_BASE_URL;
+};
+
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
 		...params.args,
@@ -43,7 +47,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const TOGETHER_CONFIG: ProviderConfig = {
-	baseUrl: TOGETHER_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/snippets/templates.exported.ts

@@ -6,7 +6,7 @@ export const templates: Record<string, Record<string, Record<string, string>>> =
       "basicAudio": "async function query(data) {\n\tconst response = await fetch(\n\t\t\"{{ fullUrl }}\",\n\t\t{\n\t\t\theaders: {\n\t\t\t\tAuthorization: \"{{ authorizationHeader }}\",\n\t\t\t\t\"Content-Type\": \"audio/flac\"\n\t\t\t},\n\t\t\tmethod: \"POST\",\n\t\t\tbody: JSON.stringify(data),\n\t\t}\n\t);\n\tconst result = await response.json();\n\treturn result;\n}\n\nquery({ inputs: {{ providerInputs.asObj.inputs }} }).then((response) => {\n    console.log(JSON.stringify(response));\n});",
       "basicImage": "async function query(data) {\n\tconst response = await fetch(\n\t\t\"{{ fullUrl }}\",\n\t\t{\n\t\t\theaders: {\n\t\t\t\tAuthorization: \"{{ authorizationHeader }}\",\n\t\t\t\t\"Content-Type\": \"image/jpeg\"\n\t\t\t},\n\t\t\tmethod: \"POST\",\n\t\t\tbody: JSON.stringify(data),\n\t\t}\n\t);\n\tconst result = await response.json();\n\treturn result;\n}\n\nquery({ inputs: {{ providerInputs.asObj.inputs }} }).then((response) => {\n    console.log(JSON.stringify(response));\n});",
       "textToAudio": "{% if model.library_name == \"transformers\" %}\nasync function query(data) {\n\tconst response = await fetch(\n\t\t\"{{ fullUrl }}\",\n\t\t{\n\t\t\theaders: {\n\t\t\t\tAuthorization: \"{{ authorizationHeader }}\",\n\t\t\t\t\"Content-Type\": \"application/json\",\n\t\t\t},\n\t\t\tmethod: \"POST\",\n\t\t\tbody: JSON.stringify(data),\n\t\t}\n\t);\n\tconst result = await response.blob();\n    return result;\n}\n\nquery({ inputs: {{ providerInputs.asObj.inputs }} }).then((response) => {\n    // Returns a byte object of the Audio wavform. Use it directly!\n});\n{% else %}\nasync function query(data) {\n\tconst response = await fetch(\n\t\t\"{{ fullUrl }}\",\n\t\t{\n\t\t\theaders: {\n\t\t\t\tAuthorization: \"{{ authorizationHeader }}\",\n\t\t\t\t\"Content-Type\": \"application/json\",\n\t\t\t},\n\t\t\tmethod: \"POST\",\n\t\t\tbody: JSON.stringify(data),\n\t\t}\n\t);\n    const result = await response.json();\n    return result;\n}\n\nquery({ inputs: {{ providerInputs.asObj.inputs }} }).then((response) => {\n    console.log(JSON.stringify(response));\n});\n{% endif %} ",
-      "textToImage": "async function query(data) {\n\tconst response = await fetch(\n\t\t\"{{ fullUrl }}\",\n\t\t{\n\t\t\theaders: {\n\t\t\t\tAuthorization: \"{{ authorizationHeader }}\",\n\t\t\t\t\"Content-Type\": \"application/json\",\n\t\t\t},\n\t\t\tmethod: \"POST\",\n\t\t\tbody: JSON.stringify(data),\n\t\t}\n\t);\n\tconst result = await response.blob();\n\treturn result;\n}\n\nquery({ inputs: {{ providerInputs.asObj.inputs }} }).then((response) => {\n    // Use image\n});",
+      "textToImage": "async function query(data) {\n\tconst response = await fetch(\n\t\t\"{{ fullUrl }}\",\n\t\t{\n\t\t\theaders: {\n\t\t\t\tAuthorization: \"{{ authorizationHeader }}\",\n\t\t\t\t\"Content-Type\": \"application/json\",\n\t\t\t},\n\t\t\tmethod: \"POST\",\n\t\t\tbody: JSON.stringify(data),\n\t\t}\n\t);\n\tconst result = await response.blob();\n\treturn result;\n}\n\n\nquery({ {{ providerInputs.asTsString }} }).then((response) => {\n    // Use image\n});",
       "zeroShotClassification": "async function query(data) {\n    const response = await fetch(\n\t\t\"{{ fullUrl }}\",\n        {\n            headers: {\n\t\t\t\tAuthorization: \"{{ authorizationHeader }}\",\n                \"Content-Type\": \"application/json\",\n            },\n            method: \"POST\",\n            body: JSON.stringify(data),\n        }\n    );\n    const result = await response.json();\n    return result;\n}\n\nquery({\n    inputs: {{ providerInputs.asObj.inputs }},\n    parameters: { candidate_labels: [\"refund\", \"legal\", \"faq\"] }\n}).then((response) => {\n    console.log(JSON.stringify(response));\n});"
     },
     "huggingface.js": {

package/src/tasks/audio/audioClassification.ts

@@ -1,7 +1,7 @@
 import type { AudioClassificationInput, AudioClassificationOutput } from "@huggingface/tasks";
 import { InferenceOutputError } from "../../lib/InferenceOutputError";
 import type { BaseArgs, Options } from "../../types";
-import { request } from "../custom/request";
+import { innerRequest } from "../../utils/request";
 import type { LegacyAudioInput } from "./utils";
 import { preparePayload } from "./utils";
 
@@ -16,7 +16,7 @@ export async function audioClassification(
 	options?: Options
 ): Promise<AudioClassificationOutput> {
 	const payload = preparePayload(args);
-	const res = await request<AudioClassificationOutput>(payload, {
+	const { data: res } = await innerRequest<AudioClassificationOutput>(payload, {
 		...options,
 		task: "audio-classification",
 	});

package/src/tasks/audio/audioToAudio.ts

@@ -1,6 +1,6 @@
 import { InferenceOutputError } from "../../lib/InferenceOutputError";
 import type { BaseArgs, Options } from "../../types";
-import { request } from "../custom/request";
+import { innerRequest } from "../../utils/request";
 import type { LegacyAudioInput } from "./utils";
 import { preparePayload } from "./utils";
 
@@ -37,7 +37,7 @@ export interface AudioToAudioOutput {
  */
 export async function audioToAudio(args: AudioToAudioArgs, options?: Options): Promise<AudioToAudioOutput[]> {
 	const payload = preparePayload(args);
-	const res = await request<AudioToAudioOutput>(payload, {
+	const { data: res } = await innerRequest<AudioToAudioOutput>(payload, {
 		...options,
 		task: "audio-to-audio",
 	});

package/src/tasks/audio/automaticSpeechRecognition.ts

@@ -2,10 +2,10 @@ import type { AutomaticSpeechRecognitionInput, AutomaticSpeechRecognitionOutput
 import { InferenceOutputError } from "../../lib/InferenceOutputError";
 import type { BaseArgs, Options, RequestArgs } from "../../types";
 import { base64FromBytes } from "../../utils/base64FromBytes";
-import { request } from "../custom/request";
+import { omit } from "../../utils/omit";
+import { innerRequest } from "../../utils/request";
 import type { LegacyAudioInput } from "./utils";
 import { preparePayload } from "./utils";
-import { omit } from "../../utils/omit";
 
 export type AutomaticSpeechRecognitionArgs = BaseArgs & (AutomaticSpeechRecognitionInput | LegacyAudioInput);
 /**
@@ -17,7 +17,7 @@ export async function automaticSpeechRecognition(
 	options?: Options
 ): Promise<AutomaticSpeechRecognitionOutput> {
 	const payload = await buildPayload(args);
-	const res = await request<AutomaticSpeechRecognitionOutput>(payload, {
+	const { data: res } = await innerRequest<AutomaticSpeechRecognitionOutput>(payload, {
 		...options,
 		task: "automatic-speech-recognition",
 	});

package/src/tasks/audio/textToSpeech.ts

@@ -2,7 +2,7 @@ import type { TextToSpeechInput } from "@huggingface/tasks";
 import { InferenceOutputError } from "../../lib/InferenceOutputError";
 import type { BaseArgs, Options } from "../../types";
 import { omit } from "../../utils/omit";
-import { request } from "../custom/request";
+import { innerRequest } from "../../utils/request";
 type TextToSpeechArgs = BaseArgs & TextToSpeechInput;
 
 interface OutputUrlTextToSpeechGeneration {
@@ -22,7 +22,7 @@ export async function textToSpeech(args: TextToSpeechArgs, options?: Options): P
 					text: args.inputs,
 			  }
 			: args;
-	const res = await request<Blob | OutputUrlTextToSpeechGeneration>(payload, {
+	const { data: res } = await innerRequest<Blob | OutputUrlTextToSpeechGeneration>(payload, {
 		...options,
 		task: "text-to-speech",
 	});

package/src/tasks/custom/request.ts

@@ -1,8 +1,9 @@
 import type { InferenceTask, Options, RequestArgs } from "../../types";
-import { makeRequestOptions } from "../../lib/makeRequestOptions";
+import { innerRequest } from "../../utils/request";
 
 /**
  * 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<T>(
 	args: RequestArgs,
@@ -13,35 +14,9 @@ export async function request<T>(
 		chatCompletion?: boolean;
 	}
 ): Promise<T> {
-	const { url, info } = await makeRequestOptions(args, options);
-	const response = await (options?.fetch ?? fetch)(url, info);
-
-	if (options?.retry_on_error !== false && response.status === 503) {
-		return request(args, options);
-	}
-
-	if (!response.ok) {
-		const contentType = response.headers.get("Content-Type");
-		if (["application/json", "application/problem+json"].some((ct) => contentType?.startsWith(ct))) {
-			const output = await response.json();
-			if ([400, 422, 404, 500].includes(response.status) && options?.chatCompletion) {
-				throw new Error(
-					`Server ${args.model} does not seem to support chat completion. Error: ${JSON.stringify(output.error)}`
-				);
-			}
-			if (output.error || output.detail) {
-				throw new Error(JSON.stringify(output.error ?? output.detail));
-			} else {
-				throw new Error(output);
-			}
-		}
-		const message = contentType?.startsWith("text/plain;") ? await response.text() : undefined;
-		throw new Error(message ?? "An error occurred while fetching the blob");
-	}
-
-	if (response.headers.get("Content-Type")?.startsWith("application/json")) {
-		return await response.json();
-	}
-
-	return (await response.blob()) as T;
+	console.warn(
+		"The request method is deprecated and will be removed in a future version of huggingface.js. Use specific task functions instead."
+	);
+	const result = await innerRequest<T>(args, options);
+	return result.data;
 }

package/src/tasks/custom/streamingRequest.ts

@@ -1,10 +1,8 @@
 import type { InferenceTask, Options, RequestArgs } from "../../types";
-import { makeRequestOptions } from "../../lib/makeRequestOptions";
-import type { EventSourceMessage } from "../../vendor/fetch-event-source/parse";
-import { getLines, getMessages } from "../../vendor/fetch-event-source/parse";
-
+import { innerStreamingRequest } from "../../utils/request";
 /**
  * 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<T>(
 	args: RequestArgs,
@@ -15,86 +13,8 @@ export async function* streamingRequest<T>(
 		chatCompletion?: boolean;
 	}
 ): AsyncGenerator<T> {
-	const { url, info } = await makeRequestOptions({ ...args, stream: true }, options);
-	const response = await (options?.fetch ?? fetch)(url, info);
-
-	if (options?.retry_on_error !== false && response.status === 503) {
-		return yield* streamingRequest(args, options);
-	}
-	if (!response.ok) {
-		if (response.headers.get("Content-Type")?.startsWith("application/json")) {
-			const output = await response.json();
-			if ([400, 422, 404, 500].includes(response.status) && options?.chatCompletion) {
-				throw new Error(`Server ${args.model} does not seem to support chat completion. Error: ${output.error}`);
-			}
-			if (typeof output.error === "string") {
-				throw new Error(output.error);
-			}
-			if (output.error && "message" in output.error && typeof output.error.message === "string") {
-				/// OpenAI errors
-				throw new Error(output.error.message);
-			}
-		}
-
-		throw new Error(`Server response contains error: ${response.status}`);
-	}
-	if (!response.headers.get("content-type")?.startsWith("text/event-stream")) {
-		throw new Error(
-			`Server does not support event stream content type, it returned ` + response.headers.get("content-type")
-		);
-	}
-
-	if (!response.body) {
-		return;
-	}
-
-	const reader = response.body.getReader();
-	let events: EventSourceMessage[] = [];
-
-	const onEvent = (event: EventSourceMessage) => {
-		// accumulate events in array
-		events.push(event);
-	};
-
-	const onChunk = getLines(
-		getMessages(
-			() => {},
-			() => {},
-			onEvent
-		)
+	console.warn(
+		"The streamingRequest method is deprecated and will be removed in a future version of huggingface.js. Use specific task functions instead."
 	);
-
-	try {
-		while (true) {
-			const { done, value } = await reader.read();
-			if (done) {
-				return;
-			}
-			onChunk(value);
-			for (const event of events) {
-				if (event.data.length > 0) {
-					if (event.data === "[DONE]") {
-						return;
-					}
-					const data = JSON.parse(event.data);
-					if (typeof data === "object" && data !== null && "error" in data) {
-						const errorStr =
-							typeof data.error === "string"
-								? data.error
-								: typeof data.error === "object" &&
-								    data.error &&
-								    "message" in data.error &&
-								    typeof data.error.message === "string"
-								  ? data.error.message
-								  : JSON.stringify(data.error);
-						throw new Error(`Error forwarded from backend: ` + errorStr);
-					}
-					yield data as T;
-				}
-			}
-			events = [];
-		}
-	} finally {
-		reader.releaseLock();
-	}
+	yield* innerStreamingRequest(args, options);
 }

package/src/tasks/cv/imageClassification.ts

@@ -1,7 +1,7 @@
 import type { ImageClassificationInput, ImageClassificationOutput } from "@huggingface/tasks";
 import { InferenceOutputError } from "../../lib/InferenceOutputError";
 import type { BaseArgs, Options } from "../../types";
-import { request } from "../custom/request";
+import { innerRequest } from "../../utils/request";
 import { preparePayload, type LegacyImageInput } from "./utils";
 
 export type ImageClassificationArgs = BaseArgs & (ImageClassificationInput | LegacyImageInput);
@@ -15,7 +15,7 @@ export async function imageClassification(
 	options?: Options
 ): Promise<ImageClassificationOutput> {
 	const payload = preparePayload(args);
-	const res = await request<ImageClassificationOutput>(payload, {
+	const { data: res } = await innerRequest<ImageClassificationOutput>(payload, {
 		...options,
 		task: "image-classification",
 	});

package/src/tasks/cv/imageSegmentation.ts

@@ -1,7 +1,7 @@
 import type { ImageSegmentationInput, ImageSegmentationOutput } from "@huggingface/tasks";
 import { InferenceOutputError } from "../../lib/InferenceOutputError";
 import type { BaseArgs, Options } from "../../types";
-import { request } from "../custom/request";
+import { innerRequest } from "../../utils/request";
 import { preparePayload, type LegacyImageInput } from "./utils";
 
 export type ImageSegmentationArgs = BaseArgs & (ImageSegmentationInput | LegacyImageInput);
@@ -15,7 +15,7 @@ export async function imageSegmentation(
 	options?: Options
 ): Promise<ImageSegmentationOutput> {
 	const payload = preparePayload(args);
-	const res = await request<ImageSegmentationOutput>(payload, {
+	const { data: res } = await innerRequest<ImageSegmentationOutput>(payload, {
 		...options,
 		task: "image-segmentation",
 	});

package/src/tasks/cv/imageToImage.ts

@@ -2,7 +2,7 @@ import type { ImageToImageInput } from "@huggingface/tasks";
 import { InferenceOutputError } from "../../lib/InferenceOutputError";
 import type { BaseArgs, Options, RequestArgs } from "../../types";
 import { base64FromBytes } from "../../utils/base64FromBytes";
-import { request } from "../custom/request";
+import { innerRequest } from "../../utils/request";
 
 export type ImageToImageArgs = BaseArgs & ImageToImageInput;
 
@@ -26,7 +26,7 @@ export async function imageToImage(args: ImageToImageArgs, options?: Options): P
 			),
 		};
 	}
-	const res = await request<Blob>(reqArgs, {
+	const { data: res } = await innerRequest<Blob>(reqArgs, {
 		...options,
 		task: "image-to-image",
 	});