Roo-Code/src/shared/__tests__/embeddingModels.spec.ts
Roo Code 21e967c35f fix: separate document and query prefixes for embedding models
Adds EmbeddingPurpose type and documentPrefix field to support
different prefixes for indexing vs querying. Models like nomic-embed-code
require a query prefix for search but no prefix for document indexing.

- Add documentPrefix to EmbeddingModelProfile type
- Add getModelDocumentPrefix() and getModelPrefixForPurpose() helpers
- Add purpose parameter to IEmbedder.createEmbeddings()
- Update all embedder implementations to use purpose-aware prefixing
- Scanner and file-watcher pass "index" purpose
- Search service passes "query" purpose
- Update nomic-embed-code profiles (no documentPrefix for indexing)
- Update tests for new behavior

Closes #11707
2026-03-24 14:31:45 +00:00

169 lines
6.6 KiB
TypeScript

import { describe, it, expect } from "vitest"
import {
getModelDimension,
getModelScoreThreshold,
getModelQueryPrefix,
getModelDocumentPrefix,
getModelPrefixForPurpose,
getDefaultModelId,
EMBEDDING_MODEL_PROFILES,
} from "../embeddingModels"
describe("embeddingModels", () => {
describe("EMBEDDING_MODEL_PROFILES", () => {
it("should have gemini provider with gemini-embedding-001 model", () => {
const geminiProfiles = EMBEDDING_MODEL_PROFILES.gemini
expect(geminiProfiles).toBeDefined()
expect(geminiProfiles!["gemini-embedding-001"]).toBeDefined()
expect(geminiProfiles!["gemini-embedding-001"].dimension).toBe(3072)
})
it("should have deprecated text-embedding-004 in gemini profiles for backward compatibility", () => {
// This is critical for backward compatibility:
// Users with text-embedding-004 configured need dimension lookup to work
// even though the model is migrated to gemini-embedding-001 in GeminiEmbedder
const geminiProfiles = EMBEDDING_MODEL_PROFILES.gemini
expect(geminiProfiles).toBeDefined()
expect(geminiProfiles!["text-embedding-004"]).toBeDefined()
expect(geminiProfiles!["text-embedding-004"].dimension).toBe(3072)
})
})
describe("getModelDimension", () => {
it("should return dimension for gemini-embedding-001", () => {
const dimension = getModelDimension("gemini", "gemini-embedding-001")
expect(dimension).toBe(3072)
})
it("should return dimension for deprecated text-embedding-004", () => {
// This ensures createVectorStore() works for users with text-embedding-004 configured
// The dimension should be 3072 (matching gemini-embedding-001) because:
// 1. GeminiEmbedder migrates text-embedding-004 to gemini-embedding-001
// 2. gemini-embedding-001 produces 3072-dimensional embeddings
// 3. Vector store dimension must match the actual embedding dimension
const dimension = getModelDimension("gemini", "text-embedding-004")
expect(dimension).toBe(3072)
})
it("should return undefined for unknown model", () => {
const dimension = getModelDimension("gemini", "unknown-model")
expect(dimension).toBeUndefined()
})
it("should return undefined for unknown provider", () => {
const dimension = getModelDimension("unknown-provider" as any, "some-model")
expect(dimension).toBeUndefined()
})
it("should return correct dimensions for openai models", () => {
expect(getModelDimension("openai", "text-embedding-3-small")).toBe(1536)
expect(getModelDimension("openai", "text-embedding-3-large")).toBe(3072)
expect(getModelDimension("openai", "text-embedding-ada-002")).toBe(1536)
})
})
describe("getModelScoreThreshold", () => {
it("should return score threshold for gemini-embedding-001", () => {
const threshold = getModelScoreThreshold("gemini", "gemini-embedding-001")
expect(threshold).toBe(0.4)
})
it("should return score threshold for deprecated text-embedding-004", () => {
const threshold = getModelScoreThreshold("gemini", "text-embedding-004")
expect(threshold).toBe(0.4)
})
it("should return undefined for unknown model", () => {
const threshold = getModelScoreThreshold("gemini", "unknown-model")
expect(threshold).toBeUndefined()
})
})
describe("getDefaultModelId", () => {
it("should return gemini-embedding-001 for gemini provider", () => {
const defaultModel = getDefaultModelId("gemini")
expect(defaultModel).toBe("gemini-embedding-001")
})
it("should return text-embedding-3-small for openai provider", () => {
const defaultModel = getDefaultModelId("openai")
expect(defaultModel).toBe("text-embedding-3-small")
})
it("should return codestral-embed-2505 for mistral provider", () => {
const defaultModel = getDefaultModelId("mistral")
expect(defaultModel).toBe("codestral-embed-2505")
})
})
describe("getModelQueryPrefix", () => {
it("should return queryPrefix for nomic-embed-code on ollama", () => {
const prefix = getModelQueryPrefix("ollama", "nomic-embed-code")
expect(prefix).toBe("Represent this query for searching relevant code: ")
})
it("should return queryPrefix for nomic-embed-code on openai-compatible", () => {
const prefix = getModelQueryPrefix("openai-compatible", "nomic-embed-code")
expect(prefix).toBe("Represent this query for searching relevant code: ")
})
it("should return undefined for models without queryPrefix", () => {
const prefix = getModelQueryPrefix("openai", "text-embedding-3-small")
expect(prefix).toBeUndefined()
})
it("should return undefined for unknown model", () => {
const prefix = getModelQueryPrefix("ollama", "unknown-model")
expect(prefix).toBeUndefined()
})
it("should return undefined for unknown provider", () => {
const prefix = getModelQueryPrefix("unknown-provider" as any, "some-model")
expect(prefix).toBeUndefined()
})
})
describe("getModelDocumentPrefix", () => {
it("should return undefined for nomic-embed-code on ollama (no prefix for indexing)", () => {
const prefix = getModelDocumentPrefix("ollama", "nomic-embed-code")
expect(prefix).toBeUndefined()
})
it("should return undefined for nomic-embed-code on openai-compatible (no prefix for indexing)", () => {
const prefix = getModelDocumentPrefix("openai-compatible", "nomic-embed-code")
expect(prefix).toBeUndefined()
})
it("should return undefined for models without documentPrefix", () => {
const prefix = getModelDocumentPrefix("openai", "text-embedding-3-small")
expect(prefix).toBeUndefined()
})
it("should return undefined for unknown provider", () => {
const prefix = getModelDocumentPrefix("unknown-provider" as any, "some-model")
expect(prefix).toBeUndefined()
})
})
describe("getModelPrefixForPurpose", () => {
it("should return queryPrefix when purpose is 'query'", () => {
const prefix = getModelPrefixForPurpose("ollama", "nomic-embed-code", "query")
expect(prefix).toBe("Represent this query for searching relevant code: ")
})
it("should return documentPrefix (undefined) when purpose is 'index'", () => {
const prefix = getModelPrefixForPurpose("ollama", "nomic-embed-code", "index")
expect(prefix).toBeUndefined()
})
it("should fall back to queryPrefix when purpose is undefined (backward compatibility)", () => {
const prefix = getModelPrefixForPurpose("ollama", "nomic-embed-code", undefined)
expect(prefix).toBe("Represent this query for searching relevant code: ")
})
it("should return undefined for models without any prefix regardless of purpose", () => {
expect(getModelPrefixForPurpose("openai", "text-embedding-3-small", "query")).toBeUndefined()
expect(getModelPrefixForPurpose("openai", "text-embedding-3-small", "index")).toBeUndefined()
})
})
})