@huggingface/inference 1.4.1 → 1.4.2

package/dist/index.js

@@ -0,0 +1,188 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  HuggingFace: () => HuggingFace,
+  default: () => src_default
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/HuggingFace.ts
+var HuggingFace = class {
+  apiKey;
+  defaultOptions;
+  constructor(apiKey, defaultOptions = {}) {
+    this.apiKey = apiKey;
+    this.defaultOptions = defaultOptions;
+  }
+  /**
+   * Tries to fill in a hole with a missing word (token to be precise). That’s the base task for BERT models.
+   */
+  async fillMask(args, options) {
+    return this.request(args, options);
+  }
+  /**
+   * 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.
+   */
+  async summarization(args, options) {
+    return (await this.request(args, options))?.[0];
+  }
+  /**
+   * Want to have a nice know-it-all bot that can answer any question?. Recommended model: deepset/roberta-base-squad2
+   */
+  async questionAnswer(args, options) {
+    return await this.request(args, options);
+  }
+  /**
+   * Don’t know SQL? Don’t want to dive into a large spreadsheet? Ask questions in plain english! Recommended model: google/tapas-base-finetuned-wtq.
+   */
+  async tableQuestionAnswer(args, options) {
+    return await this.request(args, options);
+  }
+  /**
+   * Usually used for sentiment-analysis this will output the likelihood of classes of an input. Recommended model: distilbert-base-uncased-finetuned-sst-2-english
+   */
+  async textClassification(args, options) {
+    return (await this.request(args, options))?.[0];
+  }
+  /**
+   * Use to continue text from a prompt. This is a very generic task. Recommended model: gpt2 (it’s a simple model, but fun to play with).
+   */
+  async textGeneration(args, options) {
+    return (await this.request(args, options))?.[0];
+  }
+  /**
+   * 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));
+  }
+  /**
+   * This task is well known to translate text from one language to another. Recommended model: Helsinki-NLP/opus-mt-ru-en.
+   */
+  async translation(args, options) {
+    return (await this.request(args, options))?.[0];
+  }
+  /**
+   * 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));
+  }
+  /**
+   * 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.
+   *
+   */
+  async conversational(args, options) {
+    return await this.request(args, options);
+  }
+  /**
+   * This task reads some text and outputs raw float values, that are usually consumed as part of a semantic database/semantic search.
+   */
+  async featureExtraction(args, options) {
+    return await this.request(args, options);
+  }
+  /**
+   * This task reads some audio input and outputs the said words within the audio files.
+   * Recommended model (english language): facebook/wav2vec2-large-960h-lv60-self
+   */
+  async automaticSpeechRecognition(args, options) {
+    return await this.request(args, {
+      ...options,
+      binary: true
+    });
+  }
+  /**
+   * This task reads some audio input and outputs the likelihood of classes.
+   * Recommended model:  superb/hubert-large-superb-er
+   */
+  async audioClassification(args, options) {
+    return await this.request(args, {
+      ...options,
+      binary: true
+    });
+  }
+  /**
+   * This task reads some image input and outputs the likelihood of classes.
+   * Recommended model: google/vit-base-patch16-224
+   */
+  async imageClassification(args, options) {
+    return await this.request(args, {
+      ...options,
+      binary: true
+    });
+  }
+  /**
+   * This task reads some image input and outputs the likelihood of classes & bounding boxes of detected objects.
+   * Recommended model: facebook/detr-resnet-50
+   */
+  async objectDetection(args, options) {
+    return await this.request(args, {
+      ...options,
+      binary: true
+    });
+  }
+  /**
+   * This task reads some image input and outputs the likelihood of classes & bounding boxes of detected objects.
+   * Recommended model: facebook/detr-resnet-50-panoptic
+   */
+  async imageSegmentation(args, options) {
+    return await this.request(args, {
+      ...options,
+      binary: true
+    });
+  }
+  async request(args, options) {
+    const mergedOptions = { ...this.defaultOptions, ...options };
+    const { model, ...otherArgs } = args;
+    const response = await fetch(`https://api-inference.huggingface.co/models/${model}`, {
+      headers: { Authorization: `Bearer ${this.apiKey}` },
+      method: "POST",
+      body: options?.binary ? args.data : JSON.stringify({
+        ...otherArgs,
+        options: mergedOptions
+      })
+    });
+    if (mergedOptions.retry_on_error !== false && response.status === 503 && !mergedOptions.wait_for_model) {
+      return this.request(args, {
+        ...mergedOptions,
+        wait_for_model: true
+      });
+    }
+    const res = await response.json();
+    if (res.error) {
+      throw new Error(res.error);
+    }
+    return res;
+  }
+  static toArray(obj) {
+    if (Array.isArray(obj)) {
+      return obj;
+    }
+    return [obj];
+  }
+};
+
+// src/index.ts
+var src_default = HuggingFace;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  HuggingFace
+});

package/dist/index.mjs

