@huggingface/inference 2.1.0 → 2.1.2

package/dist/index.js

@@ -116,7 +116,7 @@ function makeRequestOptions(args, options) {
 // src/tasks/custom/request.ts
 async function request(args, options) {
   const { url, info } = makeRequestOptions(args, options);
-  const response = await fetch(url, info);
+  const response = await (options?.fetch ?? fetch)(url, info);
   if (options?.retry_on_error !== false && response.status === 503 && !options?.wait_for_model) {
     return request(args, {
       ...options,
@@ -240,7 +240,7 @@ function newMessage() {
 // src/tasks/custom/streamingRequest.ts
 async function* streamingRequest(args, options) {
   const { url, info } = makeRequestOptions({ ...args, stream: true }, options);
-  const response = await fetch(url, info);
+  const response = await (options?.fetch ?? fetch)(url, info);
   if (options?.retry_on_error !== false && response.status === 503 && !options?.wait_for_model) {
     return streamingRequest(args, {
       ...options,
@@ -433,7 +433,7 @@ async function fillMask(args, options) {
 // src/tasks/nlp/questionAnswering.ts
 async function questionAnswering(args, options) {
   const res = await request(args, options);
-  const isValidOutput = typeof res?.answer === "string" && typeof res.end === "number" && typeof res.score === "number" && typeof res.start === "number";
+  const isValidOutput = typeof res === "object" && !!res && typeof res.answer === "string" && typeof res.end === "number" && typeof res.score === "number" && typeof res.start === "number";
   if (!isValidOutput) {
     throw new InferenceOutputError("Expected {answer: string, end: number, score: number, start: number}");
   }
@@ -566,10 +566,12 @@ async function documentQuestionAnswering(args, options) {
       image: base64FromBytes(new Uint8Array(await args.inputs.image.arrayBuffer()))
     }
   };
-  const res = (await request(reqArgs, options))?.[0];
-  const isValidOutput = typeof res?.answer === "string" && typeof res.end === "number" && typeof res.score === "number" && typeof res.start === "number";
+  const res = toArray(
+    await request(reqArgs, options)
+  )?.[0];
+  const isValidOutput = typeof res?.answer === "string" && (typeof res.end === "number" || typeof res.end === "undefined") && (typeof res.score === "number" || typeof res.score === "undefined") && (typeof res.start === "number" || typeof res.start === "undefined");
   if (!isValidOutput) {
-    throw new InferenceOutputError("Expected Array<{answer: string, end: number, score: number, start: number}>");
+    throw new InferenceOutputError("Expected Array<{answer: string, end?: number, score?: number, start?: number}>");
   }
   return res;
 }

package/dist/index.mjs

@@ -71,7 +71,7 @@ function makeRequestOptions(args, options) {
 // src/tasks/custom/request.ts
 async function request(args, options) {
   const { url, info } = makeRequestOptions(args, options);
-  const response = await fetch(url, info);
+  const response = await (options?.fetch ?? fetch)(url, info);
   if (options?.retry_on_error !== false && response.status === 503 && !options?.wait_for_model) {
     return request(args, {
       ...options,
@@ -195,7 +195,7 @@ function newMessage() {
 // src/tasks/custom/streamingRequest.ts
 async function* streamingRequest(args, options) {
   const { url, info } = makeRequestOptions({ ...args, stream: true }, options);
-  const response = await fetch(url, info);
+  const response = await (options?.fetch ?? fetch)(url, info);
   if (options?.retry_on_error !== false && response.status === 503 && !options?.wait_for_model) {
     return streamingRequest(args, {
       ...options,
@@ -388,7 +388,7 @@ async function fillMask(args, options) {
 // src/tasks/nlp/questionAnswering.ts
 async function questionAnswering(args, options) {
   const res = await request(args, options);
-  const isValidOutput = typeof res?.answer === "string" && typeof res.end === "number" && typeof res.score === "number" && typeof res.start === "number";
+  const isValidOutput = typeof res === "object" && !!res && typeof res.answer === "string" && typeof res.end === "number" && typeof res.score === "number" && typeof res.start === "number";
   if (!isValidOutput) {
     throw new InferenceOutputError("Expected {answer: string, end: number, score: number, start: number}");
   }
@@ -521,10 +521,12 @@ async function documentQuestionAnswering(args, options) {
       image: base64FromBytes(new Uint8Array(await args.inputs.image.arrayBuffer()))
     }
   };
-  const res = (await request(reqArgs, options))?.[0];
-  const isValidOutput = typeof res?.answer === "string" && typeof res.end === "number" && typeof res.score === "number" && typeof res.start === "number";
+  const res = toArray(
+    await request(reqArgs, options)
+  )?.[0];
+  const isValidOutput = typeof res?.answer === "string" && (typeof res.end === "number" || typeof res.end === "undefined") && (typeof res.score === "number" || typeof res.score === "undefined") && (typeof res.start === "number" || typeof res.start === "undefined");
   if (!isValidOutput) {
-    throw new InferenceOutputError("Expected Array<{answer: string, end: number, score: number, start: number}>");
+    throw new InferenceOutputError("Expected Array<{answer: string, end?: number, score?: number, start?: number}>");
   }
   return res;
 }

package/package.json

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

package/src/tasks/custom/request.ts

@@ -12,7 +12,7 @@ export async function request<T>(
 	}
 ): Promise<T> {
 	const { url, info } = makeRequestOptions(args, options);
-	const response = await fetch(url, info);
+	const response = await (options?.fetch ?? fetch)(url, info);
 
 	if (options?.retry_on_error !== false && response.status === 503 && !options?.wait_for_model) {
 		return request(args, {

package/src/tasks/custom/streamingRequest.ts

@@ -14,7 +14,7 @@ export async function* streamingRequest<T>(
 	}
 ): AsyncGenerator<T> {
 	const { url, info } = makeRequestOptions({ ...args, stream: true }, options);
-	const response = await fetch(url, info);
+	const response = await (options?.fetch ?? fetch)(url, info);
 
 	if (options?.retry_on_error !== false && response.status === 503 && !options?.wait_for_model) {
 		return streamingRequest(args, {

package/src/tasks/multimodal/documentQuestionAnswering.ts

@@ -3,6 +3,7 @@ import type { BaseArgs, Options } from "../../types";
 import { request } from "../custom/request";
 import type { RequestArgs } from "../../types";
 import { base64FromBytes } from "../../../../shared/src/base64FromBytes";
+import { toArray } from "../../utils/toArray";
 
 export type DocumentQuestionAnsweringArgs = BaseArgs & {
 	inputs: {
@@ -24,15 +25,15 @@ export interface DocumentQuestionAnsweringOutput {
 	/**
 	 * ?
 	 */
-	end: number;
+	end?: number;
 	/**
 	 * A float that represents how likely that the answer is correct
 	 */
-	score: number;
+	score?: number;
 	/**
 	 * ?
 	 */
-	start: number;
+	start?: number;
 }
 
 /**
@@ -50,14 +51,16 @@ export async function documentQuestionAnswering(
 			image: base64FromBytes(new Uint8Array(await args.inputs.image.arrayBuffer())),
 		},
 	} as RequestArgs;
-	const res = (await request<[DocumentQuestionAnsweringOutput]>(reqArgs, options))?.[0];
+	const res = toArray(
+		await request<[DocumentQuestionAnsweringOutput] | DocumentQuestionAnsweringOutput>(reqArgs, options)
+	)?.[0];
 	const isValidOutput =
 		typeof res?.answer === "string" &&
-		typeof res.end === "number" &&
-		typeof res.score === "number" &&
-		typeof res.start === "number";
+		(typeof res.end === "number" || typeof res.end === "undefined") &&
+		(typeof res.score === "number" || typeof res.score === "undefined") &&
+		(typeof res.start === "number" || typeof res.start === "undefined");
 	if (!isValidOutput) {
-		throw new InferenceOutputError("Expected Array<{answer: string, end: number, score: number, start: number}>");
+		throw new InferenceOutputError("Expected Array<{answer: string, end?: number, score?: number, start?: number}>");
 	}
 	return res;
 }

package/src/tasks/nlp/questionAnswering.ts

@@ -37,7 +37,9 @@ export async function questionAnswering(
 ): Promise<QuestionAnsweringOutput> {
 	const res = await request<QuestionAnsweringOutput>(args, options);
 	const isValidOutput =
-		typeof res?.answer === "string" &&
+		typeof res === "object" &&
+		!!res &&
+		typeof res.answer === "string" &&
 		typeof res.end === "number" &&
 		typeof res.score === "number" &&
 		typeof res.start === "number";

package/src/types.ts

@@ -20,6 +20,10 @@ export interface Options {
 	 * (Default: false) Boolean. If the model is not ready, wait for it instead of receiving 503. It limits the number of requests required to get your inference done. It is advised to only set this flag to true after receiving a 503 error as it will limit hanging in your application to known places.
 	 */
 	wait_for_model?: boolean;
+	/**
+	 * Custom fetch function to use instead of the default one, for example to use a proxy or edit headers.
+	 */
+	fetch?: typeof fetch;
 }
 
 export interface BaseArgs {