Add SearchApi integration (#1369)

* Add SearchApi integration

* Add SearchApi Tool

* Update SearchApi_Tool JSON example and update description

docs/docs/components/tools.mdx

@@ -9,6 +9,21 @@ import Admonition from '@theme/Admonition';
 </Admonition>
 
 
+### SearchApi
+
+Real-time search engine results API. Returns structured JSON data that includes answer box, knowledge graph, organic results, and more.
+
+**Parameters**
+
+- **Api Key:** A unique identifier for the SearchApi, necessary for authenticating requests to real-time search engines. This key can be retrieved from the [SearchApi dashboard](https://www.searchapi.io/).
+- **Engine:** Specifies the search engine. For instance: google, google_scholar, bing, youtube, and youtube_transcripts. A full list of supported engines is available in the [documentation](https://www.searchapi.io/docs/google).
+- **Parameters:** Allows the selection of any parameters recognized by SearchApi, with some being required and others optional. 
+
+**Output**
+
+- **Document:** The JSON response from the request as a Document.
+
+
 ### BingSearchRun
 
 Bing Search is a web search engine owned and operated by Microsoft. It provides search results for various types of content, including web pages, images, videos, and news articles. It uses a combination of algorithms and human editors to deliver search results to users.
@@ -60,4 +75,4 @@ Tool for getting metadata about a SQL database. The input to this tool is a comm
 
 **Params**
 
-- **Db:** SQLDatabase to query.
+- **Db:** SQLDatabase to query.

docs/docs/examples/searchapi-tool.mdx

@@ -0,0 +1,52 @@
+import Admonition from "@theme/Admonition";
+
+# SearchApi Tool
+
+The [SearchApi](https://www.searchapi.io/) allows developers to retrieve results from search engines such as Google, Google Scholar, YouTube, YouTube transcripts, and more, and can be used as in Langflow through the `SearchApi` tool.
+
+<Admonition type="info">
+  To use the SearchApi, you must first obtain an API key by registering at [SearchApi's website](https://www.searchapi.io/).
+</Admonition>
+
+In the given example, we specify `engine` as `youtube_transcripts` and provide a `video_id`.
+
+<Admonition type="info">
+  All engines and parameters can be found in [SearchApi documentation](https://www.searchapi.io/docs/google).
+</Admonition>
+
+The `RetrievalQA` chain processes a `Document` along with a user's question to return an answer.
+
+<Admonition type="tip">
+  In this example, we used [`ChatOpenAI`](https://platform.openai.com/) as the
+  LLM, but feel free to experiment with other Language Models!
+</Admonition>
+
+The `RetrievalQA` takes `CombineDocsChain` and `SearchApi` tool as inputs, using the tool as a `Document` to answer questions.
+
+<Admonition type="info">
+  Learn more about the SearchApi
+  [here](https://python.langchain.com/docs/integrations/tools/searchapi).
+</Admonition>
+
+## ⛓️ Langflow Example
+
+import ThemedImage from "@theme/ThemedImage";
+import useBaseUrl from "@docusaurus/useBaseUrl";
+import ZoomableImage from "/src/theme/ZoomableImage.js";
+
+<ZoomableImage
+  alt="Docusaurus themed image"
+  sources={{
+    light: "img/searchapi-tool.png",
+  }}
+/>
+
+#### <a target="\_blank" href="json_files/SearchApi_Tool.json" download>Download Flow</a>
+
+<Admonition type="note" title="LangChain Components 🦜🔗">
+
+- [`OpenAI`](https://python.langchain.com/docs/modules/model_io/models/llms/integrations/openai)
+- [`SearchApiAPIWrapper`](https://python.langchain.com/docs/integrations/providers/searchapi#wrappers)
+- [`ZeroShotAgent`](https://python.langchain.com/docs/modules/agents/how_to/custom_mrkl_agent)
+
+</Admonition>

docs/sidebars.js

@@ -81,6 +81,7 @@ module.exports = {
         "examples/buffer-memory",
         "examples/midjourney-prompt-chain",
         "examples/csv-loader",
+        "examples/searchapi-tool",
         "examples/serp-api-tool",
         "examples/multiple-vectorstores",
         "examples/python-function",

src/backend/langflow/components/tools/SearchApi.py

@@ -0,0 +1,51 @@
+from langflow import CustomComponent
+from langchain.schema import Document
+from langflow.services.database.models.base import orjson_dumps
+from langchain_community.utilities.searchapi import SearchApiAPIWrapper
+from typing import Optional
+
+
+class SearchApi(CustomComponent):
+    display_name: str = "SearchApi"
+    description: str = "Real-time search engine results API."
+    output_types: list[str] = ["Document"]
+    documentation: str = "https://www.searchapi.io/docs/google"
+    field_config = {
+        "engine": {
+            "display_name": "Engine",
+            "field_type": "str",
+            "info": "The search engine to use.",
+        },
+        "params": {
+            "display_name": "Parameters",
+            "info": "The parameters to send with the request.",
+        },
+        "code": {"show": False},
+        "api_key": {
+            "display_name": "API Key",
+            "field_type": "str",
+            "required": True,
+            "password": True,
+            "info": "The API key to use SearchApi.",
+        },
+    }
+
+    def build(
+        self,
+        engine: str,
+        api_key: str,
+        params: Optional[dict] = None,
+    ) -> Document:
+        if params is None:
+            params = {}
+
+        search_api_wrapper = SearchApiAPIWrapper(engine=engine, searchapi_api_key=api_key)
+
+        q = params.pop("q", "SearchApi Langflow")
+        results = search_api_wrapper.results(q, **params)
+
+        result = orjson_dumps(results, indent_2=False)
+
+        document = Document(page_content=result)
+
+        return document