illuma-agents 1.0.2

package/src/tools/search/highlights.ts

@@ -0,0 +1,320 @@
+import type * as t from './types';
+
+// 2. Pre-compile all regular expressions (only do this once)
+// Group patterns by priority for early returns
+const priorityPatterns = [
+  // High priority patterns (structural)
+  [
+    { regex: /\n\n/g }, // Double newline (paragraph break)
+    { regex: /\n/g }, // Single newline
+    { regex: /={3,}\s*\n|-{3,}\s*\n/g }, // Section separators
+  ],
+  // Medium priority (semantic)
+  [
+    { regex: /[.!?][")\]]?\s/g }, // End of sentence
+    { regex: /;\s/g }, // Semicolon
+    { regex: /:\s/g }, // Colon
+  ],
+  // Low priority (any breaks)
+  [
+    { regex: /,\s/g }, // Comma
+    { regex: /\s-\s/g }, // Dash surrounded by spaces
+    { regex: /\s/g }, // Any space
+  ],
+];
+
+function findFirstMatch(text: string, regex: RegExp): number {
+  // Reset regex
+  regex.lastIndex = 0;
+
+  // For very long texts, try chunking
+  if (text.length > 10000) {
+    const chunkSize = 2000;
+    let position = 0;
+
+    while (position < text.length) {
+      const chunk = text.substring(position, position + chunkSize);
+      regex.lastIndex = 0;
+
+      const match = regex.exec(chunk);
+      if (match) {
+        return position + match.index;
+      }
+
+      // Move to next chunk with some overlap
+      position += chunkSize - 100;
+      if (position >= text.length) break;
+    }
+    return -1;
+  }
+
+  // For shorter texts, normal regex search
+  const match = regex.exec(text);
+  return match ? match.index : -1;
+}
+
+// 3. Optimized boundary finding functions
+function findLastMatch(text: string, regex: RegExp): number {
+  // Reset regex state
+  regex.lastIndex = 0;
+
+  let lastIndex = -1;
+  let lastLength = 0;
+  let match;
+
+  // For very long texts, use a different approach to avoid regex engine slowdowns
+  if (text.length > 10000) {
+    // Try dividing the text into chunks for faster processing
+    const chunkSize = 2000;
+    let startPosition = Math.max(0, text.length - chunkSize);
+
+    while (startPosition >= 0) {
+      const chunk = text.substring(startPosition, startPosition + chunkSize);
+      regex.lastIndex = 0;
+
+      let chunkLastIndex = -1;
+      let chunkLastLength = 0;
+
+      while ((match = regex.exec(chunk)) !== null) {
+        chunkLastIndex = match.index;
+        chunkLastLength = match[0].length;
+      }
+
+      if (chunkLastIndex !== -1) {
+        return startPosition + chunkLastIndex + chunkLastLength;
+      }
+
+      // Move to previous chunk with some overlap
+      startPosition = Math.max(0, startPosition - chunkSize + 100) - 1;
+      if (startPosition <= 0) break;
+    }
+    return -1;
+  }
+
+  // For shorter texts, normal regex search
+  while ((match = regex.exec(text)) !== null) {
+    lastIndex = match.index;
+    lastLength = match[0].length;
+  }
+
+  return lastIndex === -1 ? -1 : lastIndex + lastLength;
+}
+
+// 4. Find the best boundary with priority groups
+function findBestBoundary(text: string, direction = 'backward'): number {
+  if (!text || text.length === 0) return 0;
+
+  // Try each priority group
+  for (const patternGroup of priorityPatterns) {
+    for (const pattern of patternGroup) {
+      const position =
+        direction === 'backward'
+          ? findLastMatch(text, pattern.regex)
+          : findFirstMatch(text, pattern.regex);
+
+      if (position !== -1) {
+        return position;
+      }
+    }
+  }
+
+  // No match found, use character boundary
+  return direction === 'backward' ? text.length : 0;
+}
+
+/**
+ * Tracks references used in a highlight without changing their numbers
+ */
+function trackReferencesInHighlight(
+  text: string,
+  sourceResult: t.ValidSource // Source containing the original references
+): {
+  references: {
+    type: 'link' | 'image' | 'video';
+    originalIndex: number;
+    reference: t.MediaReference; // Original reference object
+  }[];
+} {
+  // Track used references
+  const references: {
+    type: 'link' | 'image' | 'video';
+    originalIndex: number;
+    reference: t.MediaReference;
+  }[] = [];
+
+  if (!text || text.length === 0 || !text.includes('#')) {
+    return { references }; // Early return
+  }
+
+  // Quick check for reference markers
+  if (
+    !text.includes('link#') &&
+    !text.includes('image#') &&
+    !text.includes('video#')
+  ) {
+    return { references };
+  }
+
+  // Get references from the source if available
+  const sourceRefs = sourceResult.references || {
+    links: [],
+    images: [],
+    videos: [],
+  };
+
+  // Find references but don't modify text
+  const refRegex = /\((link|image|video)#(\d+)(?:\s+"([^"]*)")?\)/g;
+  let match;
+
+  while ((match = refRegex.exec(text)) !== null) {
+    const [, type, indexStr] = match;
+    const originalIndex = parseInt(indexStr, 10) - 1; // Convert to 0-based
+
+    // Get the source array for this type
+    const refType = type as 'link' | 'image' | 'video';
+    const sourceArray = sourceRefs[`${refType}s`] as
+      | t.MediaReference[]
+      | undefined;
+
+    // Skip if invalid reference
+    if (
+      !sourceArray ||
+      originalIndex < 0 ||
+      originalIndex >= sourceArray.length
+    ) {
+      continue; // Skip invalid references
+    }
+
+    // Get original reference
+    const reference = sourceArray[originalIndex];
+
+    // Track if not already tracked
+    const alreadyTracked = references.some(
+      (ref) => ref.type === refType && ref.originalIndex === originalIndex
+    );
+
+    if (!alreadyTracked) {
+      references.push({
+        type: refType,
+        originalIndex,
+        reference,
+      });
+    }
+  }
+
+  return { references };
+}
+
+/**
+ * Expand highlights in search results using smart boundary detection.
+ *
+ * This implementation finds natural text boundaries like paragraphs, sentences,
+ * and phrases to provide context while maintaining readability.
+ *
+ * @param searchResults - Search results object
+ * @param mainExpandBy - Primary expansion size on each side (default: 300)
+ * @param separatorExpandBy - Additional range to look for separators (default: 150)
+ * @returns Copy of search results with expanded highlights and tracked references
+ */
+export function expandHighlights(
+  searchResults: t.SearchResultData,
+  mainExpandBy = 300,
+  separatorExpandBy = 150
+): t.SearchResultData {
+  // Avoid deep copy - only copy what we modify
+  const resultCopy = { ...searchResults };
+  if (resultCopy.organic) resultCopy.organic = [...resultCopy.organic];
+  if (resultCopy.topStories) resultCopy.topStories = [...resultCopy.topStories];
+
+  // Process the results efficiently
+  const processResultTypes = ['organic', 'topStories'] as const;
+
+  for (const resultType of processResultTypes) {
+    if (!resultCopy[resultType as 'organic' | 'topStories']) continue;
+
+    // Map results to new array with modified highlights
+    resultCopy[resultType] = resultCopy[resultType]?.map((result) => {
+      if (
+        result.content == null ||
+        result.content === '' ||
+        !result.highlights ||
+        result.highlights.length === 0
+      ) {
+        return result; // No modification needed
+      }
+
+      // Create a shallow copy with expanded highlights
+      const resultCopy = { ...result };
+      const content = result.content;
+      const highlights = [];
+      // Process each highlight
+      for (const highlight of result.highlights) {
+        const { references } = trackReferencesInHighlight(
+          highlight.text,
+          result
+        );
+
+        let startPos = content.indexOf(highlight.text);
+        let highlightLen = highlight.text.length;
+
+        if (startPos === -1) {
+          // Try with stripped whitespace
+          const strippedHighlight = highlight.text.trim();
+          startPos = content.indexOf(strippedHighlight);
+
+          if (startPos === -1) {
+            highlights.push({
+              text: highlight.text,
+              score: highlight.score,
+              references,
+            });
+            continue;
+          }
+          highlightLen = strippedHighlight.length;
+        }
+
+        // Calculate boundaries
+        const mainStart = Math.max(0, startPos - mainExpandBy);
+        const mainEnd = Math.min(
+          content.length,
+          startPos + highlightLen + mainExpandBy
+        );
+
+        const separatorStart = Math.max(0, mainStart - separatorExpandBy);
+        const separatorEnd = Math.min(
+          content.length,
+          mainEnd + separatorExpandBy
+        );
+
+        // Extract text segments
+        const headText = content.substring(separatorStart, mainStart);
+        const tailText = content.substring(mainEnd, separatorEnd);
+
+        // Find natural boundaries
+        const bestHeadBoundary = findBestBoundary(headText, 'backward');
+        const bestTailBoundary = findBestBoundary(tailText, 'forward');
+
+        // Calculate final positions
+        const finalStart = separatorStart + bestHeadBoundary;
+        const finalEnd = mainEnd + bestTailBoundary;
+
+        // Extract the expanded highlight
+        const expandedHighlightText = content
+          .substring(finalStart, finalEnd)
+          .trim();
+        highlights.push({
+          text: expandedHighlightText,
+          score: highlight.score,
+          references,
+        });
+      }
+
+      resultCopy.highlights = highlights;
+      delete resultCopy.content;
+      delete resultCopy.references;
+      return resultCopy;
+    });
+  }
+
+  return resultCopy;
+}

package/src/tools/search/index.ts

@@ -0,0 +1,2 @@
+export * from './tool';
+export type * from './types';

package/src/tools/search/jina-reranker.test.ts

@@ -0,0 +1,126 @@
+import { JinaReranker } from './rerankers';
+import { createDefaultLogger } from './utils';
+
+describe('JinaReranker', () => {
+  const mockLogger = createDefaultLogger();
+  
+  describe('constructor', () => {
+    it('should use default API URL when no apiUrl is provided', () => {
+      const reranker = new JinaReranker({
+        apiKey: 'test-key',
+        logger: mockLogger,
+      });
+      
+      // Access private property for testing
+      const apiUrl = (reranker as any).apiUrl;
+      expect(apiUrl).toBe('https://api.jina.ai/v1/rerank');
+    });
+
+    it('should use custom API URL when provided', () => {
+      const customUrl = 'https://custom-jina-endpoint.com/v1/rerank';
+      const reranker = new JinaReranker({
+        apiKey: 'test-key',
+        apiUrl: customUrl,
+        logger: mockLogger,
+      });
+      
+      const apiUrl = (reranker as any).apiUrl;
+      expect(apiUrl).toBe(customUrl);
+    });
+
+    it('should use environment variable JINA_API_URL when available', () => {
+      const originalEnv = process.env.JINA_API_URL;
+      process.env.JINA_API_URL = 'https://env-jina-endpoint.com/v1/rerank';
+      
+      const reranker = new JinaReranker({
+        apiKey: 'test-key',
+        logger: mockLogger,
+      });
+      
+      const apiUrl = (reranker as any).apiUrl;
+      expect(apiUrl).toBe('https://env-jina-endpoint.com/v1/rerank');
+      
+      // Restore original environment
+      if (originalEnv) {
+        process.env.JINA_API_URL = originalEnv;
+      } else {
+        delete process.env.JINA_API_URL;
+      }
+    });
+
+    it('should prioritize explicit apiUrl over environment variable', () => {
+      const originalEnv = process.env.JINA_API_URL;
+      process.env.JINA_API_URL = 'https://env-jina-endpoint.com/v1/rerank';
+      
+      const customUrl = 'https://explicit-jina-endpoint.com/v1/rerank';
+      const reranker = new JinaReranker({
+        apiKey: 'test-key',
+        apiUrl: customUrl,
+        logger: mockLogger,
+      });
+      
+      const apiUrl = (reranker as any).apiUrl;
+      expect(apiUrl).toBe(customUrl);
+      
+      // Restore original environment
+      if (originalEnv) {
+        process.env.JINA_API_URL = originalEnv;
+      } else {
+        delete process.env.JINA_API_URL;
+      }
+    });
+  });
+
+  describe('rerank method', () => {
+    it('should log the API URL being used', async () => {
+      const customUrl = 'https://test-jina-endpoint.com/v1/rerank';
+      const reranker = new JinaReranker({
+        apiKey: 'test-key',
+        apiUrl: customUrl,
+        logger: mockLogger,
+      });
+      
+      const logSpy = jest.spyOn(mockLogger, 'debug');
+      
+      try {
+        await reranker.rerank('test query', ['document1', 'document2'], 2);
+      } catch (error) {
+        // Expected to fail due to missing API key, but we can check the log
+      }
+      
+      expect(logSpy).toHaveBeenCalledWith(
+        expect.stringContaining(`Reranking 2 chunks with Jina using API URL: ${customUrl}`)
+      );
+      
+      logSpy.mockRestore();
+    });
+  });
+});
+
+describe('createReranker', () => {
+  const { createReranker } = require('./rerankers');
+  
+  it('should create JinaReranker with jinaApiUrl when provided', () => {
+    const customUrl = 'https://custom-jina-endpoint.com/v1/rerank';
+    const reranker = createReranker({
+      rerankerType: 'jina',
+      jinaApiKey: 'test-key',
+      jinaApiUrl: customUrl,
+    });
+    
+    expect(reranker).toBeInstanceOf(JinaReranker);
+    const apiUrl = (reranker as any).apiUrl;
+    expect(apiUrl).toBe(customUrl);
+  });
+
+  it('should create JinaReranker with default URL when jinaApiUrl is not provided', () => {
+    const reranker = createReranker({
+      rerankerType: 'jina',
+      jinaApiKey: 'test-key',
+    });
+    
+    expect(reranker).toBeInstanceOf(JinaReranker);
+    const apiUrl = (reranker as any).apiUrl;
+    expect(apiUrl).toBe('https://api.jina.ai/v1/rerank');
+  });
+});