Feat/assistant app (#2086)

Co-authored-by: chenhe <guchenhe@gmail.com>
Co-authored-by: Pascal M <11357019+perzeuss@users.noreply.github.com>

api/core/tools/provider/builtin/google/_assets/icon.svg

@@ -0,0 +1,6 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="25" viewBox="0 0 24 25" fill="none">
+  <path d="M22.501 12.7332C22.501 11.8699 22.4296 11.2399 22.2748 10.5865H12.2153V14.4832H18.12C18.001 15.4515 17.3582 16.9099 15.9296 17.8898L15.9096 18.0203L19.0902 20.435L19.3106 20.4565C21.3343 18.6249 22.501 15.9298 22.501 12.7332Z" fill="#4285F4"/>
+  <path d="M12.214 23C15.1068 23 17.5353 22.0666 19.3092 20.4567L15.9282 17.8899C15.0235 18.5083 13.8092 18.9399 12.214 18.9399C9.38069 18.9399 6.97596 17.1083 6.11874 14.5766L5.99309 14.5871L2.68583 17.0954L2.64258 17.2132C4.40446 20.6433 8.0235 23 12.214 23Z" fill="#34A853"/>
+  <path d="M6.12046 14.5766C5.89428 13.9233 5.76337 13.2233 5.76337 12.5C5.76337 11.7766 5.89428 11.0766 6.10856 10.4233L6.10257 10.2841L2.75386 7.7355L2.64429 7.78658C1.91814 9.20993 1.50146 10.8083 1.50146 12.5C1.50146 14.1916 1.91814 15.7899 2.64429 17.2132L6.12046 14.5766Z" fill="#FBBC05"/>
+  <path d="M12.2141 6.05997C14.2259 6.05997 15.583 6.91163 16.3569 7.62335L19.3807 4.73C17.5236 3.03834 15.1069 2 12.2141 2C8.02353 2 4.40447 4.35665 2.64258 7.78662L6.10686 10.4233C6.97598 7.89166 9.38073 6.05997 12.2141 6.05997Z" fill="#EB4335"/>
+</svg>

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

@@ -0,0 +1,23 @@
+from core.tools.provider.builtin_tool_provider import BuiltinToolProviderController
+from core.tools.errors import ToolProviderCredentialValidationError
+
+from core.tools.provider.builtin.google.tools.google_search import GoogleSearchTool
+
+from typing import Any, Dict, List
+
+class GoogleProvider(BuiltinToolProviderController):
+    def _validate_credentials(self, credentials: Dict[str, Any]) -> None:
+        try:
+            GoogleSearchTool().fork_tool_runtime(
+                meta={
+                    "credentials": credentials,
+                }
+            ).invoke(
+                user_id='',
+                tool_paramters={
+                    "query": "test",
+                    "result_type": "link"
+                },
+            )
+        except Exception as e:
+            raise ToolProviderCredentialValidationError(str(e))

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

@@ -0,0 +1,24 @@
+identity:
+  author: Dify
+  name: google
+  label:
+    en_US: Google
+    zh_Hans: Google
+  description:
+    en_US: Google
+    zh_Hans: GoogleSearch
+  icon: icon.svg
+credentails_for_provider:
+  serpapi_api_key:
+    type: secret-input
+    required: true
+    label:
+      en_US: SerpApi API key
+      zh_Hans: SerpApi API key
+    placeholder:
+      en_US: Please input your SerpApi API key
+      zh_Hans: 请输入你的 SerpApi API key
+    help:
+      en_US: Get your SerpApi API key from SerpApi
+      zh_Hans: 从 SerpApi 获取您的 SerpApi API key
+    url: https://serpapi.com/manage-api-key

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

@@ -0,0 +1,163 @@
+from core.tools.tool.builtin_tool import BuiltinTool
+from core.tools.entities.tool_entities import ToolInvokeMessage
+
+from typing import Any, Dict, List, Union
+
+import os
+import sys
+
+from serpapi import GoogleSearch
+
+class HiddenPrints:
+    """Context manager to hide prints."""
+
+    def __enter__(self) -> None:
+        """Open file to pipe stdout to."""
+        self._original_stdout = sys.stdout
+        sys.stdout = open(os.devnull, "w")
+
+    def __exit__(self, *_: Any) -> None:
+        """Close file that stdout was piped to."""
+        sys.stdout.close()
+        sys.stdout = self._original_stdout
+
+
+class SerpAPI:
+    """
+    SerpAPI tool provider.
+    """
+
+    search_engine: Any  #: :meta private:
+    serpapi_api_key: str = None
+
+    def __init__(self, api_key: str) -> None:
+        """Initialize SerpAPI tool provider."""
+        self.serpapi_api_key = api_key
+        self.search_engine = GoogleSearch
+
+    def run(self, query: str, **kwargs: Any) -> str:
+        """Run query through SerpAPI and parse result."""
+        typ = kwargs.get("result_type", "text")
+        return self._process_response(self.results(query), typ=typ)
+
+    def results(self, query: str) -> dict:
+        """Run query through SerpAPI and return the raw result."""
+        params = self.get_params(query)
+        with HiddenPrints():
+            search = self.search_engine(params)
+            res = search.get_dict()
+        return res
+
+    def get_params(self, query: str) -> Dict[str, str]:
+        """Get parameters for SerpAPI."""
+        _params = {
+            "api_key": self.serpapi_api_key,
+            "q": query,
+        }
+        params = {
+            "engine": "google",
+            "google_domain": "google.com",
+            "gl": "us",
+            "hl": "en",
+            **_params
+        }
+        return params
+
+    @staticmethod
+    def _process_response(res: dict, typ: str) -> str:
+        """Process response from SerpAPI."""
+        if "error" in res.keys():
+            raise ValueError(f"Got error from SerpAPI: {res['error']}")
+        
+        if typ == "text":
+            if "answer_box" in res.keys() and type(res["answer_box"]) == list:
+                res["answer_box"] = res["answer_box"][0]
+            if "answer_box" in res.keys() and "answer" in res["answer_box"].keys():
+                toret = res["answer_box"]["answer"]
+            elif "answer_box" in res.keys() and "snippet" in res["answer_box"].keys():
+                toret = res["answer_box"]["snippet"]
+            elif (
+                "answer_box" in res.keys()
+                and "snippet_highlighted_words" in res["answer_box"].keys()
+            ):
+                toret = res["answer_box"]["snippet_highlighted_words"][0]
+            elif (
+                "sports_results" in res.keys()
+                and "game_spotlight" in res["sports_results"].keys()
+            ):
+                toret = res["sports_results"]["game_spotlight"]
+            elif (
+                "shopping_results" in res.keys()
+                and "title" in res["shopping_results"][0].keys()
+            ):
+                toret = res["shopping_results"][:3]
+            elif (
+                "knowledge_graph" in res.keys()
+                and "description" in res["knowledge_graph"].keys()
+            ):
+                toret = res["knowledge_graph"]["description"]
+            elif "snippet" in res["organic_results"][0].keys():
+                toret = res["organic_results"][0]["snippet"]
+            elif "link" in res["organic_results"][0].keys():
+                toret = res["organic_results"][0]["link"]
+            elif (
+                "images_results" in res.keys()
+                and "thumbnail" in res["images_results"][0].keys()
+            ):
+                thumbnails = [item["thumbnail"] for item in res["images_results"][:10]]
+                toret = thumbnails
+            else:
+                toret = "No good search result found"
+        elif typ == "link":
+            if "knowledge_graph" in res.keys() and "title" in res["knowledge_graph"].keys() \
+                    and "description_link" in res["knowledge_graph"].keys():
+                toret = res["knowledge_graph"]["description_link"]
+            elif "knowledge_graph" in res.keys() and "see_results_about" in res["knowledge_graph"].keys() \
+                and len(res["knowledge_graph"]["see_results_about"]) > 0:
+                see_result_about = res["knowledge_graph"]["see_results_about"]
+                toret = ""
+                for item in see_result_about:
+                    if "name" not in item.keys() or "link" not in item.keys():
+                        continue
+                    toret += f"[{item['name']}]({item['link']})\n"
+            elif "organic_results" in res.keys() and len(res["organic_results"]) > 0:
+                organic_results = res["organic_results"]
+                toret = ""
+                for item in organic_results:
+                    if "title" not in item.keys() or "link" not in item.keys():
+                        continue
+                    toret += f"[{item['title']}]({item['link']})\n"
+            elif "related_questions" in res.keys() and len(res["related_questions"]) > 0:
+                related_questions = res["related_questions"]
+                toret = ""
+                for item in related_questions:
+                    if "question" not in item.keys() or "link" not in item.keys():
+                        continue
+                    toret += f"[{item['question']}]({item['link']})\n"
+            elif "related_searches" in res.keys() and len(res["related_searches"]) > 0:
+                related_searches = res["related_searches"]
+                toret = ""
+                for item in related_searches:
+                    if "query" not in item.keys() or "link" not in item.keys():
+                        continue
+                    toret += f"[{item['query']}]({item['link']})\n"
+            else:
+                toret = "No good search result found"
+        return toret
+
+class GoogleSearchTool(BuiltinTool):
+    def _invoke(self, 
+                user_id: str,
+               tool_paramters: Dict[str, Any], 
+        ) -> Union[ToolInvokeMessage, List[ToolInvokeMessage]]:
+        """
+            invoke tools
+        """
+        query = tool_paramters['query']
+        result_type = tool_paramters['result_type']
+        api_key = self.runtime.credentials['serpapi_api_key']
+        result = SerpAPI(api_key).run(query, result_type=result_type)
+        if result_type == 'text':
+            return self.create_text_message(text=result)
+        return self.create_link_message(link=result)
+    

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

@@ -0,0 +1,43 @@
+identity:
+  name: google_search
+  author: Dify
+  label:
+    en_US: GoogleSearch
+    zh_Hans: 谷歌搜索
+description:
+  human:
+    en_US: A tool for performing a Google SERP search and extracting snippets and webpages.Input should be a search query.
+    zh_Hans: 一个用于执行 Google SERP 搜索并提取片段和网页的工具。输入应该是一个搜索查询。
+  llm: A tool for performing a Google SERP search and extracting snippets and webpages.Input should be a search query.
+parameters:
+  - name: query
+    type: string
+    required: true
+    label:
+      en_US: Query string
+      zh_Hans: 查询语句
+    human_description:
+      en_US: used for searching
+      zh_Hans: 用于搜索网页内容
+    llm_description: key words for searching
+    form: llm
+  - name: result_type
+    type: select
+    required: true
+    options:
+      - value: text
+        label:
+          en_US: text
+          zh_Hans: 文本
+      - value: link
+        label:
+          en_US: link
+          zh_Hans: 链接
+    default: link
+    label:
+      en_US: Result type
+      zh_Hans: 结果类型
+    human_description:
+      en_US: used for selecting the result type, text or link
+      zh_Hans: 用于选择结果类型，使用文本还是链接进行展示
+    form: form