@huggingface/inference 2.6.2 → 2.6.4

package/README.md

@@ -190,7 +190,7 @@ await hf.imageToText({
 })
 
 await hf.imageToImage({
-  inputs: readFileSync("test/stormtrooper_depth.png"),
+  inputs: new Blob([readFileSync("test/stormtrooper_depth.png")]),
   parameters: {
     prompt: "elmo's lecture",
   },

package/dist/index.d.ts

@@ -24,6 +24,10 @@ export interface Options {
 	 * Custom fetch function to use instead of the default one, for example to use a proxy or edit headers.
 	 */
 	fetch?: typeof fetch;
+	/**
+	 * Abort Controller signal to use for request interruption.
+	 */
+	signal?: AbortSignal;
 
 	/**
 	 * (Default: "same-origin"). String | Boolean. Credentials to use for the request. If this is a string, it will be passed straight on. If it's a boolean, true will be "include" and false will not send credentials at all.
@@ -786,6 +790,10 @@ export type TextGenerationArgs = BaseArgs & {
 		 * (Default: None). Integer. The maximum number of tokens from the input.
 		 */
 		truncate?: number;
+		/**
+		 * (Default: []) List of strings. The model will stop generating text when one of the strings in the list is generated.
+		 * **/
+		stop_sequences?: string[];
 	};
 };
 export interface TextGenerationOutput {

package/dist/index.js

@@ -102,7 +102,7 @@ var taskCache = /* @__PURE__ */ new Map();
 var CACHE_DURATION = 10 * 60 * 1e3;
 var MAX_CACHE_ITEMS = 1e3;
 var HF_HUB_URL = "https://huggingface.co";
-async function getDefaultTask(model, accessToken) {
+async function getDefaultTask(model, accessToken, options) {
   if (isUrl(model)) {
     return null;
   }
@@ -113,7 +113,7 @@ async function getDefaultTask(model, accessToken) {
     cachedTask = void 0;
   }
   if (cachedTask === void 0) {
-    const modelTask = await fetch(`${HF_HUB_URL}/api/models/${model}?expand[]=pipeline_tag`, {
+    const modelTask = await (options?.fetch ?? fetch)(`${HF_HUB_URL}/api/models/${model}?expand[]=pipeline_tag`, {
       headers: accessToken ? { Authorization: `Bearer ${accessToken}` } : {}
     }).then((resp) => resp.json()).then((json) => json.pipeline_tag).catch(() => null);
     if (!modelTask) {
@@ -192,7 +192,8 @@ async function makeRequestOptions(args, options) {
       ...otherArgs,
       options: options && otherOptions
     }),
-    credentials
+    credentials,
+    signal: options?.signal
   };
   return { url, info };
 }
@@ -598,7 +599,7 @@ async function conversational(args, options) {
 
 // src/tasks/nlp/featureExtraction.ts
 async function featureExtraction(args, options) {
-  const defaultTask = args.model ? await getDefaultTask(args.model, args.accessToken) : void 0;
+  const defaultTask = args.model ? await getDefaultTask(args.model, args.accessToken, options) : void 0;
   const res = await request(args, {
     ...options,
     taskHint: "feature-extraction",
@@ -653,7 +654,7 @@ async function questionAnswering(args, options) {
 
 // src/tasks/nlp/sentenceSimilarity.ts
 async function sentenceSimilarity(args, options) {
-  const defaultTask = args.model ? await getDefaultTask(args.model, args.accessToken) : void 0;
+  const defaultTask = args.model ? await getDefaultTask(args.model, args.accessToken, options) : void 0;
   const res = await request(args, {
     ...options,
     taskHint: "sentence-similarity",

package/dist/index.mjs

@@ -50,7 +50,7 @@ var taskCache = /* @__PURE__ */ new Map();
 var CACHE_DURATION = 10 * 60 * 1e3;
 var MAX_CACHE_ITEMS = 1e3;
 var HF_HUB_URL = "https://huggingface.co";
-async function getDefaultTask(model, accessToken) {
+async function getDefaultTask(model, accessToken, options) {
   if (isUrl(model)) {
     return null;
   }
@@ -61,7 +61,7 @@ async function getDefaultTask(model, accessToken) {
     cachedTask = void 0;
   }
   if (cachedTask === void 0) {
-    const modelTask = await fetch(`${HF_HUB_URL}/api/models/${model}?expand[]=pipeline_tag`, {
+    const modelTask = await (options?.fetch ?? fetch)(`${HF_HUB_URL}/api/models/${model}?expand[]=pipeline_tag`, {
       headers: accessToken ? { Authorization: `Bearer ${accessToken}` } : {}
     }).then((resp) => resp.json()).then((json) => json.pipeline_tag).catch(() => null);
     if (!modelTask) {
@@ -140,7 +140,8 @@ async function makeRequestOptions(args, options) {
       ...otherArgs,
       options: options && otherOptions
     }),
-    credentials
+    credentials,
+    signal: options?.signal
   };
   return { url, info };
 }
@@ -546,7 +547,7 @@ async function conversational(args, options) {
 
 // src/tasks/nlp/featureExtraction.ts
 async function featureExtraction(args, options) {
-  const defaultTask = args.model ? await getDefaultTask(args.model, args.accessToken) : void 0;
+  const defaultTask = args.model ? await getDefaultTask(args.model, args.accessToken, options) : void 0;
   const res = await request(args, {
     ...options,
     taskHint: "feature-extraction",
@@ -601,7 +602,7 @@ async function questionAnswering(args, options) {
 
 // src/tasks/nlp/sentenceSimilarity.ts
 async function sentenceSimilarity(args, options) {
-  const defaultTask = args.model ? await getDefaultTask(args.model, args.accessToken) : void 0;
+  const defaultTask = args.model ? await getDefaultTask(args.model, args.accessToken, options) : void 0;
   const res = await request(args, {
     ...options,
     taskHint: "sentence-similarity",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@huggingface/inference",
-  "version": "2.6.2",
+  "version": "2.6.4",
   "packageManager": "pnpm@8.3.1",
   "license": "MIT",
   "author": "Tim Mikeladze <tim.mikeladze@gmail.com>",

package/src/lib/getDefaultTask.ts

@@ -10,13 +10,21 @@ const CACHE_DURATION = 10 * 60 * 1000;
 const MAX_CACHE_ITEMS = 1000;
 export const HF_HUB_URL = "https://huggingface.co";
 
+export interface DefaultTaskOptions {
+	fetch?: typeof fetch;
+}
+
 /**
  * Get the default task. Use a LRU cache of 1000 items with 10 minutes expiration
  * to avoid making too many calls to the HF hub.
  *
  * @returns The default task for the model, or `null` if it was impossible to get it
  */
-export async function getDefaultTask(model: string, accessToken: string | undefined): Promise<string | null> {
+export async function getDefaultTask(
+	model: string,
+	accessToken: string | undefined,
+	options?: DefaultTaskOptions
+): Promise<string | null> {
 	if (isUrl(model)) {
 		return null;
 	}
@@ -30,7 +38,7 @@ export async function getDefaultTask(model: string, accessToken: string | undefi
 	}
 
 	if (cachedTask === undefined) {
-		const modelTask = await fetch(`${HF_HUB_URL}/api/models/${model}?expand[]=pipeline_tag`, {
+		const modelTask = await (options?.fetch ?? fetch)(`${HF_HUB_URL}/api/models/${model}?expand[]=pipeline_tag`, {
 			headers: accessToken ? { Authorization: `Bearer ${accessToken}` } : {},
 		})
 			.then((resp) => resp.json())

package/src/lib/makeRequestOptions.ts

@@ -106,6 +106,7 @@ export async function makeRequestOptions(
 					options: options && otherOptions,
 			  }),
 		credentials,
+		signal: options?.signal,
 	};
 
 	return { url, info };

package/src/tasks/nlp/featureExtraction.ts

@@ -25,7 +25,7 @@ export async function featureExtraction(
 	args: FeatureExtractionArgs,
 	options?: Options
 ): Promise<FeatureExtractionOutput> {
-	const defaultTask = args.model ? await getDefaultTask(args.model, args.accessToken) : undefined;
+	const defaultTask = args.model ? await getDefaultTask(args.model, args.accessToken, options) : undefined;
 
 	const res = await request<FeatureExtractionOutput>(args, {
 		...options,

package/src/tasks/nlp/sentenceSimilarity.ts

@@ -25,7 +25,7 @@ export async function sentenceSimilarity(
 	args: SentenceSimilarityArgs,
 	options?: Options
 ): Promise<SentenceSimilarityOutput> {
-	const defaultTask = args.model ? await getDefaultTask(args.model, args.accessToken) : undefined;
+	const defaultTask = args.model ? await getDefaultTask(args.model, args.accessToken, options) : undefined;
 	const res = await request<SentenceSimilarityOutput>(args, {
 		...options,
 		taskHint: "sentence-similarity",

package/src/tasks/nlp/textGeneration.ts

@@ -48,6 +48,10 @@ export type TextGenerationArgs = BaseArgs & {
 		 * (Default: None). Integer. The maximum number of tokens from the input.
 		 */
 		truncate?: number;
+		/**
+		 * (Default: []) List of strings. The model will stop generating text when one of the strings in the list is generated.
+		 * **/
+		stop_sequences?: string[];
 	};
 };
 

package/src/types.ts

@@ -24,6 +24,10 @@ export interface Options {
 	 * Custom fetch function to use instead of the default one, for example to use a proxy or edit headers.
 	 */
 	fetch?: typeof fetch;
+	/**
+	 * Abort Controller signal to use for request interruption.
+	 */
+	signal?: AbortSignal;
 
 	/**
 	 * (Default: "same-origin"). String | Boolean. Credentials to use for the request. If this is a string, it will be passed straight on. If it's a boolean, true will be "include" and false will not send credentials at all.