llama-index-tools-exa


Namellama-index-tools-exa JSON
Version 0.3.0 PyPI version JSON
download
home_pageNone
Summaryllama-index tools exa integration
upload_time2024-11-17 23:04:59
maintainerjeffzwang
docs_urlNone
authorYour Name
requires_python<4.0,>=3.9
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # LlamaIndex Tools Integration: Exa

This tool connects to [Exa](https://exa.ai/) to easily enable
your agent to search and get HTML content from the Internet.

To begin, you need to obtain an API key on the [Exa developer dashboard](https://dashboard.exa.ai).

## Usage

This tool has more a 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-exa/examples/exa.ipynb)

Here's an example usage of the ExaToolSpec.

```python
# %pip install llama-index llama-index-core llama-index-tools-exa

from llama_index.tools.exa import ExaToolSpec
from llama_index.agent.openai import OpenAIAgent

exa_tool = ExaToolSpec(
    api_key=os.environ["EXA_API_KEY"],
)
agent = OpenAIAgent.from_tools(exa_tool.to_tool_list())

agent.chat(
    "Can you summarize the news published in the last month on superconductors"
)
```

`search`: Search for a list of articles relating to a natural language query

`retrieve_documents`: Retrieve a list of documents returned from `exa_search`.

`search_and_retrieve_documents`: Combines search and retrieve_documents to directly return a list of documents related to a search

`find_similar`: Find similar documents to a given URL.

`current_date`: Utility for the Agent to get todays date

This loader is designed to be used as a way to load data as a Tool in a Agent.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "llama-index-tools-exa",
    "maintainer": "jeffzwang",
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Your Name",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/c1/77/d3b59a199c5f0e8127851e4d84ec95101cf9118e79dd2cfa7316caa75257/llama_index_tools_exa-0.3.0.tar.gz",
    "platform": null,
    "description": "# LlamaIndex Tools Integration: Exa\n\nThis tool connects to [Exa](https://exa.ai/) to easily enable\nyour agent to search and get HTML content from the Internet.\n\nTo begin, you need to obtain an API key on the [Exa developer dashboard](https://dashboard.exa.ai).\n\n## Usage\n\nThis tool has more a 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-exa/examples/exa.ipynb)\n\nHere's an example usage of the ExaToolSpec.\n\n```python\n# %pip install llama-index llama-index-core llama-index-tools-exa\n\nfrom llama_index.tools.exa import ExaToolSpec\nfrom llama_index.agent.openai import OpenAIAgent\n\nexa_tool = ExaToolSpec(\n    api_key=os.environ[\"EXA_API_KEY\"],\n)\nagent = OpenAIAgent.from_tools(exa_tool.to_tool_list())\n\nagent.chat(\n    \"Can you summarize the news published in the last month on superconductors\"\n)\n```\n\n`search`: Search for a list of articles relating to a natural language query\n\n`retrieve_documents`: Retrieve a list of documents returned from `exa_search`.\n\n`search_and_retrieve_documents`: Combines search and retrieve_documents to directly return a list of documents related to a search\n\n`find_similar`: Find similar documents to a given URL.\n\n`current_date`: Utility for the Agent to get todays date\n\nThis loader is designed to be used as a way to load data as a Tool in a Agent.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "llama-index tools exa integration",
    "version": "0.3.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a9b887271bf4bc96f2a57fd55b4fa8482d4970f259a4618a45bc2b9fbd70afab",
                "md5": "764f3e74b47c57efc03b4310e053e7f5",
                "sha256": "f428c1c86f78cd2a107a6a23c601ab13eda5a3c540b85a02be12b132e0ccc78e"
            },
            "downloads": -1,
            "filename": "llama_index_tools_exa-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "764f3e74b47c57efc03b4310e053e7f5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 3606,
            "upload_time": "2024-11-17T23:04:57",
            "upload_time_iso_8601": "2024-11-17T23:04:57.577086Z",
            "url": "https://files.pythonhosted.org/packages/a9/b8/87271bf4bc96f2a57fd55b4fa8482d4970f259a4618a45bc2b9fbd70afab/llama_index_tools_exa-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c177d3b59a199c5f0e8127851e4d84ec95101cf9118e79dd2cfa7316caa75257",
                "md5": "d29af6af3bc109f2406cd96059e0e365",
                "sha256": "873f342352c5280d0c634052b5aba2d067473be6b9b35e722baad704a50972f5"
            },
            "downloads": -1,
            "filename": "llama_index_tools_exa-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d29af6af3bc109f2406cd96059e0e365",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 3390,
            "upload_time": "2024-11-17T23:04:59",
            "upload_time_iso_8601": "2024-11-17T23:04:59.159380Z",
            "url": "https://files.pythonhosted.org/packages/c1/77/d3b59a199c5f0e8127851e4d84ec95101cf9118e79dd2cfa7316caa75257/llama_index_tools_exa-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-17 23:04:59",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-tools-exa"
}
        
Elapsed time: 0.38703s