Add SearchApi description, _get_tool_labels, return results based on result_type

Author: SebastjanPrachovskij

api/core/tools/provider/builtin/searchapi/searchapi.py

@@ -1,5 +1,6 @@
 from typing import Any
 
+from core.tools.entities.values import ToolLabelEnum
 from core.tools.errors import ToolProviderCredentialValidationError
 from core.tools.provider.builtin.searchapi.tools.google import GoogleTool
 from core.tools.provider.builtin_tool_provider import BuiltinToolProviderController
@@ -9,7 +10,7 @@ class SearchAPIProvider(BuiltinToolProviderController):
     def _validate_credentials(self, credentials: dict[str, Any]) -> None:
         try:
             GoogleTool().fork_tool_runtime(
-                meta={
+                runtime={
                     "credentials": credentials,
                 }
             ).invoke(
@@ -20,4 +21,9 @@ def _validate_credentials(self, credentials: dict[str, Any]) -> None:
                 },
             )
         except Exception as e:
-            raise ToolProviderCredentialValidationError(str(e))
+            raise ToolProviderCredentialValidationError(str(e))
+
+    def _get_tool_labels(self) -> list[ToolLabelEnum]:
+        return [
+            ToolLabelEnum.SEARCH
+        ]

api/core/tools/provider/builtin/searchapi/searchapi.yaml

@@ -6,9 +6,9 @@ identity:
     zh_Hans: SearchApi
     pt_BR: SearchApi
   description:
-    en_US: SearchApi
-    zh_Hans: SearchApi
-    pt_BR: SearchApi
+    en_US: SearchApi is a robust real-time SERP API delivering structured data from a collection of search engines including Google Search, Google Jobs, YouTube, Google News, and many more.
+    zh_Hans: SearchApi 是一个强大的实时 SERP API，可提供来自 Google 搜索、Google 招聘、YouTube、Google 新闻等搜索引擎集合的结构化数据。
+    pt_BR: SearchApi is a robust real-time SERP API delivering structured data from a collection of search engines including Google Search, Google Jobs, YouTube, Google News, and many more.
   icon: icon.svg
 credentials_for_provider:
   searchapi_api_key:

api/core/tools/provider/builtin/searchapi/tools/google.py

@@ -45,7 +45,7 @@ def _process_response(res: dict, type: str) -> str:
         """Process response from SearchAPI."""
         if "error" in res.keys():
             raise ValueError(f"Got error from SearchApi: {res['error']}")
-        
+
         toret = ""
         if type == "text":
             if "answer_box" in res.keys() and "answer" in res["answer_box"].keys():
@@ -63,7 +63,7 @@ def _process_response(res: dict, type: str) -> str:
         elif type == "link":
             if "answer_box" in res.keys() and "organic_result" in res["answer_box"].keys():
                 if "title" in res["answer_box"]["organic_result"].keys():
-                    toret = f"[{res['answer_box']['organic_result']['title']}]({res['answer_box']['organic_result']['link']})\n" 
+                    toret = f"[{res['answer_box']['organic_result']['title']}]({res['answer_box']['organic_result']['link']})\n"
             elif "organic_results" in res.keys() and "link" in res["organic_results"][0].keys():
                 toret = ""
                 for item in res["organic_results"]:
@@ -81,9 +81,9 @@ def _process_response(res: dict, type: str) -> str:
         return toret
 
 class GoogleTool(BuiltinTool):
