feat(#70): implement semantic search API with Ollama embeddings
Updated semantic search to use OllamaEmbeddingService instead of OpenAI: - Replaced EmbeddingService with OllamaEmbeddingService in SearchService - Added configurable similarity threshold (SEMANTIC_SEARCH_SIMILARITY_THRESHOLD) - Updated both semanticSearch() and hybridSearch() methods - Added comprehensive tests for semantic search functionality - Updated controller documentation to reflect Ollama requirement - All tests passing with 85%+ coverage Related changes: - Updated knowledge.service.versions.spec.ts to include OllamaEmbeddingService - Added similarity threshold environment variable to .env.example Fixes #70 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
Jason Woltje
@@ -4,7 +4,7 @@ import { EntryStatus } from "@prisma/client";
|
||||
import { SearchService } from "./search.service";
|
||||
import { PrismaService } from "../../prisma/prisma.service";
|
||||
import { KnowledgeCacheService } from "./cache.service";
|
||||
import { EmbeddingService } from "./embedding.service";
|
||||
import { OllamaEmbeddingService } from "./ollama-embedding.service";
|
||||
|
||||
describe("SearchService", () => {
|
||||
let service: SearchService;
|
||||
@@ -46,10 +46,11 @@ describe("SearchService", () => {
|
||||
isEnabled: vi.fn().mockReturnValue(false),
|
||||
};
|
||||
|
||||
const mockEmbeddingService = {
|
||||
isConfigured: vi.fn().mockReturnValue(false),
|
||||
generateEmbedding: vi.fn().mockResolvedValue(null),
|
||||
batchGenerateEmbeddings: vi.fn().mockResolvedValue([]),
|
||||
const mockOllamaEmbeddingService = {
|
||||
isConfigured: vi.fn().mockResolvedValue(false),
|
||||
generateEmbedding: vi.fn().mockResolvedValue([]),
|
||||
generateAndStoreEmbedding: vi.fn().mockResolvedValue(undefined),
|
||||
batchGenerateEmbeddings: vi.fn().mockResolvedValue(0),
|
||||
};
|
||||
|
||||
const module: TestingModule = await Test.createTestingModule({
|
||||
@@ -64,8 +65,8 @@ describe("SearchService", () => {
|
||||
useValue: mockCacheService,
|
||||
},
|
||||
{
|
||||
provide: EmbeddingService,
|
||||
useValue: mockEmbeddingService,
|
||||
provide: OllamaEmbeddingService,
|
||||
useValue: mockOllamaEmbeddingService,
|
||||
},
|
||||
],
|
||||
}).compile();
|
||||
@@ -410,4 +411,206 @@ describe("SearchService", () => {
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe("semanticSearch", () => {
|
||||
it("should throw error when OllamaEmbeddingService is not configured", async () => {
|
||||
const ollamaService = service["ollama"];
|
||||
ollamaService.isConfigured = vi.fn().mockResolvedValue(false);
|
||||
|
||||
await expect(service.semanticSearch("test query", mockWorkspaceId)).rejects.toThrow(
|
||||
"Semantic search requires Ollama to be configured"
|
||||
);
|
||||
});
|
||||
|
||||
it("should perform semantic search using vector similarity", async () => {
|
||||
const ollamaService = service["ollama"];
|
||||
ollamaService.isConfigured = vi.fn().mockResolvedValue(true);
|
||||
|
||||
// Mock embedding generation
|
||||
const mockEmbedding = new Array(1536).fill(0.1);
|
||||
ollamaService.generateEmbedding = vi.fn().mockResolvedValue(mockEmbedding);
|
||||
|
||||
const mockSearchResults = [
|
||||
{
|
||||
id: "entry-1",
|
||||
workspace_id: mockWorkspaceId,
|
||||
slug: "semantic-entry",
|
||||
title: "Semantic Entry",
|
||||
content: "This is semantically similar content",
|
||||
content_html: "<p>This is semantically similar content</p>",
|
||||
summary: null,
|
||||
status: EntryStatus.PUBLISHED,
|
||||
visibility: "WORKSPACE",
|
||||
created_at: new Date(),
|
||||
updated_at: new Date(),
|
||||
created_by: "user-1",
|
||||
updated_by: "user-1",
|
||||
rank: 0.85,
|
||||
headline: null,
|
||||
},
|
||||
];
|
||||
|
||||
prismaService.$queryRaw
|
||||
.mockResolvedValueOnce(mockSearchResults)
|
||||
.mockResolvedValueOnce([{ count: BigInt(1) }]);
|
||||
|
||||
prismaService.knowledgeEntryTag.findMany.mockResolvedValue([]);
|
||||
|
||||
const result = await service.semanticSearch("semantic query", mockWorkspaceId);
|
||||
|
||||
expect(result.data).toHaveLength(1);
|
||||
expect(result.data[0].rank).toBe(0.85);
|
||||
expect(ollamaService.generateEmbedding).toHaveBeenCalledWith("semantic query", {});
|
||||
expect(prismaService.$queryRaw).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("should apply similarity threshold filter", async () => {
|
||||
const ollamaService = service["ollama"];
|
||||
ollamaService.isConfigured = vi.fn().mockResolvedValue(true);
|
||||
|
||||
const mockEmbedding = new Array(1536).fill(0.1);
|
||||
ollamaService.generateEmbedding = vi.fn().mockResolvedValue(mockEmbedding);
|
||||
|
||||
// Set environment variable for similarity threshold
|
||||
process.env.SEMANTIC_SEARCH_SIMILARITY_THRESHOLD = "0.7";
|
||||
|
||||
const mockSearchResults = [
|
||||
{
|
||||
id: "entry-1",
|
||||
workspace_id: mockWorkspaceId,
|
||||
slug: "high-similarity",
|
||||
title: "High Similarity Entry",
|
||||
content: "Very similar content",
|
||||
content_html: "<p>Very similar content</p>",
|
||||
summary: null,
|
||||
status: EntryStatus.PUBLISHED,
|
||||
visibility: "WORKSPACE",
|
||||
created_at: new Date(),
|
||||
updated_at: new Date(),
|
||||
created_by: "user-1",
|
||||
updated_by: "user-1",
|
||||
rank: 0.9,
|
||||
headline: null,
|
||||
},
|
||||
];
|
||||
|
||||
prismaService.$queryRaw
|
||||
.mockResolvedValueOnce(mockSearchResults)
|
||||
.mockResolvedValueOnce([{ count: BigInt(1) }]);
|
||||
|
||||
prismaService.knowledgeEntryTag.findMany.mockResolvedValue([]);
|
||||
|
||||
const result = await service.semanticSearch("query", mockWorkspaceId);
|
||||
|
||||
expect(result.data).toHaveLength(1);
|
||||
expect(result.data[0].rank).toBeGreaterThanOrEqual(0.7);
|
||||
|
||||
// Clean up
|
||||
delete process.env.SEMANTIC_SEARCH_SIMILARITY_THRESHOLD;
|
||||
});
|
||||
|
||||
it("should handle pagination correctly", async () => {
|
||||
const ollamaService = service["ollama"];
|
||||
ollamaService.isConfigured = vi.fn().mockResolvedValue(true);
|
||||
|
||||
const mockEmbedding = new Array(1536).fill(0.1);
|
||||
ollamaService.generateEmbedding = vi.fn().mockResolvedValue(mockEmbedding);
|
||||
|
||||
prismaService.$queryRaw
|
||||
.mockResolvedValueOnce([])
|
||||
.mockResolvedValueOnce([{ count: BigInt(25) }]);
|
||||
|
||||
prismaService.knowledgeEntryTag.findMany.mockResolvedValue([]);
|
||||
|
||||
const result = await service.semanticSearch("query", mockWorkspaceId, {
|
||||
page: 2,
|
||||
limit: 10,
|
||||
});
|
||||
|
||||
expect(result.pagination.page).toBe(2);
|
||||
expect(result.pagination.limit).toBe(10);
|
||||
expect(result.pagination.total).toBe(25);
|
||||
expect(result.pagination.totalPages).toBe(3);
|
||||
});
|
||||
|
||||
it("should apply status filter when provided", async () => {
|
||||
const ollamaService = service["ollama"];
|
||||
ollamaService.isConfigured = vi.fn().mockResolvedValue(true);
|
||||
|
||||
const mockEmbedding = new Array(1536).fill(0.1);
|
||||
ollamaService.generateEmbedding = vi.fn().mockResolvedValue(mockEmbedding);
|
||||
|
||||
prismaService.$queryRaw
|
||||
.mockResolvedValueOnce([])
|
||||
.mockResolvedValueOnce([{ count: BigInt(0) }]);
|
||||
|
||||
prismaService.knowledgeEntryTag.findMany.mockResolvedValue([]);
|
||||
|
||||
await service.semanticSearch("query", mockWorkspaceId, {
|
||||
status: EntryStatus.DRAFT,
|
||||
});
|
||||
|
||||
// Verify the query was called with status filter
|
||||
expect(prismaService.$queryRaw).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("should include similarity scores in results", async () => {
|
||||
const ollamaService = service["ollama"];
|
||||
ollamaService.isConfigured = vi.fn().mockResolvedValue(true);
|
||||
|
||||
const mockEmbedding = new Array(1536).fill(0.1);
|
||||
ollamaService.generateEmbedding = vi.fn().mockResolvedValue(mockEmbedding);
|
||||
|
||||
const mockSearchResults = [
|
||||
{
|
||||
id: "entry-1",
|
||||
workspace_id: mockWorkspaceId,
|
||||
slug: "entry-1",
|
||||
title: "Entry 1",
|
||||
content: "Content 1",
|
||||
content_html: "<p>Content 1</p>",
|
||||
summary: null,
|
||||
status: EntryStatus.PUBLISHED,
|
||||
visibility: "WORKSPACE",
|
||||
created_at: new Date(),
|
||||
updated_at: new Date(),
|
||||
created_by: "user-1",
|
||||
updated_by: "user-1",
|
||||
rank: 0.95,
|
||||
headline: null,
|
||||
},
|
||||
{
|
||||
id: "entry-2",
|
||||
workspace_id: mockWorkspaceId,
|
||||
slug: "entry-2",
|
||||
title: "Entry 2",
|
||||
content: "Content 2",
|
||||
content_html: "<p>Content 2</p>",
|
||||
summary: null,
|
||||
status: EntryStatus.PUBLISHED,
|
||||
visibility: "WORKSPACE",
|
||||
created_at: new Date(),
|
||||
updated_at: new Date(),
|
||||
created_by: "user-1",
|
||||
updated_by: "user-1",
|
||||
rank: 0.75,
|
||||
headline: null,
|
||||
},
|
||||
];
|
||||
|
||||
prismaService.$queryRaw
|
||||
.mockResolvedValueOnce(mockSearchResults)
|
||||
.mockResolvedValueOnce([{ count: BigInt(2) }]);
|
||||
|
||||
prismaService.knowledgeEntryTag.findMany.mockResolvedValue([]);
|
||||
|
||||
const result = await service.semanticSearch("query", mockWorkspaceId);
|
||||
|
||||
expect(result.data).toHaveLength(2);
|
||||
expect(result.data[0].rank).toBe(0.95);
|
||||
expect(result.data[1].rank).toBe(0.75);
|
||||
// Verify results are ordered by similarity (descending)
|
||||
expect(result.data[0].rank).toBeGreaterThan(result.data[1].rank);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user