@huggingface/inference 1.5.2 → 1.6.0

package/README.md

@@ -18,7 +18,9 @@ pnpm add @huggingface/inference
 
 ## Usage
 
-❗**Important note:** Using an API key is optional to get started, however you will be rate limited eventually. Join [Hugging Face](https://huggingface.co/join) and then visit [access tokens](https://huggingface.co/settings/tokens) to generate your API key. Note that this API key should be kept private and used exclusively for experimental purposes on the web. If you need to protect it, we suggest setting up a proxy server since we currently do not provide an OAuth solution.
+❗**Important note:** Using an API key is optional to get started, however you will be rate limited eventually. Join [Hugging Face](https://huggingface.co/join) and then visit [access tokens](https://huggingface.co/settings/tokens) to generate your API key for **free**. 
+
+Your API key should be kept private. If you need to protect it in front-end applications, we suggest setting up a proxy server that stores the API key.
 
 ### Basic examples
 
@@ -149,7 +151,7 @@ await hf.textToImage({
 })
 ```
 
-## Supported APIs
+## Supported Tasks
 
 ### Natural Language Processing
 
@@ -184,3 +186,9 @@ await hf.textToImage({
 ```console
 HF_ACCESS_TOKEN="your access token" npm run test
 ```
+
+## Finding appropriate models
+
+We have an informative documentation project called [Tasks](https://huggingface.co/tasks) to list available models for each task and explain how each task works in detail.
+
+It also contain demos, example outputs and other resources should you want to dig more into the ML-side of things.

package/dist/index.d.ts

@@ -453,7 +453,7 @@ type TextToImageArgs = Args & {
      */
     negative_prompt?: string;
 };
-type TextToImageReturn = ArrayBuffer;
+type TextToImageReturn = Blob;
 declare class HfInference {
     private readonly apiKey;
     private readonly defaultOptions;

package/dist/index.js

@@ -185,17 +185,15 @@ var HfInference = class {
         wait_for_model: true
       });
     }
-    let output;
     if (options?.blob) {
       if (!response.ok) {
         throw new Error("An error occurred while fetching the blob");
       }
-      return await response.arrayBuffer();
-    } else {
-      output = await response.json();
-      if (output.error) {
-        throw new Error(output.error);
-      }
+      return await response.blob();
+    }
+    const output = await response.json();
+    if (output.error) {
+      throw new Error(output.error);
     }
     return output;
   }

package/dist/index.mjs

@@ -160,17 +160,15 @@ var HfInference = class {
         wait_for_model: true
       });
     }
-    let output;
     if (options?.blob) {
       if (!response.ok) {
         throw new Error("An error occurred while fetching the blob");
       }
-      return await response.arrayBuffer();
-    } else {
-      output = await response.json();
-      if (output.error) {
-        throw new Error(output.error);
-      }
+      return await response.blob();
+    }
+    const output = await response.json();
+    if (output.error) {
+      throw new Error(output.error);
     }
     return output;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@huggingface/inference",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "license": "MIT",
   "author": "Tim Mikeladze <tim.mikeladze@gmail.com>",
   "description": "Typescript wrapper for the Hugging Face Inference API",

package/src/HfInference.ts

@@ -498,7 +498,7 @@ export type TextToImageArgs = Args & {
 	negative_prompt?: string;
 };
 
-export type TextToImageReturn = ArrayBuffer;
+export type TextToImageReturn = Blob;
 
 export class HfInference {
 	private readonly apiKey:         string;
@@ -712,20 +712,17 @@ export class HfInference {
 			});
 		}
 
-		let output;
-
 		if (options?.blob) {
 			if (!response.ok) {
 				throw new Error("An error occurred while fetching the blob");
 			}
-			return await response.arrayBuffer();
-		} else {
-			output = await response.json();
-			if (output.error) {
-				throw new Error(output.error);
-			}
+			return await response.blob();
 		}
 
+		const output = await response.json();
+		if (output.error) {
+			throw new Error(output.error);
+		}
 		return output;
 	}