@huggingface/inference 1.4.2 → 1.4.3

package/README.md

@@ -19,9 +19,9 @@ pnpm add @huggingface/inference
 ### Basic examples
 
 ```typescript
-import HuggingFace from 'huggingface'
+import { HfInference } from '@huggingface/inference'
 
-const hf = new HuggingFace('your api key')
+const hf = new HfInference('your api key')
 
 // Natural Language
 
@@ -177,7 +177,7 @@ HF_ACCESS_TOKEN="your access token" npm run test
 ## Options
 
 ```typescript
-export declare class HuggingFace {
+export declare class HfInference {
   private readonly apiKey
   private readonly defaultOptions
   constructor(apiKey: string, defaultOptions?: Options)

package/dist/index.d.ts

@@ -442,7 +442,7 @@ type AudioClassificationReturnValue = {
     score: number;
 };
 type AudioClassificationReturn = AudioClassificationReturnValue[];
-declare class HuggingFace {
+declare class HfInference {
     private readonly apiKey;
     private readonly defaultOptions;
     constructor(apiKey: string, defaultOptions?: Options);
@@ -524,4 +524,4 @@ declare class HuggingFace {
     private static toArray;
 }
 
-export { Args, AudioClassificationArgs, AudioClassificationReturn, AudioClassificationReturnValue, AutomaticSpeechRecognitionArgs, AutomaticSpeechRecognitionReturn, ConversationalArgs, ConversationalReturn, FeatureExtractionArgs, FeatureExtractionReturn, FillMaskArgs, FillMaskReturn, HuggingFace, ImageClassificationArgs, ImageClassificationReturn, ImageClassificationReturnValue, ImageSegmentationArgs, ImageSegmentationReturn, ImageSegmentationReturnValue, ObjectDetectionArgs, ObjectDetectionReturn, ObjectDetectionReturnValue, Options, QuestionAnswerArgs, QuestionAnswerReturn, SummarizationArgs, SummarizationReturn, TableQuestionAnswerArgs, TableQuestionAnswerReturn, TextClassificationArgs, TextClassificationReturn, TextGenerationArgs, TextGenerationReturn, TokenClassificationArgs, TokenClassificationReturn, TokenClassificationReturnValue, TranslationArgs, TranslationReturn, ZeroShotClassificationArgs, ZeroShotClassificationReturn, ZeroShotClassificationReturnValue, HuggingFace as default };
+export { Args, AudioClassificationArgs, AudioClassificationReturn, AudioClassificationReturnValue, AutomaticSpeechRecognitionArgs, AutomaticSpeechRecognitionReturn, ConversationalArgs, ConversationalReturn, FeatureExtractionArgs, FeatureExtractionReturn, FillMaskArgs, FillMaskReturn, HfInference, ImageClassificationArgs, ImageClassificationReturn, ImageClassificationReturnValue, ImageSegmentationArgs, ImageSegmentationReturn, ImageSegmentationReturnValue, ObjectDetectionArgs, ObjectDetectionReturn, ObjectDetectionReturnValue, Options, QuestionAnswerArgs, QuestionAnswerReturn, SummarizationArgs, SummarizationReturn, TableQuestionAnswerArgs, TableQuestionAnswerReturn, TextClassificationArgs, TextClassificationReturn, TextGenerationArgs, TextGenerationReturn, TokenClassificationArgs, TokenClassificationReturn, TokenClassificationReturnValue, TranslationArgs, TranslationReturn, ZeroShotClassificationArgs, ZeroShotClassificationReturn, ZeroShotClassificationReturnValue };

package/dist/index.js

@@ -19,13 +19,12 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  HuggingFace: () => HuggingFace,
-  default: () => src_default
+  HfInference: () => HfInference
 });
 module.exports = __toCommonJS(src_exports);
 
-// src/HuggingFace.ts
-var HuggingFace = class {
+// src/HfInference.ts
+var HfInference = class {
   apiKey;
   defaultOptions;
   constructor(apiKey, defaultOptions = {}) {
@@ -72,7 +71,7 @@ var HuggingFace = class {
    * Usually used for sentence parsing, either grammatical, or Named Entity Recognition (NER) to understand keywords contained within text. Recommended model: dbmdz/bert-large-cased-finetuned-conll03-english
    */
   async tokenClassification(args, options) {
-    return HuggingFace.toArray(await this.request(args, options));
+    return HfInference.toArray(await this.request(args, options));
   }
   /**
    * This task is well known to translate text from one language to another. Recommended model: Helsinki-NLP/opus-mt-ru-en.
@@ -84,7 +83,7 @@ var HuggingFace = class {
    * This task is super useful to try out classification with zero code, you simply pass a sentence/paragraph and the possible labels for that sentence, and you get a result. Recommended model: facebook/bart-large-mnli.
    */
   async zeroShotClassification(args, options) {
-    return HuggingFace.toArray(await this.request(args, options));
+    return HfInference.toArray(await this.request(args, options));
   }
   /**
    * This task corresponds to any chatbot like structure. Models tend to have shorter max_length, so please check with caution when using a given model if you need long range dependency or not. Recommended model: microsoft/DialoGPT-large.
@@ -179,10 +178,7 @@ var HuggingFace = class {
     return [obj];
   }
 };
-
-// src/index.ts
-var src_default = HuggingFace;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  HuggingFace
+  HfInference
 });

package/dist/index.mjs

@@ -1,5 +1,5 @@
-// src/HuggingFace.ts
-var HuggingFace = class {
+// src/HfInference.ts
+var HfInference = class {
   apiKey;
   defaultOptions;
   constructor(apiKey, defaultOptions = {}) {
@@ -46,7 +46,7 @@ var HuggingFace = class {
    * Usually used for sentence parsing, either grammatical, or Named Entity Recognition (NER) to understand keywords contained within text. Recommended model: dbmdz/bert-large-cased-finetuned-conll03-english
    */
   async tokenClassification(args, options) {
-    return HuggingFace.toArray(await this.request(args, options));
+    return HfInference.toArray(await this.request(args, options));
   }
   /**
    * This task is well known to translate text from one language to another. Recommended model: Helsinki-NLP/opus-mt-ru-en.
@@ -58,7 +58,7 @@ var HuggingFace = class {
    * This task is super useful to try out classification with zero code, you simply pass a sentence/paragraph and the possible labels for that sentence, and you get a result. Recommended model: facebook/bart-large-mnli.
    */
   async zeroShotClassification(args, options) {
-    return HuggingFace.toArray(await this.request(args, options));
+    return HfInference.toArray(await this.request(args, options));
   }
   /**
    * This task corresponds to any chatbot like structure. Models tend to have shorter max_length, so please check with caution when using a given model if you need long range dependency or not. Recommended model: microsoft/DialoGPT-large.
@@ -153,10 +153,6 @@ var HuggingFace = class {
     return [obj];
   }
 };
-
-// src/index.ts
-var src_default = HuggingFace;
 export {
-  HuggingFace,
-  src_default as default
+  HfInference
 };

package/package.json

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

package/src/{HuggingFace.ts → HfInference.ts}

@@ -485,7 +485,7 @@ export type AudioClassificationReturnValue = {
 
 export type AudioClassificationReturn = AudioClassificationReturnValue[];
 
-export class HuggingFace {
+export class HfInference {
 	private readonly apiKey:         string;
 	private readonly defaultOptions: Options;
 
@@ -546,7 +546,7 @@ export class HuggingFace {
 		args: TokenClassificationArgs,
 		options?: Options
 	): Promise<TokenClassificationReturn> {
-		return HuggingFace.toArray(await this.request(args, options));
+		return HfInference.toArray(await this.request(args, options));
 	}
 
 	/**
@@ -563,7 +563,7 @@ export class HuggingFace {
 		args: ZeroShotClassificationArgs,
 		options?: Options
 	): Promise<ZeroShotClassificationReturn> {
-		return HuggingFace.toArray(await this.request(args, options));
+		return HfInference.toArray(await this.request(args, options));
 	}
 
 	/**

package/src/index.ts

@@ -1,3 +1 @@
-import { HuggingFace } from "./HuggingFace";
-export * from "./HuggingFace";
-export default HuggingFace;
+export * from "./HfInference";