🏷️ Fix typing of request & streaming request

Author: coyotte508

packages/inference/src/HfInference.ts

@@ -1,18 +1,19 @@
 import * as tasks from "./tasks";
 import type { Options, RequestArgs } from "./types";
+import type { DistributiveOmit } from "./utils/distributive-omit";
 
 type Task = typeof tasks;
 
 type TaskWithNoAccessToken = {
 	[key in keyof Task]: (
-		args: Omit<Parameters<Task[key]>[0], "accessToken">,
+		args: DistributiveOmit<Parameters<Task[key]>[0], "accessToken">,
 		options?: Parameters<Task[key]>[1]
 	) => ReturnType<Task[key]>;
 };
 
 type TaskWithNoAccessTokenNoModel = {
 	[key in keyof Task]: (
-		args: Omit<Parameters<Task[key]>[0], "accessToken" | "model">,
+		args: DistributiveOmit<Parameters<Task[key]>[0], "accessToken" | "model">,
 		options?: Parameters<Task[key]>[1]
 	) => ReturnType<Task[key]>;
 };
@@ -51,7 +52,7 @@ export class HfInferenceEndpoint {
 		for (const [name, fn] of Object.entries(tasks)) {
 			Object.defineProperty(this, name, {
 				enumerable: false,
-				value: (params: Omit<RequestArgs, "model">, options: Options) =>
+				value: (params: RequestArgs, options: Options) =>
 					// eslint-disable-next-line @typescript-eslint/no-explicit-any
 					fn({ ...params, accessToken, model: endpointUrl } as any, { ...defaultOptions, ...options }),
 			});

packages/inference/src/types.ts

@@ -36,7 +36,7 @@ export interface BaseArgs {
 }
 
 export type RequestArgs = BaseArgs &
-	({ data?: Blob | ArrayBuffer } | { inputs: unknown }) & {
+	({ data: Blob | ArrayBuffer } | { inputs: unknown }) & {
 		parameters?: Record<string, unknown>;
 		accessToken?: string;
 	};

packages/inference/src/utils/distributive-omit.d.ts

@@ -0,0 +1,15 @@
+// https://dev.to/safareli/pick-omit-and-union-types-in-typescript-4nd9
+// https://github.com/microsoft/TypeScript/issues/28339#issuecomment-467393437
+/**
+ * This allows omitting keys from objects inside unions, without merging the individual components of the union.
+ */
+
+type Keys<T> = keyof T;
+type DistributiveKeys<T> = T extends unknown ? Keys<T> : never;
+type Omit_<T, K> = Omit<T, Extract<keyof T, K>>;
+
+export type DistributiveOmit<T, K> = T extends unknown
+	? keyof Omit_<T, K> extends never
+		? never
+		: { [P in keyof Omit_<T, K>]: Omit_<T, K>[P] }
+	: never;

packages/inference/test/HfInference.spec.ts

@@ -397,6 +397,18 @@ describe.concurrent(
 				generated_text: "a large brown and white giraffe standing in a field ",
 			});
 		});
+		it("request - google/flan-t5-xxl", async () => {
+			expect(
+				await hf.request({
+					model: "google/flan-t5-xxl",
+					inputs: "one plus two equals",
+				})
+			).toMatchObject([
+				{
+					generated_text: expect.any(String),
+				},
+			]);
+		});
 		it("endpoint - makes request to specified endpoint", async () => {
 			const ep = hf.endpoint("https://api-inference.huggingface.co/models/google/flan-t5-xxl");
 			const { generated_text } = await ep.textGeneration({

packages/inference/test/tapes.json

@@ -143,6 +143,7 @@ async function vcr(
 			init: {
 				headers: omit(init.headers as Record<string, string>, "Authorization"),
 				method: init.method,
+				body: typeof init.body === "string" && init.body.length < 1_000 ? init.body : undefined,
 			},
 			response: {
 				body: isText ? new TextDecoder().decode(arrayBuffer) : "",