clean up

Author: chuasonglin1995

agent/src/index.ts

@@ -11,7 +11,6 @@ import { SlackClientInterface } from "@elizaos/client-slack";
 import { TelegramClientInterface } from "@elizaos/client-telegram";
 import { TwitterClientInterface } from "@elizaos/client-twitter";
 // import { ReclaimAdapter } from "@elizaos/plugin-reclaim";
-import { DirectClient } from "@elizaos/client-direct";
 import { PrimusAdapter } from "@elizaos/plugin-primus";
 
 import {
@@ -102,7 +101,6 @@ import net from "net";
 import path from "path";
 import { fileURLToPath } from "url";
 import yargs from "yargs";
-import {dominosPlugin} from "@elizaos/plugin-dominos";
 
 const __filename = fileURLToPath(import.meta.url); // get the resolved path to the file
 const __dirname = path.dirname(__filename); // get the name of the directory

packages/core/src/generation.ts

@@ -41,16 +41,13 @@ import {
     ModelClass,
     ModelProviderName,
     ServiceType,
-    SearchResponse,
     ActionResponse,
     IVerifiableInferenceAdapter,
     VerifiableInferenceOptions,
     VerifiableInferenceResult,
     //VerifiableInferenceProvider,
     TelemetrySettings,
     TokenizerType,
-    IWebSearchService,
-    SearchOptions,
 } from "./types.ts";
 import { fal } from "@fal-ai/client";
 
@@ -1725,31 +1722,6 @@ export const generateCaption = async (
     };
 };
 
-export const generateWebSearch = async (
-    data: {
-        query: string
-        options?: SearchOptions
-    },
-    runtime: IAgentRuntime
-): Promise<SearchResponse> => {
-    try {
-        const { query, options } = data;
-        const webSearchService =
-        runtime.getService<IWebSearchService>(
-            ServiceType.WEB_SEARCH
-        );
-
-        if (!webSearchService) {
-            throw new Error("Web search service not found");
-        }
-
-        const response = await webSearchService.search(query, runtime, options);
-        return response;
-
-    } catch (error) {
-        elizaLogger.error("Error:", error);
-    }
-};
 /**
  * Configuration options for generating objects with a model.
  */

packages/core/src/types.ts

@@ -1328,23 +1328,6 @@ export interface IPdfService extends Service {
     convertPdfToText(pdfBuffer: Buffer): Promise<string>;
 }
 
