chat-agent-toolkit 1.2.33 → 1.2.35

package/src/tools/search/search-handlers.ts

@@ -1,97 +1,97 @@
-/**
- * @module research/search/index
- * @description Research library module.
- *
- * Note: To use these search handlers, you need to provide search functions
- * (searchSearxng, searchTavily, etc.) from extract-webpage package.
- * See extract-webpage/src/search/index.ts for an example.
- */
-import MetaSearchAgent from "./metaSearchAgent";
-import {
-  webSearchRetrieverPrompt,
-  webSearchResponsePrompt,
-  webSearchRetrieverFewShots,
-  writingAssistantPrompt,
-} from "../../prompts";
-import type { Config } from "./meta-search-types";
-
-const prompts = {
-  webSearchRetrieverPrompt,
-  webSearchResponsePrompt,
-  webSearchRetrieverFewShots,
-  writingAssistantPrompt,
-};
-
-/**
- * Creates search handler instances with provided search functions.
- * Pass in search functions from extract-webpage to enable web search.
- */
-export const createSearchHandlers = (searchFunctions?: Partial<Config>) => ({
-  webSearch: new MetaSearchAgent({
-    activeEngines: [],
-    queryGeneratorPrompt: prompts.webSearchRetrieverPrompt,
-    responsePrompt: prompts.webSearchResponsePrompt,
-    queryGeneratorFewShots: prompts.webSearchRetrieverFewShots,
-    rerank: true,
-    rerankThreshold: 0.3,
-    searchWeb: true,
-    ...searchFunctions,
-  }),
-  academicSearch: new MetaSearchAgent({
-    activeEngines: ["arxiv", "google scholar", "pubmed"],
-    queryGeneratorPrompt: prompts.webSearchRetrieverPrompt,
-    responsePrompt: prompts.webSearchResponsePrompt,
-    queryGeneratorFewShots: prompts.webSearchRetrieverFewShots,
-    rerank: true,
-    rerankThreshold: 0,
-    searchWeb: true,
-    ...searchFunctions,
-  }),
-  writingAssistant: new MetaSearchAgent({
-    activeEngines: [],
-    queryGeneratorPrompt: "",
-    queryGeneratorFewShots: [],
-    responsePrompt: prompts.writingAssistantPrompt,
-    rerank: true,
-    rerankThreshold: 0,
-    searchWeb: true,
-    ...searchFunctions,
-  }),
-  wolframAlphaSearch: new MetaSearchAgent({
-    activeEngines: ["wolframalpha"],
-    queryGeneratorPrompt: prompts.webSearchRetrieverPrompt,
-    responsePrompt: prompts.webSearchResponsePrompt,
-    queryGeneratorFewShots: prompts.webSearchRetrieverFewShots,
-    rerank: false,
-    rerankThreshold: 0,
-    searchWeb: true,
-    ...searchFunctions,
-  }),
-  youtubeSearch: new MetaSearchAgent({
-    activeEngines: ["youtube"],
-    queryGeneratorPrompt: prompts.webSearchRetrieverPrompt,
-    responsePrompt: prompts.webSearchResponsePrompt,
-    queryGeneratorFewShots: prompts.webSearchRetrieverFewShots,
-    rerank: true,
-    rerankThreshold: 0.3,
-    searchWeb: true,
-    ...searchFunctions,
-  }),
-  redditSearch: new MetaSearchAgent({
-    activeEngines: ["reddit"],
-    queryGeneratorPrompt: prompts.webSearchRetrieverPrompt,
-    responsePrompt: prompts.webSearchResponsePrompt,
-    queryGeneratorFewShots: prompts.webSearchRetrieverFewShots,
-    rerank: true,
-    rerankThreshold: 0.3,
-    searchWeb: true,
-    ...searchFunctions,
-  }),
-});
-
-/**
- * Default search handlers without search functions.
- * These will not perform actual web searches unless search functions are added to the Config.
- * @deprecated Use createSearchHandlers() with search functions instead
- */
-export const searchHandlers = createSearchHandlers();
+/**
+ * @module research/search/index
+ * @description Research library module.
+ *
+ * Note: To use these search handlers, you need to provide search functions
+ * (searchSearxng, searchTavily, etc.) from extract-webpage package.
+ * See extract-webpage/src/search/index.ts for an example.
+ */
+import MetaSearchAgent from "./metaSearchAgent";
+import {
+  webSearchRetrieverPrompt,
+  webSearchResponsePrompt,
+  webSearchRetrieverFewShots,
+  writingAssistantPrompt,
+} from "../../prompts";
+import type { Config } from "./meta-search-types";
+
+const prompts = {
+  webSearchRetrieverPrompt,
+  webSearchResponsePrompt,
+  webSearchRetrieverFewShots,
+  writingAssistantPrompt,
+};
+
+/**
+ * Creates search handler instances with provided search functions.
+ * Pass in search functions from extract-webpage to enable web search.
+ */
+export const createSearchHandlers = (searchFunctions?: Partial<Config>) => ({
+  webSearch: new MetaSearchAgent({
+    activeEngines: [],
+    queryGeneratorPrompt: prompts.webSearchRetrieverPrompt,
+    responsePrompt: prompts.webSearchResponsePrompt,
+    queryGeneratorFewShots: prompts.webSearchRetrieverFewShots,
+    rerank: true,
+    rerankThreshold: 0.3,
+    searchWeb: true,
+    ...searchFunctions,
+  }),
+  academicSearch: new MetaSearchAgent({
+    activeEngines: ["arxiv", "google scholar", "pubmed"],
+    queryGeneratorPrompt: prompts.webSearchRetrieverPrompt,
+    responsePrompt: prompts.webSearchResponsePrompt,
+    queryGeneratorFewShots: prompts.webSearchRetrieverFewShots,
+    rerank: true,
+    rerankThreshold: 0,
+    searchWeb: true,
+    ...searchFunctions,
+  }),
+  writingAssistant: new MetaSearchAgent({
+    activeEngines: [],
+    queryGeneratorPrompt: "",
+    queryGeneratorFewShots: [],
+    responsePrompt: prompts.writingAssistantPrompt,
+    rerank: true,
+    rerankThreshold: 0,
+    searchWeb: true,
+    ...searchFunctions,
+  }),
+  wolframAlphaSearch: new MetaSearchAgent({
+    activeEngines: ["wolframalpha"],
+    queryGeneratorPrompt: prompts.webSearchRetrieverPrompt,
+    responsePrompt: prompts.webSearchResponsePrompt,
+    queryGeneratorFewShots: prompts.webSearchRetrieverFewShots,
+    rerank: false,
+    rerankThreshold: 0,
+    searchWeb: true,
+    ...searchFunctions,
+  }),
+  youtubeSearch: new MetaSearchAgent({
+    activeEngines: ["youtube"],
+    queryGeneratorPrompt: prompts.webSearchRetrieverPrompt,
+    responsePrompt: prompts.webSearchResponsePrompt,
+    queryGeneratorFewShots: prompts.webSearchRetrieverFewShots,
+    rerank: true,
+    rerankThreshold: 0.3,
+    searchWeb: true,
+    ...searchFunctions,
+  }),
+  redditSearch: new MetaSearchAgent({
+    activeEngines: ["reddit"],
+    queryGeneratorPrompt: prompts.webSearchRetrieverPrompt,
+    responsePrompt: prompts.webSearchResponsePrompt,
+    queryGeneratorFewShots: prompts.webSearchRetrieverFewShots,
+    rerank: true,
+    rerankThreshold: 0.3,
+    searchWeb: true,
+    ...searchFunctions,
+  }),
+});
+
+/**
+ * Default search handlers without search functions.
+ * These will not perform actual web searches unless search functions are added to the Config.
+ * @deprecated Use createSearchHandlers() with search functions instead
+ */
+export const searchHandlers = createSearchHandlers();