@@ -0,0 +1,162 @@
+// src/HuggingFace.ts
+var HuggingFace = class {
+  apiKey;
+  defaultOptions;
+  constructor(apiKey, defaultOptions = {}) {
+    this.apiKey = apiKey;
+    this.defaultOptions = defaultOptions;
+  }
+  /**
+   * Tries to fill in a hole with a missing word (token to be precise). That’s the base task for BERT models.
+   */
+  async fillMask(args, options) {
+    return this.request(args, options);
+  }
+  /**
+   * 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.
+   */
+  async summarization(args, options) {
+    return (await this.request(args, options))?.[0];
+  }
+  /**
+   * Want to have a nice know-it-all bot that can answer any question?. Recommended model: deepset/roberta-base-squad2
+   */
+  async questionAnswer(args, options) {
+    return await this.request(args, options);
+  }
+  /**
+   * Don’t know SQL? Don’t want to dive into a large spreadsheet? Ask questions in plain english! Recommended model: google/tapas-base-finetuned-wtq.
+   */
+  async tableQuestionAnswer(args, options) {
+    return await this.request(args, options);
+  }
+  /**
+   * Usually used for sentiment-analysis this will output the likelihood of classes of an input. Recommended model: distilbert-base-uncased-finetuned-sst-2-english
+   */
+  async textClassification(args, options) {
+    return (await this.request(args, options))?.[0];
+  }
+  /**
+   * Use to continue text from a prompt. This is a very generic task. Recommended model: gpt2 (it’s a simple model, but fun to play with).
+   */
+  async textGeneration(args, options) {
+    return (await this.request(args, options))?.[0];
+  }
+  /**
+   * 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));
+  }
+  /**
+   * This task is well known to translate text from one language to another. Recommended model: Helsinki-NLP/opus-mt-ru-en.
+   */
+  async translation(args, options) {
+    return (await this.request(args, options))?.[0];
+  }
+  /**
+   * 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));
+  }
+  /**
+   * 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.
+   *
+   */
+  async conversational(args, options) {
+    return await this.request(args, options);
+  }
+  /**
+   * This task reads some text and outputs raw float values, that are usually consumed as part of a semantic database/semantic search.
+   */
+  async featureExtraction(args, options) {
+    return await this.request(args, options);
+  }
+  /**
+   * This task reads some audio input and outputs the said words within the audio files.
+   * Recommended model (english language): facebook/wav2vec2-large-960h-lv60-self
+   */
+  async automaticSpeechRecognition(args, options) {
+    return await this.request(args, {
+      ...options,
+      binary: true
+    });
+  }
+  /**
+   * This task reads some audio input and outputs the likelihood of classes.
+   * Recommended model:  superb/hubert-large-superb-er
+   */
+  async audioClassification(args, options) {
+    return await this.request(args, {
+      ...options,
+      binary: true
+    });
+  }
+  /**
+   * This task reads some image input and outputs the likelihood of classes.
+   * Recommended model: google/vit-base-patch16-224
+   */
+  async imageClassification(args, options) {
+    return await this.request(args, {
+      ...options,
+      binary: true
+    });
+  }
+  /**
+   * This task reads some image input and outputs the likelihood of classes & bounding boxes of detected objects.
+   * Recommended model: facebook/detr-resnet-50
+   */
+  async objectDetection(args, options) {
+    return await this.request(args, {
+      ...options,
+      binary: true
+    });
+  }
+  /**
+   * This task reads some image input and outputs the likelihood of classes & bounding boxes of detected objects.
+   * Recommended model: facebook/detr-resnet-50-panoptic
+   */
+  async imageSegmentation(args, options) {
+    return await this.request(args, {
+      ...options,
+      binary: true
+    });
+  }
+  async request(args, options) {
+    const mergedOptions = { ...this.defaultOptions, ...options };
+    const { model, ...otherArgs } = args;
+    const response = await fetch(`https://api-inference.huggingface.co/models/${model}`, {
+      headers: { Authorization: `Bearer ${this.apiKey}` },
+      method: "POST",
+      body: options?.binary ? args.data : JSON.stringify({
+        ...otherArgs,
+        options: mergedOptions
+      })
+    });
+    if (mergedOptions.retry_on_error !== false && response.status === 503 && !mergedOptions.wait_for_model) {
+      return this.request(args, {
+        ...mergedOptions,
+        wait_for_model: true
+      });
+    }
+    const res = await response.json();
+    if (res.error) {
+      throw new Error(res.error);
+    }
+    return res;
+  }
+  static toArray(obj) {
+    if (Array.isArray(obj)) {
+      return obj;
+    }
+    return [obj];
+  }
+};
+
+// src/index.ts
+var src_default = HuggingFace;
+export {
+  HuggingFace,
+  src_default as default
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@huggingface/inference",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "license": "MIT",
   "author": "Tim Mikeladze <tim.mikeladze@gmail.com>",
   "description": "Typescript wrapper for the Hugging Face Inference API",
@@ -21,11 +21,11 @@
     "ai"
   ],
   "engines": {
-    "node": ">=14"
+    "node": ">=18"
   },
   "files": [
-    "./dist",
-    "./src"
+    "dist",
+    "src"
   ],
   "source": "src/index.ts",
   "types": "dist/index.d.ts",