llama-index-tools-tavily-research


Namellama-index-tools-tavily-research JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
Summaryllama-index tools tavily_research integration
upload_time2024-08-22 03:24:47
maintainerrotemweiss57
docs_urlNone
authorYour Name
requires_python<4.0,>=3.8.1
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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/run-llama/llama_index/blob/main/llama-index-integrations/tools/llama-index-tools-tavily-research/examples/tavily.ipynb)

Here's an example usage of the TavilyToolSpec.

```python
from llama_index.tools.tavily_research import TavilyToolSpec
from llama_index.agent.openai 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.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "llama-index-tools-tavily-research",
    "maintainer": "rotemweiss57",
    "docs_url": null,
    "requires_python": "<4.0,>=3.8.1",
    "maintainer_email": null,
    "keywords": null,
    "author": "Your Name",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/90/b0/5f5dbeef8d6856f5f4333d5f86596b1fc5c8a3dd05a1d1fcbca3de19603d/llama_index_tools_tavily_research-0.2.0.tar.gz",
    "platform": null,
    "description": "# Tavily Research Tool\n\n[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.\n\nTo begin, you need to obtain an API key on the [Tavily's developer dashboard](https://app.tavily.com/).\n\n## Why Choose Tavily Research API?\n\n1. **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!\n2. **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.\n3. **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.\n4. **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).\n5. **Transparent & Informative**: Our detailed documentation ensures you're never left in the dark. From setup basics to nuanced features, we've got you covered.\n\n## Usage\n\nThis tool has a more extensive example usage documented in a Jupyter notebook [here](https://github.com/run-llama/llama_index/blob/main/llama-index-integrations/tools/llama-index-tools-tavily-research/examples/tavily.ipynb)\n\nHere's an example usage of the TavilyToolSpec.\n\n```python\nfrom llama_index.tools.tavily_research import TavilyToolSpec\nfrom llama_index.agent.openai import OpenAIAgent\n\ntavily_tool = TavilyToolSpec(\n    api_key=\"your-key\",\n)\nagent = OpenAIAgent.from_tools(tavily_tool.to_tool_list())\n\nagent.chat(\"What happened in the latest Burning Man festival?\")\n```\n\n`search`: Search for relevant dynamic data based on a query. Returns a list of urls and their relevant content.\n\nThis loader is designed to be used as a way to load data as a Tool in an Agent.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "llama-index tools tavily_research integration",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "94a248805f84a0288a20e520295777e4d2c38dbb91531b9b6de036394a511cb3",
                "md5": "9ef94116cc69b0f7a856dca72d194fb0",
                "sha256": "af9cd72ae753ffd398e7fd41dc663fec2feab23d915250cda7eaba5260cef924"
            },
            "downloads": -1,
            "filename": "llama_index_tools_tavily_research-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9ef94116cc69b0f7a856dca72d194fb0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8.1",
            "size": 3342,
            "upload_time": "2024-08-22T03:24:46",
            "upload_time_iso_8601": "2024-08-22T03:24:46.277977Z",
            "url": "https://files.pythonhosted.org/packages/94/a2/48805f84a0288a20e520295777e4d2c38dbb91531b9b6de036394a511cb3/llama_index_tools_tavily_research-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "90b05f5dbeef8d6856f5f4333d5f86596b1fc5c8a3dd05a1d1fcbca3de19603d",
                "md5": "ce2992a5982ed0faeb4c8890fcd0ecd4",
                "sha256": "7b537cfb02cab34e67cf8ee370890c7b50fe55baa5e900e653622d275b74b960"
            },
            "downloads": -1,
            "filename": "llama_index_tools_tavily_research-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ce2992a5982ed0faeb4c8890fcd0ecd4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8.1",
            "size": 3093,
            "upload_time": "2024-08-22T03:24:47",
            "upload_time_iso_8601": "2024-08-22T03:24:47.657959Z",
            "url": "https://files.pythonhosted.org/packages/90/b0/5f5dbeef8d6856f5f4333d5f86596b1fc5c8a3dd05a1d1fcbca3de19603d/llama_index_tools_tavily_research-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-22 03:24:47",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-tools-tavily-research"
}
        
Elapsed time: 0.39019s