@librechat/agents 2.4.321 → 2.4.322

package/dist/types/tools/search/schema.d.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+export declare enum DATE_RANGE {
+    PAST_HOUR = "h",
+    PAST_24_HOURS = "d",
+    PAST_WEEK = "w",
+    PAST_MONTH = "m",
+    PAST_YEAR = "y"
+}
+export declare const DEFAULT_QUERY_DESCRIPTION: string;
+export declare const DEFAULT_COUNTRY_DESCRIPTION: string;
+export declare const querySchema: z.ZodString;
+export declare const dateSchema: z.ZodOptional<z.ZodNativeEnum<typeof DATE_RANGE>>;
+export declare const countrySchema: z.ZodOptional<z.ZodString>;
+export declare const imagesSchema: z.ZodOptional<z.ZodBoolean>;
+export declare const videosSchema: z.ZodOptional<z.ZodBoolean>;
+export declare const newsSchema: z.ZodOptional<z.ZodBoolean>;

package/dist/types/tools/search/tool.d.ts

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 import { DynamicStructuredTool } from '@langchain/core/tools';
 import type * as t from './types';
+import { DATE_RANGE } from './schema';
 /**
  * Creates a search tool with a schema that dynamically includes the country field
  * only when the searchProvider is 'serper'.
@@ -10,11 +11,23 @@ import type * as t from './types';
  */
 export declare const createSearchTool: (config?: t.SearchToolConfig) => DynamicStructuredTool<z.ZodObject<{
     query: z.ZodString;
+    date: z.ZodOptional<z.ZodNativeEnum<typeof DATE_RANGE>>;
     country?: z.ZodOptional<z.ZodString>;
+    images: z.ZodOptional<z.ZodBoolean>;
+    videos: z.ZodOptional<z.ZodBoolean>;
+    news: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     query: string;
+    date?: DATE_RANGE | undefined;
+    images?: boolean | undefined;
+    videos?: boolean | undefined;
+    news?: boolean | undefined;
     country?: unknown;
 }, {
     query: string;
+    date?: DATE_RANGE | undefined;
+    images?: boolean | undefined;
+    videos?: boolean | undefined;
+    news?: boolean | undefined;
     country?: unknown;
 }>>;

package/dist/types/tools/search/types.d.ts

@@ -1,6 +1,8 @@
 import { z } from 'zod';
+import type { Logger as WinstonLogger } from 'winston';
 import type { RunnableConfig } from '@langchain/core/runnables';
 import type { BaseReranker } from './rerankers';
+import { DATE_RANGE } from './schema';
 export type SearchProvider = 'serper' | 'searxng';
 export type RerankerType = 'infinity' | 'jina' | 'cohere' | 'none';
 export interface Highlight {
@@ -78,6 +80,7 @@ export interface ProcessSourcesConfig {
     strategies?: string[];
     filterContent?: boolean;
     reranker?: BaseReranker;
+    logger?: Logger;
 }
 export interface FirecrawlConfig {
     firecrawlApiKey?: string;
@@ -121,7 +124,11 @@ export interface CohereRerankerResponse {
         };
     };
 }
