@librechat/agents 2.4.321 → 3.0.0-rc1

package/src/tools/search/rerankers.ts

@@ -1,12 +1,14 @@
-/* eslint-disable no-console */
 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() {
+  constructor(logger?: t.Logger) {
     // Each specific reranker will set its API key
+    this.logger = logger || createDefaultLogger();
   }
 
   abstract rerank(
@@ -23,18 +25,17 @@ export abstract class BaseReranker {
       .slice(0, Math.min(topK, documents.length))
       .map((doc) => ({ text: doc, score: 0 }));
   }
-
-  protected logDocumentSamples(documents: string[]): void {
-    console.log('Sample documents being sent to API:');
-    for (let i = 0; i < Math.min(3, documents.length); i++) {
-      console.log(`Document ${i}: ${documents[i].substring(0, 100)}...`);
-    }
-  }
 }
 
 export class JinaReranker extends BaseReranker {
-  constructor({ apiKey = process.env.JINA_API_KEY }: { apiKey?: string }) {
-    super();
+  constructor({
+    apiKey = process.env.JINA_API_KEY,
+    logger,
+  }: {
+    apiKey?: string;
+    logger?: t.Logger;
+  }) {
+    super(logger);
     this.apiKey = apiKey;
   }
 
@@ -43,16 +44,14 @@ export class JinaReranker extends BaseReranker {
     documents: string[],
     topK: number = 5
   ): Promise<t.Highlight[]> {
-    console.log(`Reranking ${documents.length} documents with Jina`);
+    this.logger.debug(`Reranking ${documents.length} chunks with Jina`);
 
     try {
       if (this.apiKey == null || this.apiKey === '') {
-        console.warn('JINA_API_KEY is not set. Using default ranking.');
+        this.logger.warn('JINA_API_KEY is not set. Using default ranking.');
         return this.getDefaultRanking(documents, topK);
       }
 
-      this.logDocumentSamples(documents);
-
       const requestData = {
         model: 'jina-reranker-v2-base-multilingual',
         query: query,
@@ -72,19 +71,8 @@ export class JinaReranker extends BaseReranker {
         }
       );
 
-      // Log the response data structure
-      console.log('Jina API response structure:');
-      console.log('Model:', response.data?.model);
-      console.log('Usage:', response.data?.usage);
-      console.log('Results count:', response.data?.results.length);
-
-      // Log a sample of the results
-      if ((response.data?.results.length ?? 0) > 0) {
-        console.log(
-          'Sample result:',
-          JSON.stringify(response.data?.results[0], null, 2)
-        );
-      }
+      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) => {
@@ -108,13 +96,13 @@ export class JinaReranker extends BaseReranker {
           return { text, score };
         });
       } else {
-        console.warn(
+        this.logger.warn(
           'Unexpected response format from Jina API. Using default ranking.'
         );
         return this.getDefaultRanking(documents, topK);
       }
     } catch (error) {
-      console.error('Error using Jina reranker:', error);
+      this.logger.error('Error using Jina reranker:', error);
       // Fallback to default ranking on error
       return this.getDefaultRanking(documents, topK);
     }
@@ -122,8 +110,14 @@ export class JinaReranker extends BaseReranker {
 }
 
 export class CohereReranker extends BaseReranker {
-  constructor({ apiKey = process.env.COHERE_API_KEY }: { apiKey?: string }) {
-    super();
+  constructor({
+    apiKey = process.env.COHERE_API_KEY,
+    logger,
+  }: {
+    apiKey?: string;
+    logger?: t.Logger;
+  }) {
+    super(logger);
     this.apiKey = apiKey;
   }
 
@@ -132,16 +126,14 @@ export class CohereReranker extends BaseReranker {
     documents: string[],
     topK: number = 5
   ): Promise<t.Highlight[]> {
-    console.log(`Reranking ${documents.length} documents with Cohere`);
+    this.logger.debug(`Reranking ${documents.length} chunks with Cohere`);
 
     try {
       if (this.apiKey == null || this.apiKey === '') {
-        console.warn('COHERE_API_KEY is not set. Using default ranking.');
+        this.logger.warn('COHERE_API_KEY is not set. Using default ranking.');
         return this.getDefaultRanking(documents, topK);
       }
 
-      this.logDocumentSamples(documents);
-
       const requestData = {
         model: 'rerank-v3.5',
         query: query,
@@ -160,19 +152,8 @@ export class CohereReranker extends BaseReranker {
         }
       );
 
-      // Log the response data structure
-      console.log('Cohere API response structure:');
-      console.log('ID:', response.data?.id);
-      console.log('Meta:', response.data?.meta);
-      console.log('Results count:', response.data?.results.length);
-
-      // Log a sample of the results
-      if ((response.data?.results.length ?? 0) > 0) {
-        console.log(
-          'Sample result:',
-          JSON.stringify(response.data?.results[0], null, 2)
-        );
-      }
+      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) => {
@@ -182,13 +163,13 @@ export class CohereReranker extends BaseReranker {
           return { text, score };
         });
       } else {
-        console.warn(
+        this.logger.warn(
           'Unexpected response format from Cohere API. Using default ranking.'
         );
         return this.getDefaultRanking(documents, topK);
       }
     } catch (error) {
-      console.error('Error using Cohere reranker:', error);
+      this.logger.error('Error using Cohere reranker:', error);
       // Fallback to default ranking on error
       return this.getDefaultRanking(documents, topK);
     }
@@ -196,8 +177,8 @@ export class CohereReranker extends BaseReranker {
 }
 
 export class InfinityReranker extends BaseReranker {
-  constructor() {
-    super();
+  constructor(logger?: t.Logger) {
+    super(logger);
     // No API key needed for the placeholder implementation
   }
 
@@ -206,8 +187,8 @@ export class InfinityReranker extends BaseReranker {
     documents: string[],
     topK: number = 5
   ): Promise<t.Highlight[]> {
-    console.log(
-      `Reranking ${documents.length} documents with Infinity (placeholder)`
+    this.logger.debug(
+      `Reranking ${documents.length} chunks with Infinity (placeholder)`
     );
     // This would be replaced with actual Infinity reranker implementation
     return this.getDefaultRanking(documents, topK);
@@ -221,24 +202,31 @@ export const createReranker = (config: {
   rerankerType: t.RerankerType;
   jinaApiKey?: string;
   cohereApiKey?: string;
+  logger?: t.Logger;
 }): BaseReranker | undefined => {
-  const { rerankerType, jinaApiKey, cohereApiKey } = config;
+  const { rerankerType, jinaApiKey, 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 });
+    return new JinaReranker({ apiKey: jinaApiKey, logger: defaultLogger });
   case 'cohere':
-    return new CohereReranker({ apiKey: cohereApiKey });
+    return new CohereReranker({
+      apiKey: cohereApiKey,
+      logger: defaultLogger,
+    });
   case 'infinity':
-    return new InfinityReranker();
+    return new InfinityReranker(defaultLogger);
   case 'none':
-    console.log('Skipping reranking as reranker is set to "none"');
+    defaultLogger.debug('Skipping reranking as reranker is set to "none"');
     return undefined;
   default:
-    console.warn(
+    defaultLogger.warn(
       `Unknown reranker type: ${rerankerType}. Defaulting to InfinityReranker.`
     );
-    return new JinaReranker({ apiKey: jinaApiKey });
+    return new JinaReranker({ apiKey: jinaApiKey, logger: defaultLogger });
   }
 };
 

package/src/tools/search/schema.ts

@@ -0,0 +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.');