@huggingface/inference 3.1.6 → 3.3.0

package/dist/src/config.d.ts

@@ -1,2 +1,3 @@
 export declare const HF_HUB_URL = "https://huggingface.co";
+export declare const HF_ROUTER_URL = "https://router.huggingface.co";
 //# sourceMappingURL=config.d.ts.map

package/dist/src/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU,2BAA2B,CAAC"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU,2BAA2B,CAAC;AACnD,eAAO,MAAM,aAAa,kCAAkC,CAAC"}

package/dist/src/index.d.ts

@@ -1,10 +1,5 @@
-export type { ProviderMapping } from "./providers/types";
 export { HfInference, HfInferenceEndpoint } from "./HfInference";
 export { InferenceOutputError } from "./lib/InferenceOutputError";
-export { FAL_AI_SUPPORTED_MODEL_IDS } from "./providers/fal-ai";
-export { REPLICATE_SUPPORTED_MODEL_IDS } from "./providers/replicate";
-export { SAMBANOVA_SUPPORTED_MODEL_IDS } from "./providers/sambanova";
-export { TOGETHER_SUPPORTED_MODEL_IDS } from "./providers/together";
 export * from "./types";
 export * from "./tasks";
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,6BAA6B,EAAE,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,6BAA6B,EAAE,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,4BAA4B,EAAE,MAAM,sBAAsB,CAAC;AACpE,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}

package/dist/src/lib/getProviderModelId.d.ts

@@ -0,0 +1,10 @@
+import type { InferenceProvider, InferenceTask, Options, RequestArgs } from "../types";
+export declare function getProviderModelId(params: {
+    model: string;
+    provider: InferenceProvider;
+}, args: RequestArgs, options?: {
+    taskHint?: InferenceTask;
+    chatCompletion?: boolean;
+    fetch?: Options["fetch"];
+}): Promise<string>;
+//# sourceMappingURL=getProviderModelId.d.ts.map

package/dist/src/lib/getProviderModelId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getProviderModelId.d.ts","sourceRoot":"","sources":["../../../src/lib/getProviderModelId.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAW,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAShG,wBAAsB,kBAAkB,CACvC,MAAM,EAAE;IACP,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,iBAAiB,CAAC;CAC5B,EACD,IAAI,EAAE,WAAW,EACjB,OAAO,GAAE;IACR,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,KAAK,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;CACpB,GACJ,OAAO,CAAC,MAAM,CAAC,CAoDjB"}