package/src/tools/search/suggestionGeneratorAgent.ts

@@ -1,56 +1,56 @@
-/**
- * @module research/chains/suggestionGeneratorAgent
- * @description Generates follow-up question suggestions from a conversation
- * using the Vercel AI SDK.
- */
-import { generateText, type LanguageModel } from "ai";
-import { LineListOutputParser } from "../../utils/outputParser";
-import { formatChatHistoryAsString } from "../../utils";
-import type { ChatTurnMessage } from "./meta-search-types";
-
-const createSuggestionGeneratorPrompt = (maxQuestions: number = 4) => `
-You are an AI suggestion generator for an AI powered search engine. You will be given a conversation below. You need to generate ${maxQuestions} suggestions based on the conversation. The suggestion should be relevant to the conversation that can be used by the user to ask the chat model for more information.
-You need to make sure the suggestions are relevant to the conversation and are helpful to the user. Keep a note that the user might use these suggestions to ask a chat model for more information.
-Make sure the suggestions are medium in length and are informative and relevant to the conversation.
-
-Provide these suggestions separated by newlines between the XML tags <suggestions> and </suggestions>. For example:
-
-<suggestions>
-Tell me more about SpaceX and their recent projects
-What is the latest news on SpaceX?
-Who is the CEO of SpaceX?
-</suggestions>
-
-Conversation:
-{chat_history}
-`;
-
-type SuggestionGeneratorInput = {
-  chat_history: ChatTurnMessage[];
-  maxQuestions?: number;
-};
-
-const outputParser = new LineListOutputParser({
-  key: "suggestions",
-});
-
-const generateSuggestions = async (
-  input: SuggestionGeneratorInput,
-  llm: LanguageModel,
-): Promise<string[]> => {
-  const maxQuestions = input.maxQuestions ?? 4;
-  const prompt = createSuggestionGeneratorPrompt(maxQuestions).replace(
-    "{chat_history}",
-    formatChatHistoryAsString(input.chat_history),
-  );
-
-  const { text } = await generateText({
-    model: llm,
-    temperature: 0,
-    prompt,
-  });
-
-  return outputParser.parse(text);
-};
-
-export default generateSuggestions;
+/**
+ * @module research/chains/suggestionGeneratorAgent
+ * @description Generates follow-up question suggestions from a conversation
+ * using the Vercel AI SDK.
+ */
+import { generateText, type LanguageModel } from "ai";
+import { LineListOutputParser } from "../../utils/outputParser";
+import { formatChatHistoryAsString } from "../../utils";
+import type { ChatTurnMessage } from "./meta-search-types";
+
+const createSuggestionGeneratorPrompt = (maxQuestions: number = 4) => `
+You are an AI suggestion generator for an AI powered search engine. You will be given a conversation below. You need to generate ${maxQuestions} suggestions based on the conversation. The suggestion should be relevant to the conversation that can be used by the user to ask the chat model for more information.
+You need to make sure the suggestions are relevant to the conversation and are helpful to the user. Keep a note that the user might use these suggestions to ask a chat model for more information.
+Make sure the suggestions are medium in length and are informative and relevant to the conversation.
+
+Provide these suggestions separated by newlines between the XML tags <suggestions> and </suggestions>. For example:
+
+<suggestions>
+Tell me more about SpaceX and their recent projects
+What is the latest news on SpaceX?
+Who is the CEO of SpaceX?
+</suggestions>
+
+Conversation:
+{chat_history}
+`;
+
+type SuggestionGeneratorInput = {
+  chat_history: ChatTurnMessage[];
+  maxQuestions?: number;
+};
+
+const outputParser = new LineListOutputParser({
+  key: "suggestions",
+});
+
+const generateSuggestions = async (
+  input: SuggestionGeneratorInput,
+  llm: LanguageModel,
+): Promise<string[]> => {
+  const maxQuestions = input.maxQuestions ?? 4;
+  const prompt = createSuggestionGeneratorPrompt(maxQuestions).replace(
+    "{chat_history}",
+    formatChatHistoryAsString(input.chat_history),
+  );
+
+  const { text } = await generateText({
+    model: llm,
+    temperature: 0,
+    prompt,
+  });
+
+  return outputParser.parse(text);
+};
+
+export default generateSuggestions;

