illuma-agents 1.0.8 → 1.0.9

package/src/tools/search/rerankers.ts

@@ -1,242 +1,242 @@
-import axios from 'axios';
-import type * as t from './types';
-import { createDefaultLogger } from './utils';
-
-export abstract class BaseReranker {
-  protected apiKey: string | undefined;
-  protected logger: t.Logger;
-
-  constructor(logger?: t.Logger) {
-    // Each specific reranker will set its API key
-    this.logger = logger || createDefaultLogger();
-  }
-
-  abstract rerank(
-    query: string,
-    documents: string[],
-    topK?: number
-  ): Promise<t.Highlight[]>;
-
-  protected getDefaultRanking(
-    documents: string[],
-    topK: number
-  ): t.Highlight[] {
-    return documents
-      .slice(0, Math.min(topK, documents.length))
-      .map((doc) => ({ text: doc, score: 0 }));
-  }
-}
-
-export class JinaReranker extends BaseReranker {
-  private apiUrl: string;
-
-  constructor({
-    apiKey = process.env.JINA_API_KEY,
-    apiUrl = process.env.JINA_API_URL || 'https://api.jina.ai/v1/rerank',
-    logger,
-  }: {
-    apiKey?: string;
-    apiUrl?: string;
-    logger?: t.Logger;
-  }) {
-    super(logger);
-    this.apiKey = apiKey;
-    this.apiUrl = apiUrl;
-  }
-
-  async rerank(
-    query: string,
-    documents: string[],
-    topK: number = 5
-  ): Promise<t.Highlight[]> {
-    this.logger.debug(`Reranking ${documents.length} chunks with Jina using API URL: ${this.apiUrl}`);
-
-    try {
-      if (this.apiKey == null || this.apiKey === '') {
-        this.logger.warn('JINA_API_KEY is not set. Using default ranking.');
-        return this.getDefaultRanking(documents, topK);
-      }
-
-      const requestData = {
-        model: 'jina-reranker-v2-base-multilingual',
-        query: query,
-        top_n: topK,
-        documents: documents,
-        return_documents: true,
-      };
-
-      const response = await axios.post<t.JinaRerankerResponse | undefined>(
-        this.apiUrl,
-        requestData,
-        {
-          headers: {
-            'Content-Type': 'application/json',
-            Authorization: `Bearer ${this.apiKey}`,
-          },
-        }
-      );
-
-      this.logger.debug('Jina API Model:', response.data?.model);
-      this.logger.debug('Jina API Usage:', response.data?.usage);
-
-      if (response.data && response.data.results.length) {
-        return response.data.results.map((result) => {
-          const docIndex = result.index;
-          const score = result.relevance_score;
-          let text = '';
-
-          // If return_documents is true, the document field will be present
-          if (result.document != null) {
-            const doc = result.document;
-            if (typeof doc === 'object' && 'text' in doc) {
-              text = doc.text;
-            } else if (typeof doc === 'string') {
-              text = doc;
-            }
-          } else {
-            // Otherwise, use the index to get the document
-            text = documents[docIndex];
-          }
-
-          return { text, score };
-        });
-      } else {
-        this.logger.warn(
-          'Unexpected response format from Jina API. Using default ranking.'
-        );
-        return this.getDefaultRanking(documents, topK);
-      }
-    } catch (error) {
-      this.logger.error('Error using Jina reranker:', error);
-      // Fallback to default ranking on error
-      return this.getDefaultRanking(documents, topK);
-    }
-  }
-}
-
-export class CohereReranker extends BaseReranker {
-  constructor({
-    apiKey = process.env.COHERE_API_KEY,
-    logger,
-  }: {
-    apiKey?: string;
-    logger?: t.Logger;
-  }) {
-    super(logger);
-    this.apiKey = apiKey;
-  }
-
-  async rerank(
-    query: string,
-    documents: string[],
-    topK: number = 5
-  ): Promise<t.Highlight[]> {
-    this.logger.debug(`Reranking ${documents.length} chunks with Cohere`);
-
-    try {
-      if (this.apiKey == null || this.apiKey === '') {
-        this.logger.warn('COHERE_API_KEY is not set. Using default ranking.');
-        return this.getDefaultRanking(documents, topK);
-      }
-
-      const requestData = {
-        model: 'rerank-v3.5',
-        query: query,
-        top_n: topK,
-        documents: documents,
-      };
-
-      const response = await axios.post<t.CohereRerankerResponse | undefined>(
-        'https://api.cohere.com/v2/rerank',
-        requestData,
-        {
-          headers: {
-            'Content-Type': 'application/json',
-            Authorization: `Bearer ${this.apiKey}`,
-          },
-        }
-      );
-
-      this.logger.debug('Cohere API ID:', response.data?.id);
-      this.logger.debug('Cohere API Meta:', response.data?.meta);
-
-      if (response.data && response.data.results.length) {
-        return response.data.results.map((result) => {
-          const docIndex = result.index;
-          const score = result.relevance_score;
-          const text = documents[docIndex];
-          return { text, score };
-        });
-      } else {
-        this.logger.warn(
-          'Unexpected response format from Cohere API. Using default ranking.'
-        );
-        return this.getDefaultRanking(documents, topK);
-      }
-    } catch (error) {
-      this.logger.error('Error using Cohere reranker:', error);
-      // Fallback to default ranking on error
-      return this.getDefaultRanking(documents, topK);
-    }
-  }
-}
-
-export class InfinityReranker extends BaseReranker {
-  constructor(logger?: t.Logger) {
-    super(logger);
-    // No API key needed for the placeholder implementation
-  }
-
-  async rerank(
-    query: string,
-    documents: string[],
-    topK: number = 5
-  ): Promise<t.Highlight[]> {
-    this.logger.debug(
-      `Reranking ${documents.length} chunks with Infinity (placeholder)`
-    );
-    // This would be replaced with actual Infinity reranker implementation
-    return this.getDefaultRanking(documents, topK);
-  }
-}
-
-/**
- * Creates the appropriate reranker based on type and configuration
- */
-export const createReranker = (config: {
-  rerankerType: t.RerankerType;
-  jinaApiKey?: string;
-  jinaApiUrl?: string;
-  cohereApiKey?: string;
-  logger?: t.Logger;
-}): BaseReranker | undefined => {
-  const { rerankerType, jinaApiKey, jinaApiUrl, cohereApiKey, logger } = config;
-
-  // Create a default logger if none is provided
-  const defaultLogger = logger || createDefaultLogger();
-
-  switch (rerankerType.toLowerCase()) {
-  case 'jina':
-    return new JinaReranker({ apiKey: jinaApiKey, apiUrl: jinaApiUrl, logger: defaultLogger });
-  case 'cohere':
-    return new CohereReranker({
-      apiKey: cohereApiKey,
-      logger: defaultLogger,
-    });
-  case 'infinity':
-    return new InfinityReranker(defaultLogger);
-  case 'none':
-    defaultLogger.debug('Skipping reranking as reranker is set to "none"');
-    return undefined;
-  default:
-    defaultLogger.warn(
-      `Unknown reranker type: ${rerankerType}. Defaulting to InfinityReranker.`
-    );
-    return new JinaReranker({ apiKey: jinaApiKey, apiUrl: jinaApiUrl, logger: defaultLogger });
-  }
-};
-
-// Example usage:
-// const jinaReranker = new JinaReranker();
-// const cohereReranker = new CohereReranker();
-// const infinityReranker = new InfinityReranker();
+import axios from 'axios';
+import type * as t from './types';
+import { createDefaultLogger } from './utils';
+
+export abstract class BaseReranker {
+  protected apiKey: string | undefined;
+  protected logger: t.Logger;
+
+  constructor(logger?: t.Logger) {
+    // Each specific reranker will set its API key
+    this.logger = logger || createDefaultLogger();
+  }
+
+  abstract rerank(
+    query: string,
+    documents: string[],
+    topK?: number
+  ): Promise<t.Highlight[]>;
+
+  protected getDefaultRanking(
+    documents: string[],
+    topK: number
+  ): t.Highlight[] {
+    return documents
+      .slice(0, Math.min(topK, documents.length))
+      .map((doc) => ({ text: doc, score: 0 }));
+  }
+}
+
+export class JinaReranker extends BaseReranker {
+  private apiUrl: string;
+
+  constructor({
+    apiKey = process.env.JINA_API_KEY,
+    apiUrl = process.env.JINA_API_URL || 'https://api.jina.ai/v1/rerank',
+    logger,
+  }: {
+    apiKey?: string;
+    apiUrl?: string;
+    logger?: t.Logger;
+  }) {
+    super(logger);
+    this.apiKey = apiKey;
+    this.apiUrl = apiUrl;
+  }
+
+  async rerank(
+    query: string,
+    documents: string[],
+    topK: number = 5
+  ): Promise<t.Highlight[]> {
+    this.logger.debug(`Reranking ${documents.length} chunks with Jina using API URL: ${this.apiUrl}`);
+
+    try {
+      if (this.apiKey == null || this.apiKey === '') {
+        this.logger.warn('JINA_API_KEY is not set. Using default ranking.');
+        return this.getDefaultRanking(documents, topK);
+      }
+
+      const requestData = {
+        model: 'jina-reranker-v2-base-multilingual',
+        query: query,
+        top_n: topK,
+        documents: documents,
+        return_documents: true,
+      };
+
+      const response = await axios.post<t.JinaRerankerResponse | undefined>(
+        this.apiUrl,
+        requestData,
+        {
+          headers: {
+            'Content-Type': 'application/json',
+            Authorization: `Bearer ${this.apiKey}`,
+          },
+        }
+      );
+
+      this.logger.debug('Jina API Model:', response.data?.model);
+      this.logger.debug('Jina API Usage:', response.data?.usage);
+
+      if (response.data && response.data.results.length) {
+        return response.data.results.map((result) => {
+          const docIndex = result.index;
+          const score = result.relevance_score;
+          let text = '';
+
+          // If return_documents is true, the document field will be present
+          if (result.document != null) {
+            const doc = result.document;
+            if (typeof doc === 'object' && 'text' in doc) {
+              text = doc.text;
+            } else if (typeof doc === 'string') {
+              text = doc;
+            }
+          } else {
+            // Otherwise, use the index to get the document
+            text = documents[docIndex];
+          }
+
+          return { text, score };
+        });
+      } else {
+        this.logger.warn(
+          'Unexpected response format from Jina API. Using default ranking.'
+        );
+        return this.getDefaultRanking(documents, topK);
+      }
+    } catch (error) {
+      this.logger.error('Error using Jina reranker:', error);
+      // Fallback to default ranking on error
+      return this.getDefaultRanking(documents, topK);
+    }
+  }
+}
+
+export class CohereReranker extends BaseReranker {
+  constructor({
+    apiKey = process.env.COHERE_API_KEY,
+    logger,
+  }: {
+    apiKey?: string;
+    logger?: t.Logger;
+  }) {
+    super(logger);
+    this.apiKey = apiKey;
+  }
+
+  async rerank(
+    query: string,
+    documents: string[],
+    topK: number = 5
+  ): Promise<t.Highlight[]> {
+    this.logger.debug(`Reranking ${documents.length} chunks with Cohere`);
+
+    try {
+      if (this.apiKey == null || this.apiKey === '') {
+        this.logger.warn('COHERE_API_KEY is not set. Using default ranking.');
+        return this.getDefaultRanking(documents, topK);
+      }
+
+      const requestData = {
+        model: 'rerank-v3.5',
+        query: query,
+        top_n: topK,
+        documents: documents,
+      };
+
+      const response = await axios.post<t.CohereRerankerResponse | undefined>(
+        'https://api.cohere.com/v2/rerank',
+        requestData,
+        {
+          headers: {
+            'Content-Type': 'application/json',
+            Authorization: `Bearer ${this.apiKey}`,
+          },
+        }
+      );
+
+      this.logger.debug('Cohere API ID:', response.data?.id);
+      this.logger.debug('Cohere API Meta:', response.data?.meta);
+
+      if (response.data && response.data.results.length) {
+        return response.data.results.map((result) => {
+          const docIndex = result.index;
+          const score = result.relevance_score;
+          const text = documents[docIndex];
+          return { text, score };
+        });
+      } else {
+        this.logger.warn(
+          'Unexpected response format from Cohere API. Using default ranking.'
+        );
+        return this.getDefaultRanking(documents, topK);
+      }
+    } catch (error) {
+      this.logger.error('Error using Cohere reranker:', error);
+      // Fallback to default ranking on error
+      return this.getDefaultRanking(documents, topK);
+    }
+  }
+}
+
+export class InfinityReranker extends BaseReranker {
+  constructor(logger?: t.Logger) {
+    super(logger);
+    // No API key needed for the placeholder implementation
+  }
+
+  async rerank(
+    query: string,
+    documents: string[],
+    topK: number = 5
+  ): Promise<t.Highlight[]> {
+    this.logger.debug(
+      `Reranking ${documents.length} chunks with Infinity (placeholder)`
+    );
+    // This would be replaced with actual Infinity reranker implementation
+    return this.getDefaultRanking(documents, topK);
+  }
+}
+
+/**
+ * Creates the appropriate reranker based on type and configuration
+ */
+export const createReranker = (config: {
+  rerankerType: t.RerankerType;
+  jinaApiKey?: string;
+  jinaApiUrl?: string;
+  cohereApiKey?: string;
+  logger?: t.Logger;
+}): BaseReranker | undefined => {
+  const { rerankerType, jinaApiKey, jinaApiUrl, cohereApiKey, logger } = config;
+
+  // Create a default logger if none is provided
+  const defaultLogger = logger || createDefaultLogger();
+
+  switch (rerankerType.toLowerCase()) {
+  case 'jina':
+    return new JinaReranker({ apiKey: jinaApiKey, apiUrl: jinaApiUrl, logger: defaultLogger });
+  case 'cohere':
+    return new CohereReranker({
+      apiKey: cohereApiKey,
+      logger: defaultLogger,
+    });
+  case 'infinity':
+    return new InfinityReranker(defaultLogger);
+  case 'none':
+    defaultLogger.debug('Skipping reranking as reranker is set to "none"');
+    return undefined;
+  default:
+    defaultLogger.warn(
+      `Unknown reranker type: ${rerankerType}. Defaulting to InfinityReranker.`
+    );
+    return new JinaReranker({ apiKey: jinaApiKey, apiUrl: jinaApiUrl, logger: defaultLogger });
+  }
+};
+
+// Example usage:
+// const jinaReranker = new JinaReranker();
+// const cohereReranker = new CohereReranker();
+// const infinityReranker = new InfinityReranker();