+export type SafeSearchLevel = 0 | 1 | 2;
+export type Logger = WinstonLogger;
 export interface SearchToolConfig extends SearchConfig, ProcessSourcesConfig, FirecrawlConfig {
+    logger?: Logger;
+    safeSearch?: SafeSearchLevel;
     jinaApiKey?: string;
     cohereApiKey?: string;
     rerankerType?: RerankerType;
@@ -217,11 +224,18 @@ export interface FirecrawlScraperConfig {
     apiUrl?: string;
     formats?: string[];
     timeout?: number;
+    logger?: Logger;
 }
 export type GetSourcesParams = {
     query: string;
+    date?: DATE_RANGE;
     country?: string;
     numResults?: number;
+    safeSearch?: SearchToolConfig['safeSearch'];
+    images?: boolean;
+    videos?: boolean;
+    news?: boolean;
+    type?: 'search' | 'images' | 'videos' | 'news';
 };
 /** Serper API */
 export interface VideoResult {
@@ -382,6 +396,13 @@ export interface SerperSearchInput {
      */
     autocorrect?: boolean;
     page?: number;
+    /**
+     * Date range for search results
+     * Options: "h" (past hour), "d" (past 24 hours), "w" (past week),
+     * "m" (past month), "y" (past year)
+     * `qdr:${DATE_RANGE}`
+     */
+    tbs?: string;
 }
 export type SerperResultData = {
     searchParameters: SerperSearchPayload;
@@ -491,16 +512,29 @@ export type ProcessSourcesFields = {
     result: SearchResult;
     numElements: number;
     query: string;
+    news: boolean;
     proMode: boolean;
     onGetHighlights: SearchToolConfig['onGetHighlights'];
 };
 export type SearchToolSchema = z.ZodObject<{
     query: z.ZodString;
+    date: z.ZodOptional<z.ZodNativeEnum<typeof DATE_RANGE>>;
     country?: z.ZodOptional<z.ZodString>;
+    images: z.ZodOptional<z.ZodBoolean>;
+    videos: z.ZodOptional<z.ZodBoolean>;
+    news: z.ZodOptional<z.ZodBoolean>;
 }, 'strip', z.ZodTypeAny, {
     query: string;
+    date?: DATE_RANGE;
     country?: unknown;
+    images?: boolean;
+    videos?: boolean;
+    news?: boolean;
 }, {
     query: string;
+    date?: DATE_RANGE;
     country?: unknown;
+    images?: boolean;
+    videos?: boolean;
+    news?: boolean;
 }>;

package/dist/types/tools/search/utils.d.ts

@@ -1,3 +1,10 @@
 import type * as t from './types';
-export declare const getDomainName: (link: string, metadata?: t.ScrapeMetadata) => string | undefined;
-export declare function getAttribution(link: string, metadata?: t.ScrapeMetadata): string | undefined;
+/**
+ * Creates a default logger that maps to console methods
+ * Uses a singleton pattern to avoid creating multiple instances
+ * @returns A default logger that implements the Logger interface
+ */
+export declare const createDefaultLogger: () => t.Logger;
+export declare const fileExtRegex: RegExp;
+export declare const getDomainName: (link: string, metadata?: t.ScrapeMetadata, logger?: t.Logger) => string | undefined;
+export declare function getAttribution(link: string, metadata?: t.ScrapeMetadata, logger?: t.Logger): string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@librechat/agents",
-  "version": "2.4.321",
+  "version": "2.4.322",
   "main": "./dist/cjs/main.cjs",
   "module": "./dist/esm/main.mjs",
   "types": "./dist/types/index.d.ts",
@@ -122,7 +122,8 @@
     "tsc-alias": "^1.8.10",
     "tsconfig-paths": "^4.2.0",
     "tslib": "^2.6.3",
-    "typescript": "^5.5.3"
+    "typescript": "^5.5.3",
+    "winston": "^3.17.0"
   },
   "lint-staged": {
     "*.{js,ts}": [

package/src/scripts/search.ts

@@ -111,10 +111,10 @@ async function testStandardStreaming(): Promise<void> {
   // `;
   // const userMessage = 'Are massage guns good?';
   // const userMessage = 'What is functional programming?';
-  // const userMessage = "Get me today's trending news.";
+  const userMessage = "Get me today's trending news.";
   // const userMessage = "search recent italy earthquake volcano activity";
-  const userMessage =
-    "use 'Trump' as the exact search query and tell me what you find.";
+  // const userMessage =
+  //   "use 'Trump' as the exact search query and tell me what you find.";
 
   conversationHistory.push(new HumanMessage(userMessage));
 

package/src/tools/search/firecrawl.ts

@@ -1,7 +1,7 @@
-/* eslint-disable no-console */
 import axios from 'axios';
 import { processContent } from './content';
 import type * as t from './types';
+import { createDefaultLogger } from './utils';
 
 /**
  * Firecrawl scraper implementation
@@ -12,6 +12,7 @@ export class FirecrawlScraper {
   private apiUrl: string;
   private defaultFormats: string[];
   private timeout: number;
+  private logger: t.Logger;
 
   constructor(config: t.FirecrawlScraperConfig = {}) {
     this.apiKey = config.apiKey ?? process.env.FIRECRAWL_API_KEY ?? '';
@@ -25,11 +26,15 @@ export class FirecrawlScraper {
     this.defaultFormats = config.formats ?? ['markdown', 'html'];
     this.timeout = config.timeout ?? 15000;
 
+    this.logger = config.logger || createDefaultLogger();
+
     if (!this.apiKey) {
-      console.warn('FIRECRAWL_API_KEY is not set. Scraping will not work.');
+      this.logger.warn('FIRECRAWL_API_KEY is not set. Scraping will not work.');
     }
 
-    console.log(`Firecrawl scraper initialized with API URL: ${this.apiUrl}`);
+    this.logger.debug(
+      `Firecrawl scraper initialized with API URL: ${this.apiUrl}`
+    );
   }
 
   /**
@@ -107,7 +112,7 @@ export class FirecrawlScraper {
         );
         return [markdown, rest];
       } catch (error) {
-        console.error('Error processing content:', error);
+        this.logger.error('Error processing content:', error);
         return [response.data.markdown, undefined];
       }
     } else if (response.data.markdown != null) {

package/src/tools/search/format.ts

@@ -1,5 +1,5 @@
 import type * as t from './types';
-import { getDomainName } from './utils';
+import { getDomainName, fileExtRegex } from './utils';
 
 function addHighlightSection(): string[] {
   return ['\n## Highlights', ''];
@@ -62,6 +62,9 @@ function formatSource(
 
         for (let j = 0; j < h.references.length; j++) {
           const ref = h.references[j];
+          if (ref.reference.originalUrl.includes('mailto:')) {
+            continue;
+          }
           references.push({
             type: ref.type,
             link: ref.reference.originalUrl,
@@ -76,6 +79,10 @@ function formatSource(
             continue;
           }
 
+          if (fileExtRegex.test(ref.reference.originalUrl)) {
+            continue;
+          }
+
           if (!hasHeader) {
             refLines.push('Core References:');
             hasHeader = true;

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(
@@ -25,16 +27,22 @@ export abstract class BaseReranker {
   }
 
   protected logDocumentSamples(documents: string[]): void {
-    console.log('Sample documents being sent to API:');
+    this.logger.debug('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)}...`);
+      this.logger.debug(`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,11 +51,11 @@ 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} documents 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);
       }
 
@@ -73,14 +81,14 @@ 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);
+      this.logger.debug('Jina API response structure:');
+      this.logger.debug('Model:', response.data?.model);
+      this.logger.debug('Usage:', response.data?.usage);
+      this.logger.debug('Results count:', response.data?.results.length);
 
       // Log a sample of the results
       if ((response.data?.results.length ?? 0) > 0) {
-        console.log(
+        this.logger.debug(
           'Sample result:',
           JSON.stringify(response.data?.results[0], null, 2)
         );
@@ -108,13 +116,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 +130,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,11 +146,11 @@ 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} documents 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);
       }
 
@@ -161,14 +175,14 @@ 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);
+      this.logger.debug('Cohere API response structure:');
+      this.logger.debug('ID:', response.data?.id);
+      this.logger.debug('Meta:', response.data?.meta);
+      this.logger.debug('Results count:', response.data?.results.length);
 
       // Log a sample of the results
       if ((response.data?.results.length ?? 0) > 0) {
-        console.log(
+        this.logger.debug(
           'Sample result:',
           JSON.stringify(response.data?.results[0], null, 2)
         );
@@ -182,13 +196,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 +210,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,7 +220,7 @@ export class InfinityReranker extends BaseReranker {
     documents: string[],
     topK: number = 5
   ): Promise<t.Highlight[]> {
-    console.log(
+    this.logger.debug(
       `Reranking ${documents.length} documents with Infinity (placeholder)`
     );
     // This would be replaced with actual Infinity reranker implementation
@@ -221,24 +235,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.');