package/dist/src/lib/makeRequestOptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"makeRequestOptions.d.ts","sourceRoot":"","sources":["../../../src/lib/makeRequestOptions.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAYpE;;GAEG;AACH,wBAAsB,kBAAkB,CACvC,IAAI,EAAE,WAAW,GAAG;IACnB,IAAI,CAAC,EAAE,IAAI,GAAG,WAAW,CAAC;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB,EACD,OAAO,CAAC,EAAE,OAAO,GAAG;IACnB,yFAAyF;IACzF,SAAS,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;IACnC,sCAAsC;IACtC,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;CACzB,GACC,OAAO,CAAC;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,WAAW,CAAA;CAAE,CAAC,CAuH7C"}
+{"version":3,"file":"makeRequestOptions.d.ts","sourceRoot":"","sources":["../../../src/lib/makeRequestOptions.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAapE;;GAEG;AACH,wBAAsB,kBAAkB,CACvC,IAAI,EAAE,WAAW,GAAG;IACnB,IAAI,CAAC,EAAE,IAAI,GAAG,WAAW,CAAC;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB,EACD,OAAO,CAAC,EAAE,OAAO,GAAG;IACnB,yFAAyF;IACzF,SAAS,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;IACnC,sCAAsC;IACtC,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;CACzB,GACC,OAAO,CAAC;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,WAAW,CAAA;CAAE,CAAC,CAqH7C"}

package/dist/src/providers/consts.d.ts

@@ -0,0 +1,13 @@
+import type { InferenceProvider } from "../types";
+import { type ModelId } from "../types";
+type ProviderId = string;
+/**
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co
+ * for a given Inference Provider,
+ * you can add it to the following dictionary, for dev purposes.
+ *
+ * We also inject into this dictionary from tests.
+ */
+export declare const HARDCODED_MODEL_ID_MAPPING: Record<InferenceProvider, Record<ModelId, ProviderId>>;
+export {};
+//# sourceMappingURL=consts.d.ts.map

package/dist/src/providers/consts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../../../src/providers/consts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAClD,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,UAAU,CAAC;AAExC,KAAK,UAAU,GAAG,MAAM,CAAC;AACzB;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,EAAE,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,CAa7F,CAAC"}

package/dist/src/providers/fal-ai.d.ts

@@ -1,6 +1,18 @@
-import type { ProviderMapping } from "./types";
 export declare const FAL_AI_API_BASE_URL = "https://fal.run";
-type FalAiId = string;
-export declare const FAL_AI_SUPPORTED_MODEL_IDS: ProviderMapping<FalAiId>;
-export {};
+/**
+ * See the registered mapping of HF model ID => Fal model ID here:
+ *
+ * https://huggingface.co/api/partners/fal-ai/models
+ *
+ * This is a publicly available mapping.
+ *
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co,
+ * you can add it to the dictionary "HARDCODED_MODEL_ID_MAPPING" in consts.ts, for dev purposes.
+ *
+ * - If you work at Fal and want to update this mapping, please use the model mapping API we provide on huggingface.co
+ * - If you're a community member and want to add a new supported HF model to Fal, please open an issue on the present repo
+ * and we will tag Fal team members.
+ *
+ * Thanks!
+ */
 //# sourceMappingURL=fal-ai.d.ts.map

package/dist/src/providers/fal-ai.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fal-ai.d.ts","sourceRoot":"","sources":["../../../src/providers/fal-ai.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C,eAAO,MAAM,mBAAmB,oBAAoB,CAAC;AAErD,KAAK,OAAO,GAAG,MAAM,CAAC;AAEtB,eAAO,MAAM,0BAA0B,EAAE,eAAe,CAAC,OAAO,CAwB/D,CAAC"}
+{"version":3,"file":"fal-ai.d.ts","sourceRoot":"","sources":["../../../src/providers/fal-ai.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,oBAAoB,CAAC;AAErD;;;;;;;;;;;;;;;GAeG"}

package/dist/src/providers/fireworks-ai.d.ts

@@ -0,0 +1,18 @@
+export declare const FIREWORKS_AI_API_BASE_URL = "https://api.fireworks.ai/inference";
+/**
+ * See the registered mapping of HF model ID => Fireworks model ID here:
+ *
+ * https://huggingface.co/api/partners/fireworks/models
+ *
+ * This is a publicly available mapping.
+ *
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co,
+ * you can add it to the dictionary "HARDCODED_MODEL_ID_MAPPING" in consts.ts, for dev purposes.
+ *
+ * - If you work at Fireworks and want to update this mapping, please use the model mapping API we provide on huggingface.co
+ * - If you're a community member and want to add a new supported HF model to Fireworks, please open an issue on the present repo
+ * and we will tag Fireworks team members.
+ *
+ * Thanks!
+ */
+//# sourceMappingURL=fireworks-ai.d.ts.map

package/dist/src/providers/fireworks-ai.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fireworks-ai.d.ts","sourceRoot":"","sources":["../../../src/providers/fireworks-ai.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,yBAAyB,uCAAuC,CAAC;AAE9E;;;;;;;;;;;;;;;GAeG"}

package/dist/src/providers/replicate.d.ts

@@ -1,6 +1,18 @@
-import type { ProviderMapping } from "./types";
 export declare const REPLICATE_API_BASE_URL = "https://api.replicate.com";
-type ReplicateId = string;
-export declare const REPLICATE_SUPPORTED_MODEL_IDS: ProviderMapping<ReplicateId>;
-export {};
+/**
+ * See the registered mapping of HF model ID => Replicate model ID here:
+ *
+ * https://huggingface.co/api/partners/replicate/models
+ *
+ * This is a publicly available mapping.
+ *
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co,
+ * you can add it to the dictionary "HARDCODED_MODEL_ID_MAPPING" in consts.ts, for dev purposes.
+ *
+ * - If you work at Replicate and want to update this mapping, please use the model mapping API we provide on huggingface.co
+ * - If you're a community member and want to add a new supported HF model to Replicate, please open an issue on the present repo
+ * and we will tag Replicate team members.
+ *
+ * Thanks!
+ */
 //# sourceMappingURL=replicate.d.ts.map

package/dist/src/providers/replicate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"replicate.d.ts","sourceRoot":"","sources":["../../../src/providers/replicate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C,eAAO,MAAM,sBAAsB,8BAA8B,CAAC;AAElE,KAAK,WAAW,GAAG,MAAM,CAAC;AAE1B,eAAO,MAAM,6BAA6B,EAAE,eAAe,CAAC,WAAW,CAuBtE,CAAC"}
+{"version":3,"file":"replicate.d.ts","sourceRoot":"","sources":["../../../src/providers/replicate.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sBAAsB,8BAA8B,CAAC;AAElE;;;;;;;;;;;;;;;GAeG"}

package/dist/src/providers/sambanova.d.ts

@@ -1,6 +1,18 @@
-import type { ProviderMapping } from "./types";
 export declare const SAMBANOVA_API_BASE_URL = "https://api.sambanova.ai";
-type SambanovaId = string;
-export declare const SAMBANOVA_SUPPORTED_MODEL_IDS: ProviderMapping<SambanovaId>;
-export {};
+/**
+ * See the registered mapping of HF model ID => Sambanova model ID here:
+ *
+ * https://huggingface.co/api/partners/sambanova/models
+ *
+ * This is a publicly available mapping.
+ *
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co,
+ * you can add it to the dictionary "HARDCODED_MODEL_ID_MAPPING" in consts.ts, for dev purposes.
+ *
+ * - If you work at Sambanova and want to update this mapping, please use the model mapping API we provide on huggingface.co
+ * - If you're a community member and want to add a new supported HF model to Sambanova, please open an issue on the present repo
+ * and we will tag Sambanova team members.
+ *
+ * Thanks!
+ */
 //# sourceMappingURL=sambanova.d.ts.map

package/dist/src/providers/sambanova.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sambanova.d.ts","sourceRoot":"","sources":["../../../src/providers/sambanova.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C,eAAO,MAAM,sBAAsB,6BAA6B,CAAC;AAEjE,KAAK,WAAW,GAAG,MAAM,CAAC;AAE1B,eAAO,MAAM,6BAA6B,EAAE,eAAe,CAAC,WAAW,CAiBtE,CAAC"}
+{"version":3,"file":"sambanova.d.ts","sourceRoot":"","sources":["../../../src/providers/sambanova.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sBAAsB,6BAA6B,CAAC;AAEjE;;;;;;;;;;;;;;;GAeG"}

package/dist/src/providers/together.d.ts

@@ -1,12 +1,18 @@
-import type { ProviderMapping } from "./types";
 export declare const TOGETHER_API_BASE_URL = "https://api.together.xyz";
 /**
- * Same comment as in sambanova.ts
+ * See the registered mapping of HF model ID => Together model ID here:
+ *
+ * https://huggingface.co/api/partners/together/models
+ *
+ * This is a publicly available mapping.
+ *
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co,
+ * you can add it to the dictionary "HARDCODED_MODEL_ID_MAPPING" in consts.ts, for dev purposes.
+ *
+ * - If you work at Together and want to update this mapping, please use the model mapping API we provide on huggingface.co
+ * - If you're a community member and want to add a new supported HF model to Together, please open an issue on the present repo
+ * and we will tag Together team members.
+ *
+ * Thanks!
  */
-type TogetherId = string;
-/**
- * https://docs.together.ai/reference/models-1
- */
-export declare const TOGETHER_SUPPORTED_MODEL_IDS: ProviderMapping<TogetherId>;
-export {};
 //# sourceMappingURL=together.d.ts.map

package/dist/src/providers/together.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"together.d.ts","sourceRoot":"","sources":["../../../src/providers/together.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C,eAAO,MAAM,qBAAqB,6BAA6B,CAAC;AAEhE;;GAEG;AACH,KAAK,UAAU,GAAG,MAAM,CAAC;AAEzB;;GAEG;AACH,eAAO,MAAM,4BAA4B,EAAE,eAAe,CAAC,UAAU,CA8CpE,CAAC"}
+{"version":3,"file":"together.d.ts","sourceRoot":"","sources":["../../../src/providers/together.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,6BAA6B,CAAC;AAEhE;;;;;;;;;;;;;;;GAeG"}

package/dist/src/types.d.ts

@@ -38,7 +38,7 @@ export interface Options {
     includeCredentials?: string | boolean;
 }
 export type InferenceTask = Exclude<PipelineType, "other">;
-export declare const INFERENCE_PROVIDERS: readonly ["fal-ai", "replicate", "sambanova", "together", "hf-inference"];
+export declare const INFERENCE_PROVIDERS: readonly ["fal-ai", "fireworks-ai", "hf-inference", "replicate", "sambanova", "together"];
 export type InferenceProvider = (typeof INFERENCE_PROVIDERS)[number];
 export interface BaseArgs {
     /**

package/dist/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtC;AAED,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;AAE3D,eAAO,MAAM,mBAAmB,2EAA4E,CAAC;AAC7G,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAErE,MAAM,WAAW,QAAQ;IACxB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAC;CAC7B;AAED,MAAM,MAAM,WAAW,GAAG,QAAQ,GACjC,CACG;IAAE,IAAI,EAAE,IAAI,GAAG,WAAW,CAAA;CAAE,GAC5B;IAAE,MAAM,EAAE,OAAO,CAAA;CAAE,GACnB;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GACrB,mBAAmB,CACrB,GAAG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtC;AAED,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;AAE3D,eAAO,MAAM,mBAAmB,2FAOtB,CAAC;AACX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAErE,MAAM,WAAW,QAAQ;IACxB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAC;CAC7B;AAED,MAAM,MAAM,WAAW,GAAG,QAAQ,GACjC,CACG;IAAE,IAAI,EAAE,IAAI,GAAG,WAAW,CAAA;CAAE,GAC5B;IAAE,MAAM,EAAE,OAAO,CAAA;CAAE,GACnB;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GACrB,mBAAmB,CACrB,GAAG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@huggingface/inference",
-  "version": "3.1.6",
+  "version": "3.3.0",
   "packageManager": "pnpm@8.10.5",
   "license": "MIT",
   "author": "Tim Mikeladze <tim.mikeladze@gmail.com>",
@@ -39,7 +39,7 @@
   },
   "type": "module",
   "dependencies": {
-    "@huggingface/tasks": "^0.15.7"
+    "@huggingface/tasks": "^0.15.9"
   },
   "devDependencies": {
     "@types/node": "18.13.0"

package/src/config.ts

@@ -1 +1,2 @@
 export const HF_HUB_URL = "https://huggingface.co";
+export const HF_ROUTER_URL = "https://router.huggingface.co";

package/src/index.ts

@@ -1,9 +1,4 @@
-export type { ProviderMapping } from "./providers/types";
 export { HfInference, HfInferenceEndpoint } from "./HfInference";
 export { InferenceOutputError } from "./lib/InferenceOutputError";
-export { FAL_AI_SUPPORTED_MODEL_IDS } from "./providers/fal-ai";
-export { REPLICATE_SUPPORTED_MODEL_IDS } from "./providers/replicate";
-export { SAMBANOVA_SUPPORTED_MODEL_IDS } from "./providers/sambanova";
-export { TOGETHER_SUPPORTED_MODEL_IDS } from "./providers/together";
 export * from "./types";
 export * from "./tasks";

package/src/lib/getProviderModelId.ts

@@ -0,0 +1,74 @@
+import type { WidgetType } from "@huggingface/tasks";
+import type { InferenceProvider, InferenceTask, ModelId, Options, RequestArgs } from "../types";
+import { HF_HUB_URL } from "../config";
+import { HARDCODED_MODEL_ID_MAPPING } from "../providers/consts";
+
+type InferenceProviderMapping = Partial<
+	Record<InferenceProvider, { providerId: string; status: "live" | "staging"; task: WidgetType }>
+>;
+const inferenceProviderMappingCache = new Map<ModelId, InferenceProviderMapping>();
+
+export async function getProviderModelId(
+	params: {
+		model: string;
+		provider: InferenceProvider;
+	},
+	args: RequestArgs,
+	options: {
+		taskHint?: InferenceTask;
+		chatCompletion?: boolean;
+		fetch?: Options["fetch"];
+	} = {}
+): Promise<string> {
+	if (params.provider === "hf-inference") {
+		return params.model;
+	}
+	if (!options.taskHint) {
+		throw new Error("taskHint must be specified when using a third-party provider");
+	}
+	const task: WidgetType =
+		options.taskHint === "text-generation" && options.chatCompletion ? "conversational" : options.taskHint;
+
+	// A dict called HARDCODED_MODEL_ID_MAPPING takes precedence in all cases (useful for dev purposes)
+	if (HARDCODED_MODEL_ID_MAPPING[params.provider]?.[params.model]) {
+		return HARDCODED_MODEL_ID_MAPPING[params.provider][params.model];
+	}
+
+	let inferenceProviderMapping: InferenceProviderMapping | null;
+	if (inferenceProviderMappingCache.has(params.model)) {
+		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+		inferenceProviderMapping = inferenceProviderMappingCache.get(params.model)!;
+	} else {
+		inferenceProviderMapping = await (options?.fetch ?? fetch)(
+			`${HF_HUB_URL}/api/models/${params.model}?expand[]=inferenceProviderMapping`,
+			{
+				headers: args.accessToken?.startsWith("hf_") ? { Authorization: `Bearer ${args.accessToken}` } : {},
+			}
+		)
+			.then((resp) => resp.json())
+			.then((json) => json.inferenceProviderMapping)
+			.catch(() => null);
+	}
+
+	if (!inferenceProviderMapping) {
+		throw new Error(`We have not been able to find inference provider information for model ${params.model}.`);
+	}
+
+	const providerMapping = inferenceProviderMapping[params.provider];
+	if (providerMapping) {
+		if (providerMapping.task !== task) {
+			throw new Error(
+				`Model ${params.model} is not supported for task ${task} and provider ${params.provider}. Supported task: ${providerMapping.task}.`
+			);
+		}
+		if (providerMapping.status === "staging") {
+			console.warn(
+				`Model ${params.model} is in staging mode for provider ${params.provider}. Meant for test purposes only.`
+			);
+		}
+		// TODO: how is it handled server-side if model has multiple tasks (e.g. `text-generation` + `conversational`)?
+		return providerMapping.providerId;
+	}
+
+	throw new Error(`Model ${params.model} is not supported provider ${params.provider}.`);
+}

package/src/lib/makeRequestOptions.ts

@@ -1,15 +1,16 @@
-import type { WidgetType } from "@huggingface/tasks";
-import { HF_HUB_URL } from "../config";
-import { FAL_AI_API_BASE_URL, FAL_AI_SUPPORTED_MODEL_IDS } from "../providers/fal-ai";
-import { REPLICATE_API_BASE_URL, REPLICATE_SUPPORTED_MODEL_IDS } from "../providers/replicate";
-import { SAMBANOVA_API_BASE_URL, SAMBANOVA_SUPPORTED_MODEL_IDS } from "../providers/sambanova";
-import { TOGETHER_API_BASE_URL, TOGETHER_SUPPORTED_MODEL_IDS } from "../providers/together";
+import { HF_HUB_URL, HF_ROUTER_URL } from "../config";
+import { FAL_AI_API_BASE_URL } from "../providers/fal-ai";
+import { REPLICATE_API_BASE_URL } from "../providers/replicate";
+import { SAMBANOVA_API_BASE_URL } from "../providers/sambanova";
+import { TOGETHER_API_BASE_URL } from "../providers/together";
+import { FIREWORKS_AI_API_BASE_URL } from "../providers/fireworks-ai";
 import type { InferenceProvider } from "../types";
 import type { InferenceTask, Options, RequestArgs } from "../types";
 import { isUrl } from "./isUrl";
 import { version as packageVersion, name as packageName } from "../../package.json";
+import { getProviderModelId } from "./getProviderModelId";
 
-const HF_HUB_INFERENCE_PROXY_TEMPLATE = `${HF_HUB_URL}/api/inference-proxy/{{PROVIDER}}`;
+const HF_HUB_INFERENCE_PROXY_TEMPLATE = `${HF_ROUTER_URL}/{{PROVIDER}}`;
 
 /**
  * Lazy-loaded from huggingface.co/api/tasks when needed
@@ -49,18 +50,16 @@ export async function makeRequestOptions(
 	if (maybeModel && isUrl(maybeModel)) {
 		throw new Error(`Model URLs are no longer supported. Use endpointUrl instead.`);
 	}
-
-	let model: string;
-	if (!maybeModel) {
-		if (taskHint) {
-			model = mapModel({ model: await loadDefaultModel(taskHint), provider, taskHint, chatCompletion });
-		} else {
-			throw new Error("No model provided, and no default model found for this task");
-			/// TODO : change error message ^
-		}
-	} else {
-		model = mapModel({ model: maybeModel, provider, taskHint, chatCompletion });
+	if (!maybeModel && !taskHint) {
+		throw new Error("No model provided, and no task has been specified.");
 	}
+	// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+	const hfModel = maybeModel ?? (await loadDefaultModel(taskHint!));
+	const model = await getProviderModelId({ model: hfModel, provider }, args, {
+		taskHint,
+		chatCompletion,
+		fetch: options?.fetch,
+	});
 
 	/// If accessToken is passed, it should take precedence over includeCredentials
 	const authMethod = accessToken
@@ -153,39 +152,6 @@ export async function makeRequestOptions(
 	return { url, info };
 }
 
-function mapModel(params: {
-	model: string;
-	provider: InferenceProvider;
-	taskHint: InferenceTask | undefined;
-	chatCompletion: boolean | undefined;
-}): string {
-	if (params.provider === "hf-inference") {
-		return params.model;
-	}
-	if (!params.taskHint) {
-		throw new Error("taskHint must be specified when using a third-party provider");
-	}
-	const task: WidgetType =
-		params.taskHint === "text-generation" && params.chatCompletion ? "conversational" : params.taskHint;
-	const model = (() => {
-		switch (params.provider) {
-			case "fal-ai":
-				return FAL_AI_SUPPORTED_MODEL_IDS[task]?.[params.model];
-			case "replicate":
-				return REPLICATE_SUPPORTED_MODEL_IDS[task]?.[params.model];
-			case "sambanova":
-				return SAMBANOVA_SUPPORTED_MODEL_IDS[task]?.[params.model];
-			case "together":
-				return TOGETHER_SUPPORTED_MODEL_IDS[task]?.[params.model];
-		}
-	})();
-
-	if (!model) {
-		throw new Error(`Model ${params.model} is not supported for task ${task} and provider ${params.provider}`);
-	}
-	return model;
-}
-
 function makeUrl(params: {
 	authMethod: "none" | "hf-token" | "credentials-include" | "provider-key";
 	chatCompletion: boolean;
@@ -243,6 +209,15 @@ function makeUrl(params: {
 			}
 			return baseUrl;
 		}
+		case "fireworks-ai": {
+			const baseUrl = shouldProxy
+				? HF_HUB_INFERENCE_PROXY_TEMPLATE.replace("{{PROVIDER}}", params.provider)
+				: FIREWORKS_AI_API_BASE_URL;
+			if (params.taskHint === "text-generation" && params.chatCompletion) {
+				return `${baseUrl}/v1/chat/completions`;
+			}
+			return baseUrl;
+		}
 		default: {
 			const baseUrl = HF_HUB_INFERENCE_PROXY_TEMPLATE.replaceAll("{{PROVIDER}}", "hf-inference");
 			const url = params.forceTask

package/src/providers/consts.ts

@@ -0,0 +1,25 @@
+import type { InferenceProvider } from "../types";
+import { type ModelId } from "../types";
+
+type ProviderId = string;
+/**
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co
+ * for a given Inference Provider,
+ * you can add it to the following dictionary, for dev purposes.
+ *
+ * We also inject into this dictionary from tests.
+ */
+export const HARDCODED_MODEL_ID_MAPPING: Record<InferenceProvider, Record<ModelId, ProviderId>> = {
+	/**
+	 * "HF model ID" => "Model ID on Inference Provider's side"
+	 *
+	 * Example:
+	 * "Qwen/Qwen2.5-Coder-32B-Instruct": "Qwen2.5-Coder-32B-Instruct",
+	 */
+	"fal-ai": {},
+	"fireworks-ai": {},
+	"hf-inference": {},
+	replicate: {},
+	sambanova: {},
+	together: {},
+};

package/src/providers/fal-ai.ts

@@ -1,31 +1,18 @@
-import type { ProviderMapping } from "./types";
-
 export const FAL_AI_API_BASE_URL = "https://fal.run";
 
-type FalAiId = string;
-
-export const FAL_AI_SUPPORTED_MODEL_IDS: ProviderMapping<FalAiId> = {
-	"text-to-image": {
-		"black-forest-labs/FLUX.1-schnell": "fal-ai/flux/schnell",
-		"black-forest-labs/FLUX.1-dev": "fal-ai/flux/dev",
-		"playgroundai/playground-v2.5-1024px-aesthetic": "fal-ai/playground-v25",
-		"ByteDance/SDXL-Lightning": "fal-ai/lightning-models",
-		"PixArt-alpha/PixArt-Sigma-XL-2-1024-MS": "fal-ai/pixart-sigma",
-		"stabilityai/stable-diffusion-3-medium": "fal-ai/stable-diffusion-v3-medium",
-		"Warlord-K/Sana-1024": "fal-ai/sana",
-		"fal/AuraFlow-v0.2": "fal-ai/aura-flow",
-		"stabilityai/stable-diffusion-3.5-large": "fal-ai/stable-diffusion-v35-large",
-		"stabilityai/stable-diffusion-3.5-large-turbo": "fal-ai/stable-diffusion-v35-large/turbo",
-		"stabilityai/stable-diffusion-3.5-medium": "fal-ai/stable-diffusion-v35-medium",
-		"Kwai-Kolors/Kolors": "fal-ai/kolors",
-	},
-	"automatic-speech-recognition": {
-		"openai/whisper-large-v3": "fal-ai/whisper",
-	},
-	"text-to-video": {
-		"genmo/mochi-1-preview": "fal-ai/mochi-v1",
-		"tencent/HunyuanVideo": "fal-ai/hunyuan-video",
-		"THUDM/CogVideoX-5b": "fal-ai/cogvideox-5b",
-		"Lightricks/LTX-Video": "fal-ai/ltx-video",
-	},
-};
+/**
+ * See the registered mapping of HF model ID => Fal model ID here:
+ *
+ * https://huggingface.co/api/partners/fal-ai/models
+ *
+ * This is a publicly available mapping.
+ *
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co,
+ * you can add it to the dictionary "HARDCODED_MODEL_ID_MAPPING" in consts.ts, for dev purposes.
+ *
+ * - If you work at Fal and want to update this mapping, please use the model mapping API we provide on huggingface.co
+ * - If you're a community member and want to add a new supported HF model to Fal, please open an issue on the present repo
+ * and we will tag Fal team members.
+ *
+ * Thanks!
+ */

package/src/providers/fireworks-ai.ts

@@ -0,0 +1,18 @@
+export const FIREWORKS_AI_API_BASE_URL = "https://api.fireworks.ai/inference";
+
+/**
+ * See the registered mapping of HF model ID => Fireworks model ID here:
+ *
+ * https://huggingface.co/api/partners/fireworks/models
+ *
+ * This is a publicly available mapping.
+ *
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co,
+ * you can add it to the dictionary "HARDCODED_MODEL_ID_MAPPING" in consts.ts, for dev purposes.
+ *
+ * - If you work at Fireworks and want to update this mapping, please use the model mapping API we provide on huggingface.co
+ * - If you're a community member and want to add a new supported HF model to Fireworks, please open an issue on the present repo
+ * and we will tag Fireworks team members.
+ *
+ * Thanks!
+ */

package/src/providers/replicate.ts

@@ -1,30 +1,18 @@
-import type { ProviderMapping } from "./types";
-
 export const REPLICATE_API_BASE_URL = "https://api.replicate.com";
 
-type ReplicateId = string;
-
-export const REPLICATE_SUPPORTED_MODEL_IDS: ProviderMapping<ReplicateId> = {
-	"text-to-image": {
-		"black-forest-labs/FLUX.1-dev": "black-forest-labs/flux-dev",
-		"black-forest-labs/FLUX.1-schnell": "black-forest-labs/flux-schnell",
-		"ByteDance/Hyper-SD":
-			"bytedance/hyper-flux-16step:382cf8959fb0f0d665b26e7e80b8d6dc3faaef1510f14ce017e8c732bb3d1eb7",
-		"ByteDance/SDXL-Lightning":
-			"bytedance/sdxl-lightning-4step:5599ed30703defd1d160a25a63321b4dec97101d98b4674bcc56e41f62f35637",
-		"playgroundai/playground-v2.5-1024px-aesthetic":
-			"playgroundai/playground-v2.5-1024px-aesthetic:a45f82a1382bed5c7aeb861dac7c7d191b0fdf74d8d57c4a0e6ed7d4d0bf7d24",
-		"stabilityai/stable-diffusion-3.5-large-turbo": "stability-ai/stable-diffusion-3.5-large-turbo",
-		"stabilityai/stable-diffusion-3.5-large": "stability-ai/stable-diffusion-3.5-large",
-		"stabilityai/stable-diffusion-3.5-medium": "stability-ai/stable-diffusion-3.5-medium",
-		"stabilityai/stable-diffusion-xl-base-1.0":
-			"stability-ai/sdxl:7762fd07cf82c948538e41f63f77d685e02b063e37e496e96eefd46c929f9bdc",
-	},
-	"text-to-speech": {
-		"OuteAI/OuteTTS-0.3-500M": "jbilcke/oute-tts:3c645149db020c85d080e2f8cfe482a0e68189a922cde964fa9e80fb179191f3",
-		"hexgrad/Kokoro-82M": "jaaari/kokoro-82m:dfdf537ba482b029e0a761699e6f55e9162cfd159270bfe0e44857caa5f275a6",
-	},
-	"text-to-video": {
-		"genmo/mochi-1-preview": "genmoai/mochi-1:1944af04d098ef69bed7f9d335d102e652203f268ec4aaa2d836f6217217e460",
-	},
-};
+/**
+ * See the registered mapping of HF model ID => Replicate model ID here:
+ *
+ * https://huggingface.co/api/partners/replicate/models
+ *
+ * This is a publicly available mapping.
+ *
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co,
+ * you can add it to the dictionary "HARDCODED_MODEL_ID_MAPPING" in consts.ts, for dev purposes.
+ *
+ * - If you work at Replicate and want to update this mapping, please use the model mapping API we provide on huggingface.co
+ * - If you're a community member and want to add a new supported HF model to Replicate, please open an issue on the present repo
+ * and we will tag Replicate team members.
+ *
+ * Thanks!
+ */

package/src/providers/sambanova.ts

@@ -1,24 +1,18 @@
-import type { ProviderMapping } from "./types";
-
 export const SAMBANOVA_API_BASE_URL = "https://api.sambanova.ai";
 
-type SambanovaId = string;
-
-export const SAMBANOVA_SUPPORTED_MODEL_IDS: ProviderMapping<SambanovaId> = {
-	/** Chat completion / conversational */
-	conversational: {
-		"deepseek-ai/DeepSeek-Distill-R1-Llama-70B": "DeepSeek-Distill-R1-Llama-70B",
-		"Qwen/Qwen2.5-Coder-32B-Instruct": "Qwen2.5-Coder-32B-Instruct",
-		"Qwen/Qwen2.5-72B-Instruct": "Qwen2.5-72B-Instruct",
-		"Qwen/QwQ-32B-Preview": "QwQ-32B-Preview",
-		"meta-llama/Llama-3.3-70B-Instruct": "Meta-Llama-3.3-70B-Instruct",
-		"meta-llama/Llama-3.2-1B-Instruct": "Meta-Llama-3.2-1B-Instruct",
-		"meta-llama/Llama-3.2-3B-Instruct": "Meta-Llama-3.2-3B-Instruct",
-		"meta-llama/Llama-3.2-11B-Vision-Instruct": "Llama-3.2-11B-Vision-Instruct",
-		"meta-llama/Llama-3.2-90B-Vision-Instruct": "Llama-3.2-90B-Vision-Instruct",
-		"meta-llama/Llama-3.1-8B-Instruct": "Meta-Llama-3.1-8B-Instruct",
-		"meta-llama/Llama-3.1-70B-Instruct": "Meta-Llama-3.1-70B-Instruct",
-		"meta-llama/Llama-3.1-405B-Instruct": "Meta-Llama-3.1-405B-Instruct",
-		"meta-llama/Llama-Guard-3-8B": "Meta-Llama-Guard-3-8B",
-	},
-};
+/**
+ * See the registered mapping of HF model ID => Sambanova model ID here:
+ *
+ * https://huggingface.co/api/partners/sambanova/models
+ *
+ * This is a publicly available mapping.
+ *
+ * If you want to try to run inference for a new model locally before it's registered on huggingface.co,
+ * you can add it to the dictionary "HARDCODED_MODEL_ID_MAPPING" in consts.ts, for dev purposes.
+ *
+ * - If you work at Sambanova and want to update this mapping, please use the model mapping API we provide on huggingface.co
+ * - If you're a community member and want to add a new supported HF model to Sambanova, please open an issue on the present repo
+ * and we will tag Sambanova team members.
+ *
+ * Thanks!
+ */