package/src/tools/search/schema.ts

@@ -1,63 +1,63 @@
-import { z } from 'zod';
-
-export enum DATE_RANGE {
-  PAST_HOUR = 'h',
-  PAST_24_HOURS = 'd',
-  PAST_WEEK = 'w',
-  PAST_MONTH = 'm',
-  PAST_YEAR = 'y',
-}
-
-export const DEFAULT_QUERY_DESCRIPTION = `
-GUIDELINES:
-- Start broad, then narrow: Begin with key concepts, then refine with specifics
-- Think like sources: Use terminology experts would use in the field
-- Consider perspective: Frame queries from different viewpoints for better results
-- Quality over quantity: A precise 3-4 word query often beats lengthy sentences
-
-TECHNIQUES (combine for power searches):
-- EXACT PHRASES: Use quotes ("climate change report")
-- EXCLUDE TERMS: Use minus to remove unwanted results (-wikipedia)
-- SITE-SPECIFIC: Restrict to websites (site:edu research)
-- FILETYPE: Find specific documents (filetype:pdf study)
-- OR OPERATOR: Find alternatives (electric OR hybrid cars)
-- DATE RANGE: Recent information (data after:2020)
-- WILDCARDS: Use * for unknown terms (how to * bread)
-- SPECIFIC QUESTIONS: Use who/what/when/where/why/how
-- DOMAIN TERMS: Include technical terminology for specialized topics
-- CONCISE TERMS: Prioritize keywords over sentences
-`.trim();
-
-export const DEFAULT_COUNTRY_DESCRIPTION =
-  `Country code to localize search results.
-Use standard 2-letter country codes: "us", "uk", "ca", "de", "fr", "jp", "br", etc.
-Provide this when the search should return results specific to a particular country.
-Examples:
-- "us" for United States (default)
-- "de" for Germany
-- "in" for India
-`.trim();
-
-export const querySchema = z.string().describe(DEFAULT_QUERY_DESCRIPTION);
-export const dateSchema = z
-  .nativeEnum(DATE_RANGE)
-  .optional()
-  .describe('Date range for search results.');
-export const countrySchema = z
-  .string()
-  .optional()
-  .describe(DEFAULT_COUNTRY_DESCRIPTION);
-export const imagesSchema = z
-  .boolean()
-  .optional()
-  .describe('Whether to also run an image search.');
-
-export const videosSchema = z
-  .boolean()
-  .optional()
-  .describe('Whether to also run a video search.');
-
-export const newsSchema = z
-  .boolean()
-  .optional()
-  .describe('Whether to also run a news search.');
+import { z } from 'zod';
+
+export enum DATE_RANGE {
+  PAST_HOUR = 'h',
+  PAST_24_HOURS = 'd',
+  PAST_WEEK = 'w',
+  PAST_MONTH = 'm',
+  PAST_YEAR = 'y',
+}
+
+export const DEFAULT_QUERY_DESCRIPTION = `
+GUIDELINES:
+- Start broad, then narrow: Begin with key concepts, then refine with specifics
+- Think like sources: Use terminology experts would use in the field
+- Consider perspective: Frame queries from different viewpoints for better results
+- Quality over quantity: A precise 3-4 word query often beats lengthy sentences
+
+TECHNIQUES (combine for power searches):
+- EXACT PHRASES: Use quotes ("climate change report")
+- EXCLUDE TERMS: Use minus to remove unwanted results (-wikipedia)
+- SITE-SPECIFIC: Restrict to websites (site:edu research)
+- FILETYPE: Find specific documents (filetype:pdf study)
+- OR OPERATOR: Find alternatives (electric OR hybrid cars)
+- DATE RANGE: Recent information (data after:2020)
+- WILDCARDS: Use * for unknown terms (how to * bread)
+- SPECIFIC QUESTIONS: Use who/what/when/where/why/how
+- DOMAIN TERMS: Include technical terminology for specialized topics
+- CONCISE TERMS: Prioritize keywords over sentences
+`.trim();
+
+export const DEFAULT_COUNTRY_DESCRIPTION =
+  `Country code to localize search results.
+Use standard 2-letter country codes: "us", "uk", "ca", "de", "fr", "jp", "br", etc.
+Provide this when the search should return results specific to a particular country.
+Examples:
+- "us" for United States (default)
+- "de" for Germany
+- "in" for India
+`.trim();
+
+export const querySchema = z.string().describe(DEFAULT_QUERY_DESCRIPTION);
+export const dateSchema = z
+  .nativeEnum(DATE_RANGE)
+  .optional()
+  .describe('Date range for search results.');
+export const countrySchema = z
+  .string()
+  .optional()
+  .describe(DEFAULT_COUNTRY_DESCRIPTION);
+export const imagesSchema = z
+  .boolean()
+  .optional()
+  .describe('Whether to also run an image search.');
+
+export const videosSchema = z
+  .boolean()
+  .optional()
+  .describe('Whether to also run a video search.');
+
+export const newsSchema = z
+  .boolean()
+  .optional()
+  .describe('Whether to also run a news search.');