feat: Add Glean Search API Component (#3532)

src/backend/base/langflow/components/tools/GleanSearchAPI.py

@@ -0,0 +1,118 @@
+import httpx
+import json
+
+from typing import Any, Dict, Optional, Union
+from urllib.parse import urljoin
+
+from langchain_core.pydantic_v1 import BaseModel
+
+from langflow.base.langchain_utilities.model import LCToolComponent
+from langflow.inputs import SecretStrInput, StrInput, NestedDictInput, IntInput
+from langflow.field_typing import Tool
+from langflow.schema import Data
+
+
+class GleanSearchAPIComponent(LCToolComponent):
+    display_name = "Glean Search API"
+    description = "Call Glean Search API"
+    name = "GleanAPI"
+
+    inputs = [
+        StrInput(
+            name="glean_api_url",
+            display_name="Glean API URL",
+            required=True,
+        ),
+        SecretStrInput(name="glean_access_token", display_name="Glean Access Token", required=True),
+        StrInput(name="query", display_name="Query", required=True),
+        IntInput(name="page_size", display_name="Page Size", value=10),
+        NestedDictInput(name="request_options", display_name="Request Options", required=False),
+    ]
+
+    def build_tool(self) -> Tool:
+        wrapper = self._build_wrapper()
+
+        return Tool(name="glean_search_api", description="Search with the Glean API", func=wrapper.run)
+
+    def run_model(self) -> Union[Data, list[Data]]:
+        wrapper = self._build_wrapper()
+
+        results = wrapper.results(
+            query=self.query,
+            page_size=self.page_size,
+            request_options=self.request_options,
+        )
+
+        list_results = results.get("results", [])
+
+        # Build the data
+        data = []
+        for result in list_results:
+            data.append(Data(data=result))
+
+        self.status = data
+
+        return data
+
+    def _build_wrapper(self):
+        class GleanAPIWrapper(BaseModel):
+            """
+            Wrapper around Glean API.
+            """
+
+            glean_api_url: str
+            glean_access_token: str
+            act_as: str = "langflow-component@datastax.com"  # TODO: Detect this
+
+            def _prepare_request(
+                self,
+                query: str,
+                page_size: int = 10,
+                request_options: Optional[Dict[str, Any]] = None,
+            ) -> dict:
+                # Ensure there's a trailing slash
+                url = self.glean_api_url
+                if not url.endswith("/"):
+                    url += "/"
+
+                return {
+                    "url": urljoin(url, "search"),
+                    "headers": {
+                        "Authorization": f"Bearer {self.glean_access_token}",
+                        "X-Scio-ActAs": self.act_as,
+                    },
+                    "payload": {
+                        "query": query,
+                        "pageSize": page_size,
+                        "requestOptions": request_options,
+                    },
+                }
+
+            def run(self, query: str, **kwargs: Any) -> str:
+                results = self.results(query, **kwargs)
+
+                return self._result_as_string(results)
+
+            def results(self, query: str, **kwargs: Any) -> dict:
+                results = self._search_api_results(query, **kwargs)
+
+                return results
+
+            def _search_api_results(self, query: str, **kwargs: Any) -> Dict[str, Any]:
+                request_details = self._prepare_request(query, **kwargs)
+
+                response = httpx.post(
+                    request_details["url"],
+                    json=request_details["payload"],
+                    headers=request_details["headers"],
+                )
+
+                response.raise_for_status()
+
+                return response.json()
+
+            @staticmethod
+            def _result_as_string(result: dict) -> str:
+                return json.dumps(result, indent=4)
+
+        return GleanAPIWrapper(glean_api_url=self.glean_api_url, glean_access_token=self.glean_access_token)

src/backend/base/langflow/components/tools/__init__.py

@@ -1,6 +1,7 @@
 from .PythonREPLTool import PythonREPLToolComponent
 from .RetrieverTool import RetrieverToolComponent
 from .BingSearchAPI import BingSearchAPIComponent
+from .GleanSearchAPI import GleanSearchAPIComponent
 from .GoogleSearchAPI import GoogleSearchAPIComponent
 from .GoogleSerperAPI import GoogleSerperAPIComponent
 from .PythonCodeStructuredTool import PythonCodeStructuredTool
@@ -14,6 +15,7 @@ from .WolframAlphaAPI import WolframAlphaAPIComponent
 __all__ = [
     "RetrieverToolComponent",
     "BingSearchAPIComponent",
+    "GleanSearchAPIComponent",
     "GoogleSearchAPIComponent",
     "GoogleSerperAPIComponent",
     "PythonCodeStructuredTool",