-export interface IWebSearchService extends Service {
-    search(
-        query: string,
-        runtime: IAgentRuntime,
-        options?: SearchOptions,
-    ): Promise<SearchResponse>;
-}
-
-export interface SearchOptions {
-    limit?: number;
-    type?: "news" | "general";
-    includeAnswer?: boolean;
-    searchDepth?: "basic" | "advanced";
-    includeImages?: boolean;
-    days?: number; // 1 means current day, 2 means last 2 days
-}
-
 export interface IAwsS3Service extends Service {
     uploadFile(
         imagePath: string,
@@ -1411,28 +1394,6 @@ export interface ITeeLogService extends Service {
     ): Promise<boolean>;
 }
 
-export type SearchImage = {
-    url: string;
-    description?: string;
-};
-
-export type SearchResult = {
-    title: string;
-    url: string;
-    content: string;
-    rawContent?: string;
-    score: number;
-    publishedDate?: string;
-};
-
-export type SearchResponse = {
-    answer?: string;
-    query: string;
-    responseTime: number;
-    images: SearchImage[];
-    results: SearchResult[];
-};
-
 export enum ServiceType {
     IMAGE_DESCRIPTION = "image_description",
     TRANSCRIPTION = "transcription",
@@ -1448,7 +1409,6 @@ export enum ServiceType {
     IRYS = "irys",
     TEE_LOG = "tee_log",
     GOPLUS_SECURITY = "goplus_security",
-    WEB_SEARCH = "web_search",
 }
 
 export enum LoggingLevel {

packages/plugin-node/src/services/index.ts

@@ -6,7 +6,6 @@ import { PdfService } from "./pdf.ts";
 import { SpeechService } from "./speech.ts";
 import { TranscriptionService } from "./transcription.ts";
 import { VideoService } from "./video.ts";
-import { WebSearchService } from "./webSearch.ts";
 
 export {
     AwsS3Service,
@@ -17,5 +16,4 @@ export {
     SpeechService,
     TranscriptionService,
     VideoService,
-    WebSearchService
 };

packages/plugin-web-search/src/actions.ts packages/plugin-web-search/src/actions/webSearch.ts

@@ -1,14 +1,14 @@
-import { elizaLogger } from "@elizaos/core";
 import {
     Action,
     HandlerCallback,
     IAgentRuntime,
     Memory,
     State,
+    elizaLogger
 } from "@elizaos/core";
-import { generateWebSearch } from "@elizaos/core";
-import { SearchResult } from "@elizaos/core";
 import { encodingForModel, TiktokenModel } from "js-tiktoken";
+import { WebSearchService } from "../services/webSearchService";
+import { SearchResult } from "../types";
 
 const DEFAULT_MAX_WEB_SEARCH_TOKENS = 4000;
 const DEFAULT_MODEL_ENCODING = "gpt-3.5-turbo";
@@ -67,10 +67,10 @@ export const webSearch: Action = {
         const webSearchPrompt = message.content.text;
         elizaLogger.log("web search prompt received:", webSearchPrompt);
 
-        elizaLogger.log("Generating image with prompt:", webSearchPrompt);
-        const searchResponse = await generateWebSearch(
+        const webSearchService = new WebSearchService();
+        await webSearchService.initialize(runtime);
+        const searchResponse = await webSearchService.search(
             webSearchPrompt,
-            runtime
         );
 
         if (searchResponse && searchResponse.results.length) {

packages/plugin-web-search/src/index.ts

@@ -1,12 +1,15 @@
-import { webSearch } from "./actions";
+import { webSearch } from "./actions/webSearch";
 import { Plugin } from "@elizaos/core";
+import { WebSearchService } from "./services/webSearchService";
 
 export const webSearchPlugin: Plugin = {
     name: "webSearch",
-    description: "Search web",
+    description: "Search the web and get news",
     actions: [webSearch],
     evaluators: [],
     providers: [],
+    services: [new WebSearchService()],
+    clients: [],
 };
 
 export default webSearchPlugin;

packages/plugin-node/src/services/webSearch.ts packages/plugin-web-search/src/services/webSearchService.ts

@@ -1,35 +1,33 @@
 import {
     Service,
-    IWebSearchService,
-    ServiceType,
     IAgentRuntime,
-    SearchResponse,
-    SearchOptions,
 } from "@elizaos/core";
 import { tavily } from "@tavily/core";
+import { IWebSearchService, SearchOptions, SearchResponse } from "../types";
+
+export type TavilyClient = ReturnType<typeof tavily>; // declaring manually because orginal package does not export its types
 
 export class WebSearchService extends Service implements IWebSearchService {
-    static serviceType: ServiceType = ServiceType.WEB_SEARCH;
+    public tavilyClient: TavilyClient
 
-    async initialize(_runtime: IAgentRuntime): Promise<void> {}
+    async initialize(_runtime: IAgentRuntime): Promise<void> {
+        const apiKey = _runtime.getSetting("TAVILY_API_KEY") as string;
+        if (!apiKey) {
+            throw new Error("TAVILY_API_KEY is not set");
+        }
+        this.tavilyClient = tavily({ apiKey });
+    }
 
     getInstance(): IWebSearchService {
         return WebSearchService.getInstance();
     }
 
     async search(
         query: string,
-        runtime: IAgentRuntime,
         options?: SearchOptions,
     ): Promise<SearchResponse> {
         try {
-            const apiKey = runtime.getSetting("TAVILY_API_KEY") as string;
-            if (!apiKey) {
-                throw new Error("TAVILY_API_KEY is not set");
-            }
-
-            const tvly = tavily({ apiKey });
-            const response = await tvly.search(query, {
+            const response = await this.tavilyClient.search(query, {
                 includeAnswer: options?.includeAnswer || true,
                 maxResults: options?.limit || 3,
                 topic: options?.type || "general",

packages/plugin-web-search/src/types.ts

@@ -0,0 +1,40 @@
+import { Service } from "@elizaos/core";
+
+export interface IWebSearchService extends Service {
+    search(
+        query: string,
+        options?: SearchOptions,
+    ): Promise<SearchResponse>;
+}
+
+export type SearchResult = {
+    title: string;
+    url: string;
+    content: string;
+    rawContent?: string;
+    score: number;
+    publishedDate?: string;
+};
+
+export type SearchImage = {
+    url: string;
+    description?: string;
+};
+
+
+export type SearchResponse = {
+    answer?: string;
+    query: string;
+    responseTime: number;
+    images: SearchImage[];
+    results: SearchResult[];
+};
+
+export interface SearchOptions {
+    limit?: number;
+    type?: "news" | "general";
+    includeAnswer?: boolean;
+    searchDepth?: "basic" | "advanced";
+    includeImages?: boolean;
+    days?: number; // 1 means current day, 2 means last 2 days
+}