add user-agent header to inference requests (#1150)

This PR updates the inference client to include a user-agent header in
outgoing API requests.

The value is derived from the `name` and `version` of the inference
package, e.g. `@huggingface/[email protected]`

This will allow third-party inference providers to identify API requests
that originate from HF's new inference integration.

See https://huggingface.co/blog/inference-providers

cc @julien-c @SBrandeis

---------

Co-authored-by: coyotte508 <[email protected]>
Co-authored-by: Simon Brandeis <[email protected]>

Author: 3 people

packages/inference/src/lib/makeRequestOptions.ts

@@ -7,6 +7,7 @@ import { TOGETHER_API_BASE_URL, TOGETHER_SUPPORTED_MODEL_IDS } from "../provider
 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";
 
 const HF_HUB_INFERENCE_PROXY_TEMPLATE = `${HF_HUB_URL}/api/inference-proxy/{{PROVIDER}}`;
 
@@ -89,6 +90,12 @@ export async function makeRequestOptions(
 			provider === "fal-ai" && authMethod === "provider-key" ? `Key ${accessToken}` : `Bearer ${accessToken}`;
 	}
 
+	// e.g. @huggingface/inference/3.1.3
+	const ownUserAgent = `${packageName}/${packageVersion}`;
+	headers["User-Agent"] = [ownUserAgent, typeof navigator !== "undefined" ? navigator.userAgent : undefined]
+		.filter((x) => x !== undefined)
+		.join(" ");
+
 	const binary = "data" in args && !!args.data;
 
 	if (!binary) {

packages/inference/test/vcr.ts

@@ -179,7 +179,7 @@ async function vcr(
 		const tape: Tape = {
 			url,
 			init: {
-				headers: init.headers && omit(init.headers as Record<string, string>, "Authorization"),
+				headers: init.headers && omit(init.headers as Record<string, string>, ["Authorization", "User-Agent"]),
 				method: init.method,
 				body: typeof init.body === "string" && init.body.length < 1_000 ? init.body : undefined,
 			},

packages/inference/tsconfig.json

@@ -11,7 +11,8 @@
 		"noImplicitOverride": true,
 		"declaration": true,
 		"declarationMap": true,
-		"outDir": "./dist"
+		"outDir": "./dist",
+		"resolveJsonModule": true
 	},
 	"include": ["src", "test"],
 	"exclude": ["dist"]