This repository has been archived by the owner on Mar 1, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 736
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
name change and README update (#614)
* Adding Tavily Search API as a tool. * fix formatting + type List * Update base.py Change from class Client to TavilyClient * Update requirements.txt * formatting * formatting * black formatting * Change name to tavily_research and add to README * fix library.json
- Loading branch information
1 parent
b4eabb9
commit 001ec40
Showing
6 changed files
with
38 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Tavily Research Tool | ||
|
||
[Tavily](https://app.tavily.com/) is a robust research API tailored specifically for LLM Agents. It seamlessly integrates with diverse data sources to ensure a superior, relevant research experience. | ||
|
||
To begin, you need to obtain an API key on the [Tavily's developer dashboard](https://app.tavily.com/). | ||
|
||
## Why Choose Tavily Research API? | ||
|
||
1. **Purpose-Built**: Tailored just for LLM Agents, we ensure our features and results resonate with your unique needs. We take care of all the burden in searching, scraping, filtering and extracting information from online sources. All in a single API call! | ||
2. **Versatility**: Beyond just fetching results, Tavily Research API offers precision. With customizable search depths, domain management, and parsing html content controls, you're in the driver's seat. | ||
3. **Performance**: Committed to rapidity and efficiency, our API guarantees real-time outcomes without sidelining accuracy. Please note that we're just getting started, so performance may vary and improve over time. | ||
4. **Integration-friendly**: We appreciate the essence of adaptability. That's why integrating our API with your existing setup is a breeze. You can choose our Python library or a simple API call or any of our supported partners such as [Langchain](https://python.langchain.com/docs/integrations/tools/tavily_search) and [LLamaIndex](https://llamahub.ai/l/tools-tavily). | ||
5. **Transparent & Informative**: Our detailed documentation ensures you're never left in the dark. From setup basics to nuanced features, we've got you covered. | ||
|
||
## Usage | ||
|
||
This tool has a more extensive example usage documented in a Jupyter notebook [here](https://github.com/emptycrown/llama-hub/tree/main/llama_hub/tools/notebooks/tavily.ipynb) | ||
|
||
Here's an example usage of the TavilyToolSpec. | ||
|
||
```python | ||
from llama_hub.tools.tavily_research import TavilyToolSpec | ||
from llama_index.agent import OpenAIAgent | ||
|
||
tavily_tool = TavilyToolSpec( | ||
api_key='your-key', | ||
) | ||
agent = OpenAIAgent.from_tools(tavily_tool.to_tool_list()) | ||
|
||
agent.chat('What happened in the latest Burning Man festival?') | ||
``` | ||
|
||
`search`: Search for relevant dynamic data based on a query. Returns a list of urls and their relevant content. | ||
|
||
|
||
This loader is designed to be used as a way to load data as a Tool in an Agent. See [here](https://github.com/emptycrown/llama-hub/tree/main) for examples. |
2 changes: 1 addition & 1 deletion
2
llama_hub/tools/tavily/__init__.py → llama_hub/tools/tavily_research/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.