Files
Trilium/src/services/llm/trilium_context_service.ts

553 lines
22 KiB
TypeScript
Raw Normal View History

2025-03-10 03:34:48 +00:00
import becca from "../../becca/becca.js";
import vectorStore from "./embeddings/index.js";
2025-03-10 03:34:48 +00:00
import providerManager from "./embeddings/providers.js";
import options from "../options.js";
import log from "../log.js";
import type { Message } from "./ai_interface.js";
import { cosineSimilarity } from "./embeddings/index.js";
2025-03-10 18:53:36 +00:00
import sanitizeHtml from "sanitize-html";
2025-03-10 03:34:48 +00:00
/**
* TriliumContextService provides intelligent context management for working with large knowledge bases
* through limited context window LLMs like Ollama.
*
* It creates a "meta-prompting" approach where the first LLM call is used
* to determine what information might be needed to answer the query,
* then only the relevant context is loaded, before making the final
* response.
*/
class TriliumContextService {
private initialized = false;
private initPromise: Promise<void> | null = null;
private provider: any = null;
// Cache for recently used context to avoid repeated embedding lookups
private recentQueriesCache = new Map<string, {
timestamp: number,
relevantNotes: any[]
}>();
// Configuration
private cacheExpiryMs = 5 * 60 * 1000; // 5 minutes
private metaPrompt = `You are an AI assistant that decides what information needs to be retrieved from a knowledge base to answer the user's question.
Given the user's question, generate 3-5 specific search queries that would help find relevant information.
Each query should be focused on a different aspect of the question.
Format your answer as a JSON array of strings, with each string being a search query.
Example: ["exact topic mentioned", "related concept 1", "related concept 2"]`;
constructor() {
this.setupCacheCleanup();
}
/**
* Initialize the service
*/
async initialize() {
if (this.initialized) return;
// Use a promise to prevent multiple simultaneous initializations
if (this.initPromise) return this.initPromise;
this.initPromise = (async () => {
try {
2025-03-17 19:41:31 +00:00
// Get user's configured provider or fallback to ollama
const providerId = await options.getOption('embeddingsDefaultProvider') || 'ollama';
2025-03-10 03:34:48 +00:00
this.provider = providerManager.getEmbeddingProvider(providerId);
2025-03-17 19:41:31 +00:00
// If specified provider not found, try ollama as first fallback for self-hosted usage
2025-03-17 19:36:58 +00:00
if (!this.provider && providerId !== 'ollama') {
2025-03-17 19:41:31 +00:00
log.info(`Embedding provider ${providerId} not found, trying ollama as fallback`);
2025-03-17 19:36:58 +00:00
this.provider = providerManager.getEmbeddingProvider('ollama');
}
2025-03-17 19:41:31 +00:00
// If ollama not found, try openai as a second fallback
if (!this.provider && providerId !== 'openai') {
log.info(`Embedding provider ollama not found, trying openai as fallback`);
this.provider = providerManager.getEmbeddingProvider('openai');
}
2025-03-17 19:36:58 +00:00
// Final fallback to local provider which should always exist
if (!this.provider) {
log.info(`No embedding provider found, falling back to local provider`);
this.provider = providerManager.getEmbeddingProvider('local');
}
2025-03-10 03:34:48 +00:00
if (!this.provider) {
2025-03-17 19:36:58 +00:00
throw new Error(`No embedding provider available. Could not initialize context service.`);
2025-03-10 03:34:48 +00:00
}
this.initialized = true;
2025-03-17 19:36:58 +00:00
log.info(`Trilium context service initialized with provider: ${this.provider.name}`);
2025-03-10 03:34:48 +00:00
} catch (error: unknown) {
const errorMessage = error instanceof Error ? error.message : String(error);
log.error(`Failed to initialize Trilium context service: ${errorMessage}`);
throw error;
} finally {
this.initPromise = null;
}
})();
return this.initPromise;
}
/**
* Set up periodic cache cleanup
*/
private setupCacheCleanup() {
setInterval(() => {
const now = Date.now();
for (const [key, data] of this.recentQueriesCache.entries()) {
if (now - data.timestamp > this.cacheExpiryMs) {
this.recentQueriesCache.delete(key);
}
}
}, 60000); // Run cleanup every minute
}
/**
* Generate search queries to find relevant information for the user question
* @param userQuestion - The user's question
* @param llmService - The LLM service to use for generating queries
* @returns Array of search queries
*/
async generateSearchQueries(userQuestion: string, llmService: any): Promise<string[]> {
try {
const messages: Message[] = [
{ role: "system", content: this.metaPrompt },
{ role: "user", content: userQuestion }
];
const options = {
temperature: 0.3,
maxTokens: 300
};
2025-03-10 04:28:56 +00:00
// Get the response from the LLM using the correct method name
const response = await llmService.generateChatCompletion(messages, options);
const responseText = response.text; // Extract the text from the response object
2025-03-10 03:34:48 +00:00
try {
// Parse the JSON response
2025-03-10 04:28:56 +00:00
const jsonStr = responseText.trim().replace(/```json|```/g, '').trim();
2025-03-10 03:34:48 +00:00
const queries = JSON.parse(jsonStr);
if (Array.isArray(queries) && queries.length > 0) {
return queries;
} else {
throw new Error("Invalid response format");
}
} catch (parseError) {
// Fallback: if JSON parsing fails, try to extract queries line by line
2025-03-10 04:28:56 +00:00
const lines = responseText.split('\n')
2025-03-10 03:34:48 +00:00
.map((line: string) => line.trim())
.filter((line: string) => line.length > 0 && !line.startsWith('```'));
if (lines.length > 0) {
return lines.map((line: string) => line.replace(/^["'\d\.\-\s]+/, '').trim());
}
// If all else fails, just use the original question
return [userQuestion];
}
} catch (error: unknown) {
const errorMessage = error instanceof Error ? error.message : String(error);
log.error(`Error generating search queries: ${errorMessage}`);
// Fallback to just using the original question
return [userQuestion];
}
}
/**
* Find relevant notes using multiple search queries
* @param queries - Array of search queries
* @param contextNoteId - Optional note ID to restrict search to a branch
* @param limit - Max notes to return
* @returns Array of relevant notes
*/
async findRelevantNotesMultiQuery(
queries: string[],
contextNoteId: string | null = null,
limit = 10
): Promise<any[]> {
if (!this.initialized) {
await this.initialize();
}
try {
// Cache key combining all queries
const cacheKey = JSON.stringify({ queries, contextNoteId, limit });
// Check if we have a recent cache hit
const cached = this.recentQueriesCache.get(cacheKey);
if (cached) {
return cached.relevantNotes;
}
// Array to store all results with their similarity scores
const allResults: {
noteId: string,
title: string,
content: string | null,
similarity: number,
branchId?: string
}[] = [];
// Set to keep track of note IDs we've seen to avoid duplicates
const seenNoteIds = new Set<string>();
// Process each query
for (const query of queries) {
2025-03-10 04:28:56 +00:00
// Get embeddings for this query using the correct method name
const queryEmbedding = await this.provider.generateEmbeddings(query);
2025-03-10 03:34:48 +00:00
// Find notes similar to this query
let results;
if (contextNoteId) {
// Find within a specific context/branch
results = await this.findNotesInBranch(
queryEmbedding,
contextNoteId,
Math.min(limit, 5) // Limit per query
);
} else {
// Search all notes
results = await vectorStore.findSimilarNotes(
queryEmbedding,
2025-03-10 04:28:56 +00:00
this.provider.name, // Use name property instead of id
this.provider.getConfig().model, // Use getConfig().model instead of modelId
2025-03-10 03:34:48 +00:00
Math.min(limit, 5), // Limit per query
0.5 // Lower threshold to get more diverse results
);
}
// Process results
for (const result of results) {
if (!seenNoteIds.has(result.noteId)) {
seenNoteIds.add(result.noteId);
// Get the note from Becca
const note = becca.notes[result.noteId];
if (!note) continue;
// Add to our results
allResults.push({
noteId: result.noteId,
title: note.title,
content: note.type === 'text' ? note.getContent() as string : null,
similarity: result.similarity,
branchId: note.getBranches()[0]?.branchId
});
}
}
}
// Sort by similarity and take the top 'limit' results
const sortedResults = allResults
.sort((a, b) => b.similarity - a.similarity)
.slice(0, limit);
// Cache the results
this.recentQueriesCache.set(cacheKey, {
timestamp: Date.now(),
relevantNotes: sortedResults
});
return sortedResults;
} catch (error: unknown) {
const errorMessage = error instanceof Error ? error.message : String(error);
log.error(`Error finding relevant notes: ${errorMessage}`);
return [];
}
}
/**
* Find notes in a specific branch/context
* @param embedding - Query embedding
* @param contextNoteId - Note ID to restrict search to
* @param limit - Max notes to return
* @returns Array of relevant notes
*/
private async findNotesInBranch(
embedding: Float32Array,
contextNoteId: string,
limit = 5
): Promise<{noteId: string, similarity: number}[]> {
try {
// Get the subtree note IDs
const subtreeNoteIds = await this.getSubtreeNoteIds(contextNoteId);
if (subtreeNoteIds.length === 0) {
return [];
}
// Get all embeddings for these notes using vectorStore instead of direct SQL
const similarities: {noteId: string, similarity: number}[] = [];
for (const noteId of subtreeNoteIds) {
const noteEmbedding = await vectorStore.getEmbeddingForNote(
noteId,
2025-03-10 04:28:56 +00:00
this.provider.name, // Use name property instead of id
this.provider.getConfig().model // Use getConfig().model instead of modelId
2025-03-10 03:34:48 +00:00
);
if (noteEmbedding) {
const similarity = cosineSimilarity(embedding, noteEmbedding.embedding);
if (similarity > 0.5) { // Apply similarity threshold
similarities.push({
noteId,
similarity
});
}
}
}
// Sort by similarity and return top results
return similarities
.sort((a, b) => b.similarity - a.similarity)
.slice(0, limit);
} catch (error: unknown) {
const errorMessage = error instanceof Error ? error.message : String(error);
log.error(`Error finding notes in branch: ${errorMessage}`);
return [];
}
}
/**
* Get all note IDs in a subtree (including the root note)
* @param rootNoteId - Root note ID
* @returns Array of note IDs
*/
private async getSubtreeNoteIds(rootNoteId: string): Promise<string[]> {
const note = becca.notes[rootNoteId];
if (!note) {
return [];
}
// Use becca to walk the note tree instead of direct SQL
const noteIds = new Set<string>([rootNoteId]);
// Helper function to collect all children
const collectChildNotes = (noteId: string) => {
// Use becca.getNote(noteId).getChildNotes() to get child notes
const parentNote = becca.notes[noteId];
if (!parentNote) return;
// Get all branches where this note is the parent
for (const branch of Object.values(becca.branches)) {
if (branch.parentNoteId === noteId && !branch.isDeleted) {
const childNoteId = branch.noteId;
if (!noteIds.has(childNoteId)) {
noteIds.add(childNoteId);
// Recursively collect children of this child
collectChildNotes(childNoteId);
}
}
}
};
// Start collecting from the root
collectChildNotes(rootNoteId);
return Array.from(noteIds);
}
/**
2025-03-11 23:04:51 +00:00
* Build context string from retrieved notes
2025-03-10 03:34:48 +00:00
*/
2025-03-11 23:04:51 +00:00
async buildContextFromNotes(sources: any[], query: string): Promise<string> {
2025-03-10 03:34:48 +00:00
if (!sources || sources.length === 0) {
2025-03-10 04:28:56 +00:00
// Return a default context instead of empty string
return "I am an AI assistant helping you with your Trilium notes. " +
"I couldn't find any specific notes related to your query, but I'll try to assist you " +
"with general knowledge about Trilium or other topics you're interested in.";
2025-03-10 03:34:48 +00:00
}
2025-03-11 22:47:36 +00:00
let context = `I've found some relevant information in your notes that may help answer: "${query}"\n\n`;
2025-03-10 03:34:48 +00:00
2025-03-11 23:04:51 +00:00
// Sort sources by similarity if available to prioritize most relevant
if (sources[0] && sources[0].similarity !== undefined) {
sources = [...sources].sort((a, b) => (b.similarity || 0) - (a.similarity || 0));
}
// Get provider name to adjust context for different models
const providerId = this.provider?.name || 'default';
// Get approximate max length based on provider using constants
// Import the constants dynamically to avoid circular dependencies
const { LLM_CONSTANTS } = await import('../../routes/api/llm.js');
const maxTotalLength = providerId === 'ollama' ? LLM_CONSTANTS.CONTEXT_WINDOW.OLLAMA :
providerId === 'openai' ? LLM_CONSTANTS.CONTEXT_WINDOW.OPENAI :
LLM_CONSTANTS.CONTEXT_WINDOW.ANTHROPIC;
// Track total context length to avoid oversized context
let currentLength = context.length;
const maxNoteContentLength = Math.min(LLM_CONSTANTS.CONTENT.MAX_NOTE_CONTENT_LENGTH,
Math.floor(maxTotalLength / Math.max(1, sources.length)));
2025-03-11 22:47:36 +00:00
sources.forEach((source) => {
2025-03-11 23:04:51 +00:00
// Check if adding this source would exceed our total limit
if (currentLength >= maxTotalLength) return;
// Build source section
let sourceSection = `### ${source.title}\n`;
2025-03-11 22:47:36 +00:00
// Add relationship context if available
if (source.parentTitle) {
2025-03-11 23:04:51 +00:00
sourceSection += `Part of: ${source.parentTitle}\n`;
}
// Add attributes if available (for better context)
if (source.noteId) {
const note = becca.notes[source.noteId];
if (note) {
const labels = note.getLabels();
if (labels.length > 0) {
sourceSection += `Labels: ${labels.map(l => `#${l.name}${l.value ? '=' + l.value : ''}`).join(' ')}\n`;
}
}
2025-03-11 22:47:36 +00:00
}
2025-03-10 03:34:48 +00:00
if (source.content) {
2025-03-10 18:53:36 +00:00
// Clean up HTML content before adding it to the context
let cleanContent = this.sanitizeNoteContent(source.content, source.type, source.mime);
2025-03-10 03:34:48 +00:00
// Truncate content if it's too long
2025-03-11 23:04:51 +00:00
if (cleanContent.length > maxNoteContentLength) {
cleanContent = cleanContent.substring(0, maxNoteContentLength) + " [content truncated due to length]";
2025-03-10 03:34:48 +00:00
}
2025-03-11 23:04:51 +00:00
sourceSection += `${cleanContent}\n`;
2025-03-10 03:34:48 +00:00
} else {
2025-03-11 23:04:51 +00:00
sourceSection += "[This note doesn't contain textual content]\n";
2025-03-10 03:34:48 +00:00
}
2025-03-11 23:04:51 +00:00
sourceSection += "\n";
// Check if adding this section would exceed total length limit
if (currentLength + sourceSection.length <= maxTotalLength) {
context += sourceSection;
currentLength += sourceSection.length;
}
2025-03-10 03:34:48 +00:00
});
2025-03-11 22:47:36 +00:00
// Add clear instructions about how to reference the notes
context += "When referring to information from these notes in your response, please cite them by their titles " +
"(e.g., \"According to your note on [Title]...\") rather than using labels like \"Note 1\" or \"Note 2\".\n\n";
context += "If the information doesn't contain what you need, just say so and use your general knowledge instead.";
2025-03-10 03:34:48 +00:00
return context;
}
2025-03-10 18:53:36 +00:00
/**
* Sanitize note content for use in context, removing HTML tags
*/
private sanitizeNoteContent(content: string, type?: string, mime?: string): string {
if (!content) return '';
// If it's likely HTML content
if (
(type === 'text' && mime === 'text/html') ||
content.includes('<div') ||
content.includes('<p>') ||
content.includes('<span')
) {
// Use sanitizeHtml to remove all HTML tags
content = sanitizeHtml(content, {
allowedTags: [],
allowedAttributes: {},
textFilter: (text) => {
// Replace multiple newlines with a single one
return text.replace(/\n\s*\n/g, '\n\n');
}
});
// Additional cleanup for remaining HTML entities
content = content
.replace(/&nbsp;/g, ' ')
.replace(/&lt;/g, '<')
.replace(/&gt;/g, '>')
.replace(/&amp;/g, '&')
.replace(/&quot;/g, '"')
.replace(/&#39;/g, "'");
}
// Normalize whitespace
content = content.replace(/\s+/g, ' ').trim();
return content;
}
2025-03-10 03:34:48 +00:00
/**
* Process a user query with the Trilium-specific approach:
* 1. Generate search queries from the original question
* 2. Find relevant notes using those queries
* 3. Build a context string from the relevant notes
*
* @param userQuestion - The user's original question
* @param llmService - The LLM service to use
* @param contextNoteId - Optional note ID to restrict search to
* @returns Object with context and notes
*/
async processQuery(userQuestion: string, llmService: any, contextNoteId: string | null = null) {
if (!this.initialized) {
2025-03-10 04:28:56 +00:00
try {
await this.initialize();
} catch (error) {
log.error(`Failed to initialize TriliumContextService: ${error}`);
// Return a fallback response if initialization fails
return {
context: "I am an AI assistant helping you with your Trilium notes. " +
"I'll try to assist you with general knowledge about your query.",
notes: [],
queries: [userQuestion]
};
}
2025-03-10 03:34:48 +00:00
}
2025-03-10 04:28:56 +00:00
try {
// Step 1: Generate search queries
let searchQueries: string[];
try {
searchQueries = await this.generateSearchQueries(userQuestion, llmService);
} catch (error) {
log.error(`Error generating search queries, using fallback: ${error}`);
searchQueries = [userQuestion]; // Fallback to using the original question
}
log.info(`Generated search queries: ${JSON.stringify(searchQueries)}`);
2025-03-10 03:34:48 +00:00
2025-03-10 04:28:56 +00:00
// Step 2: Find relevant notes using those queries
let relevantNotes: any[] = [];
try {
relevantNotes = await this.findRelevantNotesMultiQuery(
searchQueries,
contextNoteId,
8 // Get more notes since we're using multiple queries
);
} catch (error) {
log.error(`Error finding relevant notes: ${error}`);
// Continue with empty notes list
}
2025-03-10 03:34:48 +00:00
2025-03-10 04:28:56 +00:00
// Step 3: Build context from the notes
2025-03-11 23:04:51 +00:00
const context = await this.buildContextFromNotes(relevantNotes, userQuestion);
2025-03-10 03:34:48 +00:00
2025-03-10 04:28:56 +00:00
return {
context,
notes: relevantNotes,
queries: searchQueries
};
} catch (error) {
log.error(`Error in processQuery: ${error}`);
// Return a fallback response if anything fails
return {
context: "I am an AI assistant helping you with your Trilium notes. " +
"I encountered an error while processing your query, but I'll try to assist you anyway.",
notes: [],
queries: [userQuestion]
};
}
2025-03-10 03:34:48 +00:00
}
}
export default new TriliumContextService();