Merge pull request #1246 from tomguluson92/tomguluson92-patch-2

feat: upgrade Tavily API with comprehensive input and constrain the token consumption

Author: odilitime

.env.example

@@ -261,6 +261,9 @@ LARGE_AKASH_CHAT_API_MODEL=  # Default: Meta-Llama-3-1-405B-Instruct-FP8
 FAL_API_KEY=
 FAL_AI_LORA_PATH=
 
+# Web search API Configuration
+TAVILY_API_KEY=
+
 # WhatsApp Cloud API Configuration
 WHATSAPP_ACCESS_TOKEN=          # Permanent access token from Facebook Developer Console
 WHATSAPP_PHONE_NUMBER_ID=       # Phone number ID from WhatsApp Business API

packages/core/src/generation.ts

@@ -1215,6 +1215,10 @@ export const generateWebSearch = async (
                 api_key: apiKey,
                 query,
                 include_answer: true,
+                max_results: 3, // 5 (default)
+                topic: "general", // "general"(default) "news"
+                search_depth: "basic", // "basic"(default) "advanced"
+                include_images: false, // false (default) true
             }),
         });
 

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

@@ -8,8 +8,30 @@ import {
     State,
 } from "@ai16z/eliza";
 import { generateWebSearch } from "@ai16z/eliza";
-
 import { SearchResult } from "@ai16z/eliza";
+import { encodingForModel, TiktokenModel } from "js-tiktoken";
+
+const DEFAULT_MAX_WEB_SEARCH_TOKENS = 4000;
+const DEFAULT_MODEL_ENCODING = "gpt-3.5-turbo";
+
+function getTotalTokensFromString(
+    str: string,
+    encodingName: TiktokenModel = DEFAULT_MODEL_ENCODING
+  ) {
+    const encoding = encodingForModel(encodingName);
+    return encoding.encode(str).length;
+  }
+
+function MaxTokens(
+    data: string,
+    maxTokens: number = DEFAULT_MAX_WEB_SEARCH_TOKENS
+  ): string {
+    
+    if (getTotalTokensFromString(data) >= maxTokens) {
+        return data.slice(0, maxTokens);
+    }
+    return data;
+  }
 
 const webSearch: Action = {
     name: "WEB_SEARCH",
@@ -68,7 +90,7 @@ const webSearch: Action = {
                 : "";
 
             callback({
-                text: responseList,
+                text: MaxTokens(responseList, DEFAULT_MAX_WEB_SEARCH_TOKENS),
             });
         } else {
             elizaLogger.error("search failed or returned no data.");