Added TavilyWebSearchDriver

docs/griptape-framework/drivers/src/web_search_drivers_4.py

@@ -0,0 +1,7 @@
+import os
+
+from griptape.drivers import TavilyWebSearchDriver
+
+driver = TavilyWebSearchDriver(api_key=os.environ["TAVILY_API_KEY"])
+
+driver.search("griptape ai")

docs/griptape-framework/drivers/src/web_search_drivers_5.py

@@ -0,0 +1,9 @@
+from griptape.drivers import DuckDuckGoWebSearchDriver
+from griptape.structures import Agent
+from griptape.tools import PromptSummaryTool, WebSearchTool
+
+agent = Agent(
+    tools=[WebSearchTool(web_search_driver=DuckDuckGoWebSearchDriver()), PromptSummaryTool(off_prompt=False)],
+)
+
+agent.run("Give me some websites with information about AI frameworks.")

docs/griptape-framework/drivers/web-search-drivers.md

@@ -1,6 +1,6 @@
 ---
 search:
-  boost: 2 
+  boost: 2
 ---
 
 ## Overview
@@ -9,7 +9,19 @@ Web Search Drivers can be used to search for links from a search query. They are
 
 * `search()` searches the web and returns a [ListArtifact](../../reference/griptape/artifacts/list_artifact.md) that contains JSON-serializable [TextArtifact](../../reference/griptape/artifacts/text_artifact.md)s with the search results.
 
-## Vector Store Drivers
+You can use Web Search Drivers with structures:
+
+```python
+--8<-- "docs/griptape-framework/drivers/src/web_search_drivers_5.py"
+```
+Or use them independently:
+
+```python
+--8<-- "docs/griptape-framework/drivers/src/web_search_drivers_3.py"
+```
+
+
+## Web Search Drivers
 
 ### Google
 
@@ -21,12 +33,6 @@ Example using `GoogleWebSearchDriver` directly:
 --8<-- "docs/griptape-framework/drivers/src/web_search_drivers_1.py"
 ```
 
-Example of using `GoogleWebSearchDriver` with an agent:
-
-```python
---8<-- "docs/griptape-framework/drivers/src/web_search_drivers_2.py"
-```
-
 ### DuckDuckGo
 
 !!! info
@@ -39,3 +45,15 @@ Example of using `DuckDuckGoWebSearchDriver` directly:
 ```python
 --8<-- "docs/griptape-framework/drivers/src/web_search_drivers_3.py"
 ```
+
+### Tavily
+!!! info
+    This driver requires the `drivers-web-search-tavily` [extra](../index.md#extras), and a Tavily [API-KEY](https://app.tavily.com).
+
+The [TavilyWebSearchDriver](../../reference/griptape/drivers/web_search/tavily_web_search_driver.md) uses the [tavily-python](https://github.com/tavily-ai/tavily-python) SDK for web searching.
+
+Example of using `TavilyWebSearchDriver` directly:
+
+```python
+--8<-- "docs/griptape-framework/drivers/src/web_search_drivers_4.py"
+```

griptape/drivers/__init__.py

@@ -99,6 +99,7 @@
 from .web_search.base_web_search_driver import BaseWebSearchDriver
 from .web_search.google_web_search_driver import GoogleWebSearchDriver
 from .web_search.duck_duck_go_web_search_driver import DuckDuckGoWebSearchDriver
+from .web_search.tavily_web_search_driver import TavilyWebSearchDriver
 
 from .event_listener.base_event_listener_driver import BaseEventListenerDriver
 from .event_listener.amazon_sqs_event_listener_driver import AmazonSqsEventListenerDriver
@@ -213,6 +214,7 @@
     "BaseWebSearchDriver",
     "GoogleWebSearchDriver",
     "DuckDuckGoWebSearchDriver",
+    "TavilyWebSearchDriver",
     "BaseEventListenerDriver",
     "AmazonSqsEventListenerDriver",
     "WebhookEventListenerDriver",

griptape/drivers/web_search/base_web_search_driver.py

@@ -8,8 +8,6 @@
 @define
 class BaseWebSearchDriver(ABC):
     results_count: int = field(default=5, kw_only=True)
-    language: str = field(default="en", kw_only=True)
-    country: str = field(default="us", kw_only=True)
 
     @abstractmethod
     def search(self, query: str, **kwargs) -> ListArtifact: ...

griptape/drivers/web_search/duck_duck_go_web_search_driver.py

@@ -15,6 +15,8 @@
 
 @define
 class DuckDuckGoWebSearchDriver(BaseWebSearchDriver):
+    language: str = field(default="en", kw_only=True)
+    country: str = field(default="us", kw_only=True)
     client: DDGS = field(default=Factory(lambda: import_optional_dependency("duckduckgo_search").DDGS()), kw_only=True)
 
     def search(self, query: str, **kwargs) -> ListArtifact:

griptape/drivers/web_search/google_web_search_driver.py

@@ -13,6 +13,8 @@
 class GoogleWebSearchDriver(BaseWebSearchDriver):
     api_key: str = field(kw_only=True)
     search_id: str = field(kw_only=True)
+    language: str = field(default="en", kw_only=True)
+    country: str = field(default="us", kw_only=True)
 
     def search(self, query: str, **kwargs) -> ListArtifact:
         return ListArtifact([TextArtifact(json.dumps(result)) for result in self._search_google(query, **kwargs)])

griptape/drivers/web_search/tavily_web_search_driver.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+import json
+from typing import TYPE_CHECKING
+
+from attrs import Factory, define, field
+
+from griptape.artifacts import ListArtifact, TextArtifact
+from griptape.drivers import BaseWebSearchDriver
+from griptape.utils import import_optional_dependency
+
+if TYPE_CHECKING:
+    from tavily import TavilyClient
+
+
+@define
+class TavilyWebSearchDriver(BaseWebSearchDriver):
+    api_key: str = field(kw_only=True)
+    client: TavilyClient = field(
+        default=Factory(lambda self: import_optional_dependency("tavily").TavilyClient(self.api_key), takes_self=True),
+        kw_only=True,
+    )
+
+    def search(self, query: str, **kwargs) -> ListArtifact:
+        try:
+            response = self.client.search(query, max_results=self.results_count, **kwargs)
+            results = response["results"]
+            return ListArtifact(
+                [
+                    TextArtifact(
+                        json.dumps({"title": result["title"], "url": result["url"], "content": result["content"]})
+                    )
+                    for result in results
+                ]
+            )
+        except Exception as e:
+            raise Exception(f"Error searching '{query}' with Tavily: {e}") from e