fixes

hanouticelina · hanouticelina · commit 68fda16ccffd · 2025-04-02T16:41:35.000+02:00
diff --git a/packages/inference/src/tasks/audio/audioClassification.ts b/packages/inference/src/tasks/audio/audioClassification.ts
@@ -16,12 +16,10 @@ export async function audioClassification(
 	options?: Options
 ): Promise<AudioClassificationOutput> {
 	const payload = preparePayload(args);
-	const res = (
-		await innerRequest<AudioClassificationOutput>(payload, {
-			...options,
-			task: "audio-classification",
-		})
-	).data;
+	const { data: res } = await innerRequest<AudioClassificationOutput>(payload, {
+		...options,
+		task: "audio-classification",
+	});
 	const isValidOutput =
 		Array.isArray(res) && res.every((x) => typeof x.label === "string" && typeof x.score === "number");
 	if (!isValidOutput) {
diff --git a/packages/inference/src/tasks/audio/audioToAudio.ts b/packages/inference/src/tasks/audio/audioToAudio.ts
@@ -37,12 +37,10 @@ export interface AudioToAudioOutput {
  */
 export async function audioToAudio(args: AudioToAudioArgs, options?: Options): Promise<AudioToAudioOutput[]> {
 	const payload = preparePayload(args);
-	const res = (
-		await innerRequest<AudioToAudioOutput>(payload, {
-			...options,
-			task: "audio-to-audio",
-		})
-	).data;
+	const { data: res } = await innerRequest<AudioToAudioOutput>(payload, {
+		...options,
+		task: "audio-to-audio",
+	});
 
 	return validateOutput(res);
 }
diff --git a/packages/inference/src/tasks/audio/automaticSpeechRecognition.ts b/packages/inference/src/tasks/audio/automaticSpeechRecognition.ts
@@ -17,12 +17,10 @@ export async function automaticSpeechRecognition(
 	options?: Options
 ): Promise<AutomaticSpeechRecognitionOutput> {
 	const payload = await buildPayload(args);
-	const res = (
-		await innerRequest<AutomaticSpeechRecognitionOutput>(payload, {
-			...options,
-			task: "automatic-speech-recognition",
-		})
-	).data;
+	const { data: res } = await innerRequest<AutomaticSpeechRecognitionOutput>(payload, {
+		...options,
+		task: "automatic-speech-recognition",
+	});
 	const isValidOutput = typeof res?.text === "string";
 	if (!isValidOutput) {
 		throw new InferenceOutputError("Expected {text: string}");
diff --git a/packages/inference/src/tasks/audio/textToSpeech.ts b/packages/inference/src/tasks/audio/textToSpeech.ts
@@ -22,12 +22,10 @@ export async function textToSpeech(args: TextToSpeechArgs, options?: Options): P
 					text: args.inputs,
 			  }
 			: args;
-	const res = (
-		await innerRequest<Blob | OutputUrlTextToSpeechGeneration>(payload, {
-			...options,
-			task: "text-to-speech",
-		})
-	).data;
+	const { data: res } = await innerRequest<Blob | OutputUrlTextToSpeechGeneration>(payload, {
+		...options,
+		task: "text-to-speech",
+	});
 	if (res instanceof Blob) {
 		return res;
 	}
diff --git a/packages/inference/src/tasks/custom/request.ts b/packages/inference/src/tasks/custom/request.ts
@@ -14,6 +14,9 @@ export async function request<T>(
 		chatCompletion?: boolean;
 	}
 ): Promise<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;
 }
diff --git a/packages/inference/src/tasks/custom/streamingRequest.ts b/packages/inference/src/tasks/custom/streamingRequest.ts
@@ -13,5 +13,8 @@ export async function* streamingRequest<T>(
 		chatCompletion?: boolean;
 	}
 ): AsyncGenerator<T> {
+	console.warn(
+		"The streamingRequest method is deprecated and will be removed in a future version of huggingface.js. Use specific task functions instead."
+	);
 	yield* innerStreamingRequest(args, options);
 }
diff --git a/packages/inference/src/tasks/cv/imageClassification.ts b/packages/inference/src/tasks/cv/imageClassification.ts
@@ -15,12 +15,10 @@ export async function imageClassification(
 	options?: Options
 ): Promise<ImageClassificationOutput> {
 	const payload = preparePayload(args);
-	const res = (
-		await innerRequest<ImageClassificationOutput>(payload, {
-			...options,
-			task: "image-classification",
-		})
-	).data;
+	const { data: res } = await innerRequest<ImageClassificationOutput>(payload, {
+		...options,
+		task: "image-classification",
+	});
 	const isValidOutput =
 		Array.isArray(res) && res.every((x) => typeof x.label === "string" && typeof x.score === "number");
 	if (!isValidOutput) {
diff --git a/packages/inference/src/tasks/cv/imageSegmentation.ts b/packages/inference/src/tasks/cv/imageSegmentation.ts
@@ -15,12 +15,10 @@ export async function imageSegmentation(
 	options?: Options
 ): Promise<ImageSegmentationOutput> {
 	const payload = preparePayload(args);
-	const res = (
-		await innerRequest<ImageSegmentationOutput>(payload, {
-			...options,
-			task: "image-segmentation",
-		})
-	).data;
+	const { data: res } = await innerRequest<ImageSegmentationOutput>(payload, {
+		...options,
+		task: "image-segmentation",
+	});
 	const isValidOutput =
 		Array.isArray(res) &&
 		res.every((x) => typeof x.label === "string" && typeof x.mask === "string" && typeof x.score === "number");
diff --git a/packages/inference/src/tasks/cv/imageToImage.ts b/packages/inference/src/tasks/cv/imageToImage.ts
@@ -26,12 +26,10 @@ export async function imageToImage(args: ImageToImageArgs, options?: Options): P
 			),
 		};
 	}
-	const res = (
-		await innerRequest<Blob>(reqArgs, {
-			...options,
-			task: "image-to-image",
-		})
-	).data;
+	const { data: res } = await innerRequest<Blob>(reqArgs, {
+		...options,
+		task: "image-to-image",
+	});
 	const isValidOutput = res && res instanceof Blob;
 	if (!isValidOutput) {
 		throw new InferenceOutputError("Expected Blob");
diff --git a/packages/inference/src/tasks/cv/imageToText.ts b/packages/inference/src/tasks/cv/imageToText.ts
@@ -11,16 +11,14 @@ export type ImageToTextArgs = BaseArgs & (ImageToTextInput | LegacyImageInput);
  */
 export async function imageToText(args: ImageToTextArgs, options?: Options): Promise<ImageToTextOutput> {
 	const payload = preparePayload(args);
-	const res = (
-		await innerRequest<[ImageToTextOutput]>(payload, {
-			...options,
-			task: "image-to-text",
-		})
-	).data?.[0];
+	const { data: res } = await innerRequest<[ImageToTextOutput]>(payload, {
+		...options,
+		task: "image-to-text",
+	});
 
-	if (typeof res?.generated_text !== "string") {
+	if (typeof res?.[0]?.generated_text !== "string") {
 		throw new InferenceOutputError("Expected {generated_text: string}");
 	}
 
-	return res;
+	return res?.[0];
 }
diff --git a/packages/inference/src/tasks/cv/objectDetection.ts b/packages/inference/src/tasks/cv/objectDetection.ts
@@ -12,12 +12,10 @@ export type ObjectDetectionArgs = BaseArgs & (ObjectDetectionInput | LegacyImage
  */
 export async function objectDetection(args: ObjectDetectionArgs, options?: Options): Promise<ObjectDetectionOutput> {
 	const payload = preparePayload(args);
-	const res = (
-		await innerRequest<ObjectDetectionOutput>(payload, {
-			...options,
-			task: "object-detection",
-		})
-	).data;
+	const { data: res } = await innerRequest<ObjectDetectionOutput>(payload, {
+		...options,
+		task: "object-detection",
+	});
 	const isValidOutput =
 		Array.isArray(res) &&
 		res.every(
diff --git a/packages/inference/src/tasks/cv/textToImage.ts b/packages/inference/src/tasks/cv/textToImage.ts
@@ -65,18 +65,16 @@ export async function textToImage(args: TextToImageArgs, options?: TextToImageOp
 					...getResponseFormatArg(args.provider),
 					prompt: args.inputs,
 			  };
-	const res = (
-		await innerRequest<
-			| TextToImageOutput
-			| Base64ImageGeneration
-			| OutputUrlImageGeneration
-			| BlackForestLabsResponse
-			| HyperbolicTextToImageOutput
-		>(payload, {
-			...options,
-			task: "text-to-image",
-		})
-	).data;
+	const { data: res } = await innerRequest<
+		| TextToImageOutput
+		| Base64ImageGeneration
+		| OutputUrlImageGeneration
+		| BlackForestLabsResponse
+		| HyperbolicTextToImageOutput
+	>(payload, {
+		...options,
+		task: "text-to-image",
+	});
 
 	if (res && typeof res === "object") {
 		if (args.provider === "black-forest-labs" && "polling_url" in res && typeof res.polling_url === "string") {
diff --git a/packages/inference/src/tasks/cv/textToVideo.ts b/packages/inference/src/tasks/cv/textToVideo.ts
@@ -34,12 +34,11 @@ export async function textToVideo(args: TextToVideoArgs, options?: Options): Pro
 		args.provider === "fal-ai" || args.provider === "replicate" || args.provider === "novita"
 			? { ...omit(args, ["inputs", "parameters"]), ...args.parameters, prompt: args.inputs }
 			: args;
-	const response = await innerRequest<FalAiQueueOutput | ReplicateOutput | NovitaOutput>(payload, {
+	const { data, requestContext } = await innerRequest<FalAiQueueOutput | ReplicateOutput | NovitaOutput>(payload, {
 		...options,
 		task: "text-to-video",
 	});
 
-	const { data, requestContext } = response;
 	if (args.provider === "fal-ai") {
 		return await pollFalResponse(
 			data as FalAiQueueOutput,
diff --git a/packages/inference/src/tasks/cv/zeroShotImageClassification.ts b/packages/inference/src/tasks/cv/zeroShotImageClassification.ts
@@ -45,12 +45,10 @@ export async function zeroShotImageClassification(
 	options?: Options
 ): Promise<ZeroShotImageClassificationOutput> {
 	const payload = await preparePayload(args);
-	const res = (
-		await innerRequest<ZeroShotImageClassificationOutput>(payload, {
-			...options,
-			task: "zero-shot-image-classification",
-		})
-	).data;
+	const { data: res } = await innerRequest<ZeroShotImageClassificationOutput>(payload, {
+		...options,
+		task: "zero-shot-image-classification",
+	});
 	const isValidOutput =
 		Array.isArray(res) && res.every((x) => typeof x.label === "string" && typeof x.score === "number");
 	if (!isValidOutput) {
diff --git a/packages/inference/src/tasks/multimodal/documentQuestionAnswering.ts b/packages/inference/src/tasks/multimodal/documentQuestionAnswering.ts
@@ -28,17 +28,17 @@ export async function documentQuestionAnswering(
 			image: base64FromBytes(new Uint8Array(await args.inputs.image.arrayBuffer())),
 		},
 	} as RequestArgs;
-	const res = toArray(
-		(
-			await innerRequest<DocumentQuestionAnsweringOutput | DocumentQuestionAnsweringOutput[number]>(reqArgs, {
-				...options,
-				task: "document-question-answering",
-			})
-		).data
+	const { data: res } = await innerRequest<DocumentQuestionAnsweringOutput | DocumentQuestionAnsweringOutput[number]>(
+		reqArgs,
+		{
+			...options,
+			task: "document-question-answering",
+		}
 	);
+	const output = toArray(res);
 	const isValidOutput =
-		Array.isArray(res) &&
-		res.every(
+		Array.isArray(output) &&
+		output.every(
 			(elem) =>
 				typeof elem === "object" &&
 				!!elem &&
@@ -51,5 +51,5 @@ export async function documentQuestionAnswering(
 		throw new InferenceOutputError("Expected Array<{answer: string, end?: number, score?: number, start?: number}>");
 	}
 
-	return res[0];
+	return output[0];
 }
diff --git a/packages/inference/src/tasks/multimodal/visualQuestionAnswering.ts b/packages/inference/src/tasks/multimodal/visualQuestionAnswering.ts
@@ -28,12 +28,10 @@ export async function visualQuestionAnswering(
 		},
 	} as RequestArgs;
 
-	const res = (
-		await innerRequest<VisualQuestionAnsweringOutput>(reqArgs, {
-			...options,
-			task: "visual-question-answering",
-		})
-	).data;
+	const { data: res } = await innerRequest<VisualQuestionAnsweringOutput>(reqArgs, {
+		...options,
+		task: "visual-question-answering",
+	});
 
 	const isValidOutput =
 		Array.isArray(res) &&
diff --git a/packages/inference/src/tasks/nlp/chatCompletion.ts b/packages/inference/src/tasks/nlp/chatCompletion.ts
@@ -10,13 +10,11 @@ export async function chatCompletion(
 	args: BaseArgs & ChatCompletionInput,
 	options?: Options
 ): Promise<ChatCompletionOutput> {
-	const res = (
-		await innerRequest<ChatCompletionOutput>(args, {
-			...options,
-			task: "text-generation",
-			chatCompletion: true,
-		})
-	).data;
+	const { data: res } = await innerRequest<ChatCompletionOutput>(args, {
+		...options,
+		task: "text-generation",
+		chatCompletion: true,
+	});
 	const isValidOutput =
 		typeof res === "object" &&
 		Array.isArray(res?.choices) &&
diff --git a/packages/inference/src/tasks/nlp/featureExtraction.ts b/packages/inference/src/tasks/nlp/featureExtraction.ts
@@ -17,12 +17,10 @@ export async function featureExtraction(
 	args: FeatureExtractionArgs,
 	options?: Options
 ): Promise<FeatureExtractionOutput> {
-	const res = (
-		await innerRequest<FeatureExtractionOutput>(args, {
-			...options,
-			task: "feature-extraction",
-		})
-	).data;
+	const { data: res } = await innerRequest<FeatureExtractionOutput>(args, {
+		...options,
+		task: "feature-extraction",
+	});
 	let isValidOutput = true;
 
 	const isNumArrayRec = (arr: unknown[], maxDepth: number, curDepth = 0): boolean => {
diff --git a/packages/inference/src/tasks/nlp/fillMask.ts b/packages/inference/src/tasks/nlp/fillMask.ts
@@ -9,12 +9,10 @@ export type FillMaskArgs = BaseArgs & FillMaskInput;
  * Tries to fill in a hole with a missing word (token to be precise). That’s the base task for BERT models.
  */
 export async function fillMask(args: FillMaskArgs, options?: Options): Promise<FillMaskOutput> {
-	const res = (
-		await innerRequest<FillMaskOutput>(args, {
-			...options,
-			task: "fill-mask",
-		})
-	).data;
+	const { data: res } = await innerRequest<FillMaskOutput>(args, {
+		...options,
+		task: "fill-mask",
+	});
 	const isValidOutput =
 		Array.isArray(res) &&
 		res.every(
diff --git a/packages/inference/src/tasks/nlp/questionAnswering.ts b/packages/inference/src/tasks/nlp/questionAnswering.ts
@@ -12,12 +12,10 @@ export async function questionAnswering(
 	args: QuestionAnsweringArgs,
 	options?: Options
 ): Promise<QuestionAnsweringOutput[number]> {
-	const res = (
-		await innerRequest<QuestionAnsweringOutput | QuestionAnsweringOutput[number]>(args, {
-			...options,
-			task: "question-answering",
-		})
-	).data;
+	const { data: res } = await innerRequest<QuestionAnsweringOutput | QuestionAnsweringOutput[number]>(args, {
+		...options,
+		task: "question-answering",
+	});
 
 	const isValidOutput = Array.isArray(res)
 		? res.every(
diff --git a/packages/inference/src/tasks/nlp/sentenceSimilarity.ts b/packages/inference/src/tasks/nlp/sentenceSimilarity.ts
@@ -12,12 +12,10 @@ export async function sentenceSimilarity(
 	args: SentenceSimilarityArgs,
 	options?: Options
 ): Promise<SentenceSimilarityOutput> {
-	const res = (
-		await innerRequest<SentenceSimilarityOutput>(args, {
-			...options,
-			task: "sentence-similarity",
-		})
-	).data;
+	const { data: res } = await innerRequest<SentenceSimilarityOutput>(args, {
+		...options,
+		task: "sentence-similarity",
+	});
 
 	const isValidOutput = Array.isArray(res) && res.every((x) => typeof x === "number");
 	if (!isValidOutput) {
diff --git a/packages/inference/src/tasks/nlp/summarization.ts b/packages/inference/src/tasks/nlp/summarization.ts
@@ -9,12 +9,10 @@ export type SummarizationArgs = BaseArgs & SummarizationInput;
  * This task is well known to summarize longer text into shorter text. Be careful, some models have a maximum length of input. That means that the summary cannot handle full books for instance. Be careful when choosing your model.
  */
 export async function summarization(args: SummarizationArgs, options?: Options): Promise<SummarizationOutput> {
-	const res = (
-		await innerRequest<SummarizationOutput[]>(args, {
-			...options,
-			task: "summarization",
-		})
-	).data;
+	const { data: res } = await innerRequest<SummarizationOutput[]>(args, {
+		...options,
+		task: "summarization",
+	});
 	const isValidOutput = Array.isArray(res) && res.every((x) => typeof x?.summary_text === "string");
 	if (!isValidOutput) {
 		throw new InferenceOutputError("Expected Array<{summary_text: string}>");
diff --git a/packages/inference/src/tasks/nlp/tableQuestionAnswering.ts b/packages/inference/src/tasks/nlp/tableQuestionAnswering.ts
diff --git a/packages/inference/src/tasks/nlp/textClassification.ts b/packages/inference/src/tasks/nlp/textClassification.ts
diff --git a/packages/inference/src/tasks/nlp/textGeneration.ts b/packages/inference/src/tasks/nlp/textGeneration.ts
diff --git a/packages/inference/src/tasks/nlp/tokenClassification.ts b/packages/inference/src/tasks/nlp/tokenClassification.ts
diff --git a/packages/inference/src/tasks/nlp/translation.ts b/packages/inference/src/tasks/nlp/translation.ts
diff --git a/packages/inference/src/tasks/nlp/zeroShotClassification.ts b/packages/inference/src/tasks/nlp/zeroShotClassification.ts
diff --git a/packages/inference/src/tasks/tabular/tabularClassification.ts b/packages/inference/src/tasks/tabular/tabularClassification.ts
diff --git a/packages/inference/src/tasks/tabular/tabularRegression.ts b/packages/inference/src/tasks/tabular/tabularRegression.ts

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,9 @@ export async function request<T>(`
`14`	`14`	`chatCompletion?: boolean;`
`15`	`15`	`}`
`16`	`16`	`): Promise<T> {`
	`17`	`+ console.warn(`
	`18`	`+ "The request method is deprecated and will be removed in a future version of huggingface.js. Use specific task functions instead."`
	`19`	`+ );`
`17`	`20`	`const result = await innerRequest<T>(args, options);`
`18`	`21`	`return result.data;`
`19`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,5 +13,8 @@ export async function* streamingRequest<T>(`
`13`	`13`	`chatCompletion?: boolean;`
`14`	`14`	`}`
`15`	`15`	`): AsyncGenerator<T> {`
	`16`	`+ console.warn(`
	`17`	`+ "The streamingRequest method is deprecated and will be removed in a future version of huggingface.js. Use specific task functions instead."`
	`18`	`+ );`
`16`	`19`	`yield* innerStreamingRequest(args, options);`
`17`	`20`	`}`