chat-agent-toolkit 1.2.379 → 1.2.381

package/src/tools/search/meta-search-types.ts

@@ -1,64 +1,78 @@
-/**
- * @module research/search/meta-search-types
- * @description Shared types for the MetaSearchAgent.
- */
-import type { LanguageModel } from "ai";
-import type EventEmitter from "events";
-
-/** A single conversation turn, matching the Vercel AI SDK message shape. */
-export interface ChatTurnMessage {
-  role: "user" | "assistant" | "system";
-  content: string;
-}
-
-/** A `[role, content]` tuple used for few-shot prompt examples. */
-export type FewShotExample = [role: "user" | "assistant", content: string];
-
-export interface MetaSearchAgentType {
-  searchAndAnswer: (
-    message: string,
-    history: ChatTurnMessage[],
-    llm: LanguageModel,
-    optimizationMode: "speed" | "balanced" | "quality",
-    fileIds: string[],
-    systemInstructions: string,
-    category?: string,
-    sourceExtractionEnabled?: boolean,
-    thinkingTimeLimit?: number,
-    /** User-authored replacement for the focus mode's query-expansion prompt. */
-    queryExpansionPrompt?: string,
-  ) => Promise<EventEmitter>;
-}
-
-/** Emitted on the EventEmitter data channel to report live search progress. */
-export interface SearchingEvent {
-  query: string;
-  /** Display label shown in the UI (e.g. "Academic · max 10"). */
-  category?: string;
-  status: "running" | "done";
-}
-
-export interface Config {
-  searchWeb: boolean;
-  rerank: boolean;
-  rerankThreshold: number;
-  queryGeneratorPrompt: string;
-  queryGeneratorFewShots: FewShotExample[];
-  responsePrompt: string;
-  activeEngines: string[];
-  /** Optional: Function to fetch documents from URLs */
-  getDocumentsFromLinks?: (options: { links: string[] }) => Promise<any[]>;
-  /** Optional: Function to search via SearXNG */
-  searchSearxng?: (query: string, options: any) => Promise<{ results: any[]; suggestions: string[] }>;
-  /** Optional: Function to search via Tavily */
-  searchTavily?: (query: string, options: any) => Promise<{ results: any[]; suggestions: string[] }>;
-  /** Optional: Function to check if Tavily is configured */
-  isTavilyConfigured?: () => boolean;
-  /** Optional: Function to scrape a URL */
-  scrapeURL?: (url: string, options: any) => Promise<string>;
-}
-
-export type BasicChainInput = {
-  chat_history: ChatTurnMessage[];
-  query: string;
-};
+/**
+ * @module research/search/meta-search-types
+ * @description Shared types for the MetaSearchAgent.
+ */
+import type { LanguageModel } from "ai";
+import type EventEmitter from "events";
+
+/** A single conversation turn, matching the Vercel AI SDK message shape. */
+export interface ChatTurnMessage {
+  role: "user" | "assistant" | "system";
+  content: string;
+}
+
+/** A `[role, content]` tuple used for few-shot prompt examples. */
+export type FewShotExample = [role: "user" | "assistant", content: string];
+
+/**
+ * The pipeline's event emitter, plus the hook a consumer uses to push back.
+ *
+ * `emit()` is synchronous, so the answer loop would otherwise pull the entire
+ * model stream into memory at the model's pace while the consumer writes it
+ * out at the client's pace. A consumer that can be slow (an HTTP response
+ * stream, say) assigns `waitForDrain`; the loop awaits it between chunks and
+ * so advances no faster than the consumer does. Leaving it unset keeps the
+ * unthrottled behaviour, which is what an in-process consumer wants.
+ */
+export interface DrainableEmitter extends EventEmitter {
+  waitForDrain?: () => Promise<void>;
+}
+
+export interface MetaSearchAgentType {
+  searchAndAnswer: (
+    message: string,
+    history: ChatTurnMessage[],
+    llm: LanguageModel,
+    optimizationMode: "speed" | "balanced" | "quality",
+    fileIds: string[],
+    systemInstructions: string,
+    category?: string,
+    sourceExtractionEnabled?: boolean,
+    thinkingTimeLimit?: number,
+    /** User-authored replacement for the focus mode's query-expansion prompt. */
+    queryExpansionPrompt?: string,
+  ) => Promise<DrainableEmitter>;
+}
+
+/** Emitted on the EventEmitter data channel to report live search progress. */
+export interface SearchingEvent {
+  query: string;
+  /** Display label shown in the UI (e.g. "Academic · max 10"). */
+  category?: string;
+  status: "running" | "done";
+}
+
+export interface Config {
+  searchWeb: boolean;
+  rerank: boolean;
+  rerankThreshold: number;
+  queryGeneratorPrompt: string;
+  queryGeneratorFewShots: FewShotExample[];
+  responsePrompt: string;
+  activeEngines: string[];
+  /** Optional: Function to fetch documents from URLs */
+  getDocumentsFromLinks?: (options: { links: string[] }) => Promise<any[]>;
+  /** Optional: Function to search via SearXNG */
+  searchSearxng?: (query: string, options: any) => Promise<{ results: any[]; suggestions: string[] }>;
+  /** Optional: Function to search via Tavily */
+  searchTavily?: (query: string, options: any) => Promise<{ results: any[]; suggestions: string[] }>;
+  /** Optional: Function to check if Tavily is configured */
+  isTavilyConfigured?: () => boolean;
+  /** Optional: Function to scrape a URL */
+  scrapeURL?: (url: string, options: any) => Promise<string>;
+}
+
+export type BasicChainInput = {
+  chat_history: ChatTurnMessage[];
+  query: string;
+};

package/src/tools/search/metaSearchAgent.d.ts

@@ -4,9 +4,8 @@
  * LLMs through the Vercel AI SDK (generateText/streamText).
  */
 import { type LanguageModel } from "ai";
-import EventEmitter from "events";
-import type { Config, ChatTurnMessage, MetaSearchAgentType } from "./meta-search-types";
-export type { MetaSearchAgentType, Config } from "./meta-search-types";
+import type { Config, ChatTurnMessage, DrainableEmitter, MetaSearchAgentType } from "./meta-search-types";
+export type { MetaSearchAgentType, Config, DrainableEmitter } from "./meta-search-types";
 declare class MetaSearchAgent implements MetaSearchAgentType {
     private config;
     constructor(config: Config);
@@ -21,6 +20,6 @@ declare class MetaSearchAgent implements MetaSearchAgentType {
      * "response", "searching", "end", and "error" events on the emitter.
      */
     private runPipeline;
-    searchAndAnswer(message: string, history: ChatTurnMessage[], llm: LanguageModel, optimizationMode: "speed" | "balanced" | "quality", fileIds: string[], systemInstructions: string, category?: string, sourceExtractionEnabled?: boolean, thinkingTimeLimit?: number, queryExpansionPrompt?: string): Promise<EventEmitter<any>>;
+    searchAndAnswer(message: string, history: ChatTurnMessage[], llm: LanguageModel, optimizationMode: "speed" | "balanced" | "quality", fileIds: string[], systemInstructions: string, category?: string, sourceExtractionEnabled?: boolean, thinkingTimeLimit?: number, queryExpansionPrompt?: string): Promise<DrainableEmitter>;
 }
 export default MetaSearchAgent;