package/src/types.d.ts

@@ -1,137 +1,137 @@
-/**
- * @fileoverview Global Type Definitions
- *
- * Shared TypeScript types for UI configuration, model providers,
- * and MCP server configuration used throughout the toolkit.
- */
-
-import { Model } from "./config/config-types";
-
-type BaseUIConfigField = {
-  name: string;
-  key: string;
-  required: boolean;
-  description: string;
-  scope: "client" | "server";
-  env?: string;
-};
-
-type StringUIConfigField = BaseUIConfigField & {
-  type: "string";
-  placeholder?: string;
-  default?: string;
-};
-
-type SelectUIConfigFieldOptions = {
-  name: string;
-  value: string;
-};
-
-type SelectUIConfigField = BaseUIConfigField & {
-  type: "select";
-  default?: string;
-  options: SelectUIConfigFieldOptions[];
-};
-
-type PasswordUIConfigField = BaseUIConfigField & {
-  type: "password";
-  placeholder?: string;
-  default?: string;
-};
-
-type TextareaUIConfigField = BaseUIConfigField & {
-  type: "textarea";
-  placeholder?: string;
-  default?: string;
-};
-
-type SwitchUIConfigField = BaseUIConfigField & {
-  type: "switch";
-  default?: boolean;
-};
-
-type UIConfigField =
-  | StringUIConfigField
-  | SelectUIConfigField
-  | PasswordUIConfigField
-  | TextareaUIConfigField
-  | SwitchUIConfigField;
-
-type ConfigModelProvider = {
-  id: string;
-  name: string;
-  type: string;
-  chatModels: Model[];
-  config: { [key: string]: any };
-  hash: string;
-  isEnvBased?: boolean; // True if provider was created from environment variables (global keys)
-};
-
-type MCPServerConfig = {
-  id: string;
-  name: string;
-  type: string;
-  url?: string;
-  apiKey?: string;
-  config: { [key: string]: any };
-  enabled: boolean;
-  hash: string;
-};
-
-type Config = {
-  version: number;
-  setupComplete: boolean;
-  preferences: {
-    [key: string]: any;
-  };
-  personalization: {
-    [key: string]: any;
-  };
-  modelProviders: ConfigModelProvider[];
-  mcpServers: MCPServerConfig[];
-  search: {
-    [key: string]: any;
-  };
-};
-
-type EnvMap = {
-  [key: string]: {
-    fieldKey: string;
-    providerKey: string;
-  };
-};
-
-type ModelProviderUISection = {
-  name: string;
-  key: string;
-  fields: UIConfigField[];
-};
-
-type MCPServerUISection = {
-  name: string;
-  key: string;
-  fields: UIConfigField[];
-};
-
-type UIConfigSections = {
-  preferences: UIConfigField[];
-  personalization: UIConfigField[];
-  modelProviders: ModelProviderUISection[];
-  mcpServers: MCPServerUISection[];
-  search: UIConfigField[];
-};
-
-export type {
-  UIConfigField,
-  Config,
-  EnvMap,
-  UIConfigSections,
-  SelectUIConfigField,
-  StringUIConfigField,
-  ModelProviderUISection,
-  MCPServerUISection,
-  ConfigModelProvider,
-  MCPServerConfig,
-  TextareaUIConfigField,
-  SwitchUIConfigField,
-};
+/**
+ * @fileoverview Global Type Definitions
+ *
+ * Shared TypeScript types for UI configuration, model providers,
+ * and MCP server configuration used throughout the toolkit.
+ */
+
+import { Model } from "./config/config-types";
+
+type BaseUIConfigField = {
+  name: string;
+  key: string;
+  required: boolean;
+  description: string;
+  scope: "client" | "server";
+  env?: string;
+};
+
+type StringUIConfigField = BaseUIConfigField & {
+  type: "string";
+  placeholder?: string;
+  default?: string;
+};
+
+type SelectUIConfigFieldOptions = {
+  name: string;
+  value: string;
+};
+
+type SelectUIConfigField = BaseUIConfigField & {
+  type: "select";
+  default?: string;
+  options: SelectUIConfigFieldOptions[];
+};
+
+type PasswordUIConfigField = BaseUIConfigField & {
+  type: "password";
+  placeholder?: string;
+  default?: string;
+};
+
+type TextareaUIConfigField = BaseUIConfigField & {
+  type: "textarea";
+  placeholder?: string;
+  default?: string;
+};
+
+type SwitchUIConfigField = BaseUIConfigField & {
+  type: "switch";
+  default?: boolean;
+};
+
+type UIConfigField =
+  | StringUIConfigField
+  | SelectUIConfigField
+  | PasswordUIConfigField
+  | TextareaUIConfigField
+  | SwitchUIConfigField;
+
+type ConfigModelProvider = {
+  id: string;
+  name: string;
+  type: string;
+  chatModels: Model[];
+  config: { [key: string]: any };
+  hash: string;
+  isEnvBased?: boolean; // True if provider was created from environment variables (global keys)
+};
+
+type MCPServerConfig = {
+  id: string;
+  name: string;
+  type: string;
+  url?: string;
+  apiKey?: string;
+  config: { [key: string]: any };
+  enabled: boolean;
+  hash: string;
+};
+
+type Config = {
+  version: number;
+  setupComplete: boolean;
+  preferences: {
+    [key: string]: any;
+  };
+  personalization: {
+    [key: string]: any;
+  };
+  modelProviders: ConfigModelProvider[];
+  mcpServers: MCPServerConfig[];
+  search: {
+    [key: string]: any;
+  };
+};
+
+type EnvMap = {
+  [key: string]: {
+    fieldKey: string;
+    providerKey: string;
+  };
+};
+
+type ModelProviderUISection = {
+  name: string;
+  key: string;
+  fields: UIConfigField[];
+};
+
+type MCPServerUISection = {
+  name: string;
+  key: string;
+  fields: UIConfigField[];
+};
+
+type UIConfigSections = {
+  preferences: UIConfigField[];
+  personalization: UIConfigField[];
+  modelProviders: ModelProviderUISection[];
+  mcpServers: MCPServerUISection[];
+  search: UIConfigField[];
+};
+
+export type {
+  UIConfigField,
+  Config,
+  EnvMap,
+  UIConfigSections,
+  SelectUIConfigField,
+  StringUIConfigField,
+  ModelProviderUISection,
+  MCPServerUISection,
+  ConfigModelProvider,
+  MCPServerConfig,
+  TextareaUIConfigField,
+  SwitchUIConfigField,
+};

package/src/utils/index.ts

@@ -1,2 +1,2 @@
-export * from './chat-helpers';
-export * from './outputParser';
+export * from './chat-helpers';
+export * from './outputParser';