@huggingface/inference 3.6.1 → 3.6.2

package/src/providers/fal-ai.ts

@@ -14,9 +14,17 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import { InferenceOutputError } from "../lib/InferenceOutputError";
+import { isUrl } from "../lib/isUrl";
+import type { BodyParams, HeaderParams, InferenceTask, ProviderConfig, UrlParams } from "../types";
+import { delay } from "../utils/delay";
 
 const FAL_AI_API_BASE_URL = "https://fal.run";
+const FAL_AI_API_BASE_URL_QUEUE = "https://queue.fal.run";
+
+const makeBaseUrl = (task?: InferenceTask): string => {
+	return task === "text-to-video" ? FAL_AI_API_BASE_URL_QUEUE : FAL_AI_API_BASE_URL;
+};
 
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return params.args;
@@ -29,12 +37,86 @@ const makeHeaders = (params: HeaderParams): Record<string, string> => {
 };
 
 const makeUrl = (params: UrlParams): string => {
-	return `${params.baseUrl}/${params.model}`;
+	const baseUrl = `${params.baseUrl}/${params.model}`;
+	if (params.authMethod !== "provider-key" && params.task === "text-to-video") {
+		return `${baseUrl}?_subdomain=queue`;
+	}
+	return baseUrl;
 };
 
 export const FAL_AI_CONFIG: ProviderConfig = {
-	baseUrl: FAL_AI_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,
 };
+
+export interface FalAiQueueOutput {
+	request_id: string;
+	status: string;
+	response_url: string;
+}
+
+export async function pollFalResponse(
+	res: FalAiQueueOutput,
+	url: string,
+	headers: Record<string, string>
+): Promise<Blob> {
+	const requestId = res.request_id;
+	if (!requestId) {
+		throw new InferenceOutputError("No request ID found in the response");
+	}
+	let status = res.status;
+
+	const parsedUrl = new URL(url);
+	const baseUrl = `${parsedUrl.protocol}//${parsedUrl.host}${
+		parsedUrl.host === "router.huggingface.co" ? "/fal-ai" : ""
+	}`;
+
+	// extracting the provider model id for status and result urls
+	// from the response as it might be different from the mapped model in `url`
+	const modelId = new URL(res.response_url).pathname;
+	const queryParams = parsedUrl.search;
+
+	const statusUrl = `${baseUrl}${modelId}/status${queryParams}`;
+	const resultUrl = `${baseUrl}${modelId}${queryParams}`;
+
+	while (status !== "COMPLETED") {
+		await delay(500);
+		const statusResponse = await fetch(statusUrl, { headers });
+
+		if (!statusResponse.ok) {
+			throw new InferenceOutputError("Failed to fetch response status from fal-ai API");
+		}
+		try {
+			status = (await statusResponse.json()).status;
+		} catch (error) {
+			throw new InferenceOutputError("Failed to parse status response from fal-ai API");
+		}
+	}
+
+	const resultResponse = await fetch(resultUrl, { headers });
+	let result: unknown;
+	try {
+		result = await resultResponse.json();
+	} catch (error) {
+		throw new InferenceOutputError("Failed to parse result response from fal-ai API");
+	}
+	if (
+		typeof result === "object" &&
+		!!result &&
+		"video" in result &&
+		typeof result.video === "object" &&
+		!!result.video &&
+		"url" in result.video &&
+		typeof result.video.url === "string" &&
+		isUrl(result.video.url)
+	) {
+		const urlResponse = await fetch(result.video.url);
+		return await urlResponse.blob();
+	} else {
+		throw new InferenceOutputError(
+			"Expected { video: { url: string } } result format, got instead: " + JSON.stringify(result)
+		);
+	}
+}

package/src/providers/fireworks-ai.ts

@@ -14,10 +14,14 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 const FIREWORKS_AI_API_BASE_URL = "https://api.fireworks.ai";
 
+const makeBaseUrl = (): string => {
+	return FIREWORKS_AI_API_BASE_URL;
+};
+
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
 		...params.args,