-    def _invoke(self, 
+    def _invoke(self,
                 user_id: str,
-                tool_parameters: dict[str, Any], 
+                tool_parameters: dict[str, Any],
         ) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
         """
         Invoke the SearchApi tool.
@@ -95,8 +95,10 @@ def _invoke(self,
         gl = tool_parameters.get("gl", "us")
         hl = tool_parameters.get("hl", "en")
         location = tool_parameters.get("location", None)
-        
+
         api_key = self.runtime.credentials['searchapi_api_key']
         result = SearchAPI(api_key).run(query, result_type=result_type, num=num, google_domain=google_domain, gl=gl, hl=hl, location=location)
-        
-        return self.create_text_message(text=result)
+
+        if result_type == 'text':
+            return self.create_text_message(text=result)
+        return self.create_link_message(link=result)

api/core/tools/provider/builtin/searchapi/tools/google.yaml

@@ -96,4 +96,4 @@ parameters:
       zh_Hans: 指定每页显示的结果数。默认值为 10。最大数量 - 100，最小数量 - 1。
       pt_BR: Specifies the number of results to display per page. Default is 10. Max number - 100, min - 1.
     llm_description: Specifies the num of results to display per page.
-    form: llm
+    form: llm

api/core/tools/provider/builtin/searchapi/tools/google_jobs.py

@@ -50,7 +50,7 @@ def _process_response(res: dict, type: str) -> str:
         if type == "text":
             if "jobs" in res.keys() and "title" in res["jobs"][0].keys():
                 for item in res["jobs"]:
-                    toret += "title: " + item["title"] + "\n" + "company_name: " + item["company_name"] + "content: " + item["description"] + "\n" 
+                    toret += "title: " + item["title"] + "\n" + "company_name: " + item["company_name"] + "content: " + item["description"] + "\n"
             if toret == "":
                 toret = "No good search result found"
 
@@ -63,9 +63,9 @@ def _process_response(res: dict, type: str) -> str:
         return toret
 
 class GoogleJobsTool(BuiltinTool):
-    def _invoke(self, 
+    def _invoke(self,
                 user_id: str,
-                tool_parameters: dict[str, Any], 
+                tool_parameters: dict[str, Any],
         ) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
         """
         Invoke the SearchApi tool.
@@ -82,5 +82,7 @@ def _invoke(self,
 
         api_key = self.runtime.credentials['searchapi_api_key']
         result = SearchAPI(api_key).run(query, result_type=result_type, google_domain=google_domain, gl=gl, hl=hl, location=location, ltype=ltype)
-        
-        return self.create_text_message(text=result)
+
+        if result_type == 'text':
+            return self.create_text_message(text=result)
+        return self.create_link_message(link=result)

api/core/tools/provider/builtin/searchapi/tools/google_news.py

@@ -45,7 +45,7 @@ def _process_response(res: dict, type: str) -> str:
         """Process response from SearchAPI."""
         if "error" in res.keys():
             raise ValueError(f"Got error from SearchApi: {res['error']}")
-        
+
         toret = ""
         if type == "text":
             if "organic_results" in res.keys() and "snippet" in res["organic_results"][0].keys():
@@ -69,9 +69,9 @@ def _process_response(res: dict, type: str) -> str:
         return toret
 
 class GoogleNewsTool(BuiltinTool):
-    def _invoke(self, 
+    def _invoke(self,
                 user_id: str,
-                tool_parameters: dict[str, Any], 
+                tool_parameters: dict[str, Any],
         ) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
         """
         Invoke the SearchApi tool.
@@ -83,8 +83,10 @@ def _invoke(self,
         gl = tool_parameters.get("gl", "us")
         hl = tool_parameters.get("hl", "en")
         location = tool_parameters.get("location", None)
-        
+
         api_key = self.runtime.credentials['searchapi_api_key']
         result = SearchAPI(api_key).run(query, result_type=result_type, num=num, google_domain=google_domain, gl=gl, hl=hl, location=location)
-        
-        return self.create_text_message(text=result)
+
+        if result_type == 'text':
+            return self.create_text_message(text=result)
+        return self.create_link_message(link=result)

api/core/tools/provider/builtin/searchapi/tools/google_news.yaml

@@ -97,4 +97,3 @@ parameters:
       pt_BR: Specifies the number of results to display per page. Default is 10. Max number - 100, min - 1.
     llm_description: Specifies the num of results to display per page.
     form: llm
-

api/core/tools/provider/builtin/searchapi/tools/youtube_transcripts.py

@@ -56,9 +56,9 @@ def _process_response(res: dict) -> str:
         return toret
 
 class YoutubeTranscriptsTool(BuiltinTool):
-    def _invoke(self, 
+    def _invoke(self,
                 user_id: str,
-                tool_parameters: dict[str, Any], 
+                tool_parameters: dict[str, Any],
         ) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
         """
         Invoke the SearchApi tool.
@@ -68,5 +68,5 @@ def _invoke(self,
 
         api_key = self.runtime.credentials['searchapi_api_key']
         result = SearchAPI(api_key).run(video_id, language=language)
-        
+
         return self.create_text_message(text=result)