mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-10 00:28:31 +00:00
renaming exa tool
This commit is contained in:
@@ -6,6 +6,7 @@ from .tools import (
|
|||||||
DirectorySearchTool,
|
DirectorySearchTool,
|
||||||
DOCXSearchTool,
|
DOCXSearchTool,
|
||||||
DirectoryReadTool,
|
DirectoryReadTool,
|
||||||
|
EXASearchTool,
|
||||||
FileReadTool,
|
FileReadTool,
|
||||||
GithubSearchTool,
|
GithubSearchTool,
|
||||||
SerperDevTool,
|
SerperDevTool,
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ from .csv_search_tool.csv_search_tool import CSVSearchTool
|
|||||||
from .directory_search_tool.directory_search_tool import DirectorySearchTool
|
from .directory_search_tool.directory_search_tool import DirectorySearchTool
|
||||||
from .directory_read_tool.directory_read_tool import DirectoryReadTool
|
from .directory_read_tool.directory_read_tool import DirectoryReadTool
|
||||||
from .docx_search_tool.docx_search_tool import DOCXSearchTool
|
from .docx_search_tool.docx_search_tool import DOCXSearchTool
|
||||||
|
from .exa_tools.exa_search_tool import EXASearchTool
|
||||||
from .file_read_tool.file_read_tool import FileReadTool
|
from .file_read_tool.file_read_tool import FileReadTool
|
||||||
from .github_search_tool.github_search_tool import GithubSearchTool
|
from .github_search_tool.github_search_tool import GithubSearchTool
|
||||||
from .serper_dev_tool.serper_dev_tool import SerperDevTool
|
from .serper_dev_tool.serper_dev_tool import SerperDevTool
|
||||||
|
|||||||
30
src/crewai_tools/tools/exa_tools/README.md
Normal file
30
src/crewai_tools/tools/exa_tools/README.md
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
# EXASearchTool Documentation
|
||||||
|
|
||||||
|
## Description
|
||||||
|
This tool is designed to perform a semantic search for a specified query from a text's content across the internet. It utilizes the `https://exa.ai/` API to fetch and display the most relevant search results based on the query provided by the user.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
To incorporate this tool into your project, follow the installation instructions below:
|
||||||
|
```shell
|
||||||
|
pip install 'crewai[tools]'
|
||||||
|
```
|
||||||
|
|
||||||
|
## Example
|
||||||
|
The following example demonstrates how to initialize the tool and execute a search with a given query:
|
||||||
|
|
||||||
|
```python
|
||||||
|
from crewai_tools import EXASearchTool
|
||||||
|
|
||||||
|
# Initialize the tool for internet searching capabilities
|
||||||
|
tool = EXASearchTool()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Steps to Get Started
|
||||||
|
To effectively use the `EXASearchTool`, follow these steps:
|
||||||
|
|
||||||
|
1. **Package Installation**: Confirm that the `crewai[tools]` package is installed in your Python environment.
|
||||||
|
2. **API Key Acquisition**: Acquire a `https://exa.ai/` API key by registering for a free account at `https://exa.ai/`.
|
||||||
|
3. **Environment Configuration**: Store your obtained API key in an environment variable named `EXA_API_KEY` to facilitate its use by the tool.
|
||||||
|
|
||||||
|
## Conclusion
|
||||||
|
By integrating the `EXASearchTool` into Python projects, users gain the ability to conduct real-time, relevant searches across the internet directly from their applications. By adhering to the setup and usage guidelines provided, incorporating this tool into projects is streamlined and straightforward.
|
||||||
@@ -3,7 +3,7 @@ from typing import Any
|
|||||||
|
|
||||||
from .exa_base_tool import EXABaseTool
|
from .exa_base_tool import EXABaseTool
|
||||||
|
|
||||||
class EXAURLTool(EXABaseTool):
|
class EXASearchTool(EXABaseTool):
|
||||||
def _run(
|
def _run(
|
||||||
self,
|
self,
|
||||||
**kwargs: Any,
|
**kwargs: Any,
|
||||||
Reference in New Issue
Block a user