-
Notifications
You must be signed in to change notification settings - Fork 574
fix: add NVIDIA NIM provider profile for input_type embedding field #268
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from 4 commits
39ba703
423f8c2
a9b4f66
3f26c60
e6e705d
255475d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -107,6 +107,7 @@ type EmbeddingProviderProfile = | |
| | "azure-openai" | ||
| | "jina" | ||
| | "voyage-compatible" | ||
| | "nvidia" | ||
| | "generic-openai-compatible"; | ||
|
|
||
| interface EmbeddingCapabilities { | ||
|
|
@@ -207,6 +208,7 @@ function getProviderLabel(baseURL: string | undefined, model: string): string { | |
| if (profile === "voyage-compatible" && /api\.voyageai\.com/i.test(base)) return "Voyage"; | ||
| if (profile === "openai" && /api\.openai\.com/i.test(base)) return "OpenAI"; | ||
| if (profile === "azure-openai" || /\.openai\.azure\.com/i.test(base)) return "Azure OpenAI"; | ||
| if (profile === "nvidia") return "NVIDIA NIM"; | ||
|
|
||
| try { | ||
| return new URL(base).host; | ||
|
|
@@ -223,6 +225,8 @@ function getProviderLabel(baseURL: string | undefined, model: string): string { | |
| case "openai": | ||
| case "azure-openai": | ||
| return "OpenAI"; | ||
| case "nvidia": | ||
| return "NVIDIA NIM"; | ||
| default: | ||
| return "embedding provider"; | ||
| } | ||
|
|
@@ -241,6 +245,10 @@ function detectEmbeddingProviderProfile( | |
| return "voyage-compatible"; | ||
| } | ||
|
|
||
| if (/\.nvidia\.com/i.test(base) || /^nvidia\//i.test(model) || /^nv-embed/i.test(model)) { | ||
|
||
| return "nvidia"; | ||
| } | ||
|
|
||
| return "generic-openai-compatible"; | ||
| } | ||
|
|
||
|
|
@@ -273,6 +281,19 @@ function getEmbeddingCapabilities(profile: EmbeddingProviderProfile): EmbeddingC | |
| }, | ||
| dimensionsField: "output_dimension", | ||
| }; | ||
| case "nvidia": | ||
| return { | ||
| encoding_format: true, | ||
| normalized: false, | ||
| taskField: "input_type", | ||
| taskValueMap: { | ||
| "retrieval.query": "query", | ||
| "retrieval.passage": "passage", | ||
| "query": "query", | ||
| "passage": "passage", | ||
| }, | ||
| dimensionsField: "dimensions", | ||
| }; | ||
| case "generic-openai-compatible": | ||
| default: | ||
| return { | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| import assert from "node:assert/strict"; | ||
| import http from "node:http"; | ||
| import { describe, it } from "node:test"; | ||
|
|
||
| import jitiFactory from "jiti"; | ||
|
|
||
| const jiti = jitiFactory(import.meta.url, { interopDefault: true }); | ||
| const { Embedder, formatEmbeddingProviderError } = jiti("../src/embedder.ts"); | ||
|
|
||
| /** | ||
| * Create a capture server that records POST bodies and returns embeddings | ||
| * with configurable dimension count. | ||
| */ | ||
| async function withCaptureServer(dims, fn) { | ||
| let capturedBody = null; | ||
| const fakeVec = Array.from({ length: dims }, (_, i) => i * 0.01); | ||
| const server = http.createServer((req, res) => { | ||
| if (req.url === "/v1/embeddings" && req.method === "POST") { | ||
| const chunks = []; | ||
| req.on("data", (c) => chunks.push(c)); | ||
| req.on("end", () => { | ||
| capturedBody = JSON.parse(Buffer.concat(chunks).toString()); | ||
| res.writeHead(200, { "content-type": "application/json" }); | ||
| res.end( | ||
| JSON.stringify({ | ||
| object: "list", | ||
| data: [{ object: "embedding", index: 0, embedding: fakeVec }], | ||
| usage: { prompt_tokens: 5, total_tokens: 5 }, | ||
| }), | ||
| ); | ||
| }); | ||
| return; | ||
| } | ||
| res.writeHead(404); | ||
| res.end("not found"); | ||
| }); | ||
|
|
||
| await new Promise((resolve) => server.listen(0, "127.0.0.1", resolve)); | ||
| const address = server.address(); | ||
| const port = typeof address === "object" && address ? address.port : 0; | ||
| const baseURL = `http://127.0.0.1:${port}/v1`; | ||
|
|
||
| try { | ||
| await fn({ baseURL, port, getCaptured: () => capturedBody }); | ||
| } finally { | ||
| await new Promise((resolve) => server.close(resolve)); | ||
| } | ||
| } | ||
|
|
||
| describe("NVIDIA NIM provider profile", () => { | ||
| it("sends input_type=query for NVIDIA NIM (nv-embed model prefix)", async () => { | ||
| const dims = 128; | ||
| await withCaptureServer(dims, async ({ baseURL, getCaptured }) => { | ||
| const embedder = new Embedder({ | ||
| baseURL, | ||
| model: "nv-embedqa-e5-v5", | ||
| apiKey: "test-key", | ||
| dimensions: dims, | ||
| taskQuery: "retrieval.query", | ||
| taskPassage: "retrieval.passage", | ||
| }); | ||
|
|
||
| await embedder.embedQuery("test query"); | ||
| const body = getCaptured(); | ||
|
|
||
| assert.ok(body, "Request body should be captured"); | ||
| assert.equal(body.input_type, "query", "Should send input_type=query for NVIDIA"); | ||
| assert.equal(body.task, undefined, "Should NOT send task field for NVIDIA"); | ||
| }); | ||
| }); | ||
|
|
||
| it("maps retrieval.passage → passage for NVIDIA NIM", async () => { | ||
| const dims = 128; | ||
| await withCaptureServer(dims, async ({ baseURL, getCaptured }) => { | ||
| const embedder = new Embedder({ | ||
| baseURL, | ||
| model: "nv-embedqa-e5-v5", | ||
| apiKey: "test-key", | ||
| dimensions: dims, | ||
| taskQuery: "retrieval.query", | ||
| taskPassage: "retrieval.passage", | ||
| }); | ||
|
|
||
| await embedder.embedPassage("test document"); | ||
| const body = getCaptured(); | ||
|
|
||
| assert.ok(body, "Request body should be captured"); | ||
| assert.equal(body.input_type, "passage", "Should map retrieval.passage → passage"); | ||
| assert.equal(body.task, undefined, "Should NOT send task field for NVIDIA"); | ||
| }); | ||
| }); | ||
|
|
||
| it("detects NVIDIA from nvidia/ model prefix", async () => { | ||
| const dims = 128; | ||
| await withCaptureServer(dims, async ({ baseURL, getCaptured }) => { | ||
| const embedder = new Embedder({ | ||
| baseURL, | ||
| model: "nvidia/llama-3.2-nv-embedqa-1b-v2", | ||
| apiKey: "test-key", | ||
| dimensions: dims, | ||
| taskQuery: "query", | ||
| taskPassage: "passage", | ||
| }); | ||
|
|
||
| await embedder.embedQuery("test"); | ||
| const body = getCaptured(); | ||
|
|
||
| assert.ok(body, "Request body should be captured"); | ||
| assert.equal(body.input_type, "query", "nvidia/ model prefix should trigger input_type"); | ||
| assert.equal(body.task, undefined, "nvidia/ model prefix should NOT send task"); | ||
| }); | ||
| }); | ||
|
|
||
| it("detects NVIDIA from a .nvidia.com baseURL", () => { | ||
| const message = formatEmbeddingProviderError(new Error("boom"), { | ||
| baseURL: "https://build.nvidia.com/v1", | ||
| model: "custom-embed-model", | ||
| mode: "single", | ||
| }); | ||
|
|
||
| assert.equal(message, "Failed to generate embedding from NVIDIA NIM: boom"); | ||
| }); | ||
|
|
||
| it("non-NVIDIA: Jina sends task field", async () => { | ||
| const dims = 128; | ||
| await withCaptureServer(dims, async ({ baseURL, getCaptured }) => { | ||
| const embedder = new Embedder({ | ||
| baseURL, | ||
| model: "jina-embeddings-v5-text-small", | ||
| apiKey: "test-key", | ||
| dimensions: dims, | ||
| taskQuery: "retrieval.query", | ||
| taskPassage: "retrieval.passage", | ||
| }); | ||
|
|
||
| await embedder.embedQuery("test query"); | ||
| const body = getCaptured(); | ||
|
|
||
| assert.ok(body, "Request body should be captured"); | ||
| assert.equal(body.task, "retrieval.query", "Jina should send task field"); | ||
| assert.equal(body.input_type, undefined, "Jina should NOT send input_type"); | ||
| }); | ||
| }); | ||
|
|
||
| it("non-NVIDIA: generic OpenAI-compatible sends neither task nor input_type", async () => { | ||
| const dims = 128; | ||
| await withCaptureServer(dims, async ({ baseURL, getCaptured }) => { | ||
| const embedder = new Embedder({ | ||
| baseURL, | ||
| model: "custom-embed-model", | ||
| apiKey: "test-key", | ||
| dimensions: dims, | ||
| }); | ||
|
|
||
| await embedder.embedQuery("test query"); | ||
| const body = getCaptured(); | ||
|
|
||
| assert.ok(body, "Request body should be captured"); | ||
| assert.equal(body.task, undefined, "Generic provider should NOT send task"); | ||
| assert.equal(body.input_type, undefined, "Generic provider should NOT send input_type"); | ||
| }); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
input_typeThis detection is broader than the capability it enables. Any
*.nvidia.comendpoint ornvidia/*/nv-embed*model now gets thenvidiaprofile, andbuildPayload()will therefore addinput_typewheneverembedding.taskQueryortaskPassageis set. That also sweeps in NVIDIA-hosted embeddings such asBAAI/bge-m3,snowflake/arctic-embed-l,nvidia/nv-embed-v1, andnvidia/nv-embedcode-7b-v1, whose model docs describe plain text (or task-specific instructions) rather than the retriever-style query/passage contract. Those configs previously behaved as generic OpenAI-compatible embeddings, so this heuristic can turn valid requests into 400s or wrong embeddings for non-retriever models.Useful? React with 👍 / 👎.