mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-08 15:48:29 +00:00
35 lines
1.5 KiB
Markdown
35 lines
1.5 KiB
Markdown
# MDXSearchTool
|
|
|
|
!!! note "Depend on OpenAI"
|
|
All RAG tools at the moment can only use openAI to generate embeddings, we are working on adding support for other providers.
|
|
|
|
!!! note "Experimental"
|
|
We are still working on improving tools, so there might be unexpected behavior or changes in the future.
|
|
|
|
## Description
|
|
The MDX Search Tool, a key component of the `crewai_tools` package, is designed for advanced market data extraction, offering invaluable support to researchers and analysts requiring immediate market insights in the AI sector. With its ability to interface with various data sources and tools, it streamlines the process of acquiring, reading, and organizing market data efficiently.
|
|
|
|
## Installation
|
|
To utilize the MDX Search Tool, ensure the `crewai_tools` package is installed. If not already present, install it using the following command:
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
## Example
|
|
Configuring and using the MDX Search Tool involves setting up environment variables and utilizing the tool within a crewAI project for market research. Here's a simple example:
|
|
|
|
```python
|
|
from crewai_tools import MDXSearchTool
|
|
|
|
# Initialize the tool so the agent can search any MDX content if it learns about during its execution
|
|
tool = MDXSearchTool()
|
|
|
|
# OR
|
|
|
|
# Initialize the tool with a specific MDX file path for exclusive search within that document
|
|
tool = MDXSearchTool(mdx='path/to/your/document.mdx')
|
|
```
|
|
|
|
## Arguments
|
|
- mdx: **Optional** The MDX path for the search. Can be provided at initialization |