@@ -37,7 +41,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const FIREWORKS_AI_CONFIG: ProviderConfig = {
-	baseUrl: FIREWORKS_AI_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/hf-inference.ts

@@ -11,7 +11,11 @@
  * Thanks!
  */
 import { HF_ROUTER_URL } from "../config";
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
+
+const makeBaseUrl = (): string => {
+	return `${HF_ROUTER_URL}/hf-inference`;
+};
 
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
@@ -36,7 +40,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const HF_INFERENCE_CONFIG: ProviderConfig = {
-	baseUrl: `${HF_ROUTER_URL}/hf-inference`,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/hyperbolic.ts

@@ -14,10 +14,14 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 const HYPERBOLIC_API_BASE_URL = "https://api.hyperbolic.xyz";
 
+const makeBaseUrl = (): string => {
+	return HYPERBOLIC_API_BASE_URL;
+};
+
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
 		...params.args,
@@ -37,7 +41,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const HYPERBOLIC_CONFIG: ProviderConfig = {
-	baseUrl: HYPERBOLIC_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/nebius.ts

@@ -14,10 +14,14 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 const NEBIUS_API_BASE_URL = "https://api.studio.nebius.ai";
 
+const makeBaseUrl = (): string => {
+	return NEBIUS_API_BASE_URL;
+};
+
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
 		...params.args,
@@ -43,7 +47,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const NEBIUS_CONFIG: ProviderConfig = {
-	baseUrl: NEBIUS_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/novita.ts

@@ -14,10 +14,13 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 const NOVITA_API_BASE_URL = "https://api.novita.ai";
 
+const makeBaseUrl = (): string => {
+	return NOVITA_API_BASE_URL;
+};
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
 		...params.args,
@@ -41,7 +44,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const NOVITA_CONFIG: ProviderConfig = {
-	baseUrl: NOVITA_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/openai.ts

@@ -1,10 +1,14 @@
 /**
  * Special case: provider configuration for a private models provider (OpenAI in this case).
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 const OPENAI_API_BASE_URL = "https://api.openai.com";
 
+const makeBaseUrl = (): string => {
+	return OPENAI_API_BASE_URL;
+};
+
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	if (!params.chatCompletion) {
 		throw new Error("OpenAI only supports chat completions.");
@@ -27,7 +31,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const OPENAI_CONFIG: ProviderConfig = {
-	baseUrl: OPENAI_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/replicate.ts

@@ -14,10 +14,14 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 export const REPLICATE_API_BASE_URL = "https://api.replicate.com";
 
+const makeBaseUrl = (): string => {
+	return REPLICATE_API_BASE_URL;
+};
+
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
 		input: params.args,
@@ -39,7 +43,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const REPLICATE_CONFIG: ProviderConfig = {
-	baseUrl: REPLICATE_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/sambanova.ts

@@ -14,10 +14,14 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 const SAMBANOVA_API_BASE_URL = "https://api.sambanova.ai";
 
+const makeBaseUrl = (): string => {
+	return SAMBANOVA_API_BASE_URL;
+};
+
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
 		...params.args,
@@ -37,7 +41,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const SAMBANOVA_CONFIG: ProviderConfig = {
-	baseUrl: SAMBANOVA_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/providers/together.ts

@@ -14,10 +14,14 @@
  *
  * Thanks!
  */
-import type { ProviderConfig, UrlParams, HeaderParams, BodyParams } from "../types";
+import type { BodyParams, HeaderParams, ProviderConfig, UrlParams } from "../types";
 
 const TOGETHER_API_BASE_URL = "https://api.together.xyz";
 
+const makeBaseUrl = (): string => {
+	return TOGETHER_API_BASE_URL;
+};
+
 const makeBody = (params: BodyParams): Record<string, unknown> => {
 	return {
 		...params.args,
@@ -43,7 +47,7 @@ const makeUrl = (params: UrlParams): string => {
 };
 
 export const TOGETHER_CONFIG: ProviderConfig = {
-	baseUrl: TOGETHER_API_BASE_URL,
+	makeBaseUrl,
 	makeBody,
 	makeHeaders,
 	makeUrl,

package/src/tasks/cv/textToVideo.ts

@@ -5,17 +5,13 @@ import { omit } from "../../utils/omit";
 import { isUrl } from "../../lib/isUrl";
 import { InferenceOutputError } from "../../lib/InferenceOutputError";
 import { typedInclude } from "../../utils/typedInclude";
+import { makeRequestOptions } from "../../lib/makeRequestOptions";
+import { pollFalResponse, type FalAiQueueOutput } from "../../providers/fal-ai";
 
 export type TextToVideoArgs = BaseArgs & TextToVideoInput;
 
 export type TextToVideoOutput = Blob;
 
-interface FalAiOutput {
-	video: {
-		url: string;
-	};
-}
-
 interface ReplicateOutput {
 	output: string;
 }
@@ -39,25 +35,13 @@ export async function textToVideo(args: TextToVideoArgs, options?: Options): Pro
 		args.provider === "fal-ai" || args.provider === "replicate" || args.provider === "novita"
 			? { ...omit(args, ["inputs", "parameters"]), ...args.parameters, prompt: args.inputs }
 			: args;
-	const res = await request<FalAiOutput | ReplicateOutput | NovitaOutput>(payload, {
+	const res = await request<FalAiQueueOutput | ReplicateOutput | NovitaOutput>(payload, {
 		...options,
 		task: "text-to-video",
 	});
 	if (args.provider === "fal-ai") {
-		const isValidOutput =
-			typeof res === "object" &&
-			!!res &&
-			"video" in res &&
-			typeof res.video === "object" &&
-			!!res.video &&
-			"url" in res.video &&
-			typeof res.video.url === "string" &&
-			isUrl(res.video.url);
-		if (!isValidOutput) {
-			throw new InferenceOutputError("Expected { video: { url: string } }");
-		}
-		const urlResponse = await fetch((res as FalAiOutput).video.url);
-		return await urlResponse.blob();
+		const { url, info } = await makeRequestOptions(args, { ...options, task: "text-to-video" });
+		return await pollFalResponse(res as FalAiQueueOutput, url, info.headers as Record<string, string>);
 	} else if (args.provider === "novita") {
 		const isValidOutput =
 			typeof res === "object" &&

package/src/types.ts

@@ -94,19 +94,22 @@ export type RequestArgs = BaseArgs &
 	};
 
 export interface ProviderConfig {
-	baseUrl: string;
+	makeBaseUrl: ((task?: InferenceTask) => string) | (() => string);
 	makeBody: (params: BodyParams) => Record<string, unknown>;
 	makeHeaders: (params: HeaderParams) => Record<string, string>;
 	makeUrl: (params: UrlParams) => string;
 	clientSideRoutingOnly?: boolean;
 }
 
+export type AuthMethod = "none" | "hf-token" | "credentials-include" | "provider-key";
+
 export interface HeaderParams {
 	accessToken?: string;
-	authMethod: "none" | "hf-token" | "credentials-include" | "provider-key";
+	authMethod: AuthMethod;
 }
 
 export interface UrlParams {
+	authMethod: AuthMethod;
 	baseUrl: string;
 	model: string;
 	task?: InferenceTask;