mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-09 08:08:32 +00:00
7fd8850ddb
* mentioning ollama on the docs as embedder * lowering barrier to match tool with simialr name * Fixing agent tools to support co_worker * Adding new tests * Fixing type" * updating tests * fixing conflict
62 lines
2.3 KiB
Markdown
62 lines
2.3 KiB
Markdown
# MDXSearchTool
|
|
|
|
!!! note "Experimental"
|
|
The MDXSearchTool is in continuous development. Features may be added or removed, and functionality could change unpredictably as we refine the tool.
|
|
|
|
## Description
|
|
The MDX Search Tool is a component of the `crewai_tools` package aimed at facilitating advanced market data extraction. This tool is invaluable for researchers and analysts seeking quick access to market insights, especially within the AI sector. It simplifies the task of acquiring, interpreting, and organizing market data by interfacing with various data sources.
|
|
|
|
## Installation
|
|
Before using the MDX Search Tool, ensure the `crewai_tools` package is installed. If it is not, you can install it with the following command:
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
## Usage Example
|
|
To use the MDX Search Tool, you must first set up the necessary environment variables. Then, integrate the tool into your crewAI project to begin your market research. Below is a basic example of how to do this:
|
|
|
|
```python
|
|
from crewai_tools import MDXSearchTool
|
|
|
|
# Initialize the tool to search any MDX content it learns about during execution
|
|
tool = MDXSearchTool()
|
|
|
|
# OR
|
|
|
|
# Initialize the tool with a specific MDX file path for an exclusive search within that document
|
|
tool = MDXSearchTool(mdx='path/to/your/document.mdx')
|
|
```
|
|
|
|
## Parameters
|
|
- mdx: **Optional**. Specifies the MDX file path for the search. It can be provided during initialization.
|
|
|
|
## Customization of Model and Embeddings
|
|
|
|
The tool defaults to using OpenAI for embeddings and summarization. For customization, utilize a configuration dictionary as shown below:
|
|
|
|
```python
|
|
tool = MDXSearchTool(
|
|
config=dict(
|
|
llm=dict(
|
|
provider="ollama", # Options include google, openai, anthropic, llama2, etc.
|
|
config=dict(
|
|
model="llama2",
|
|
# Optional parameters can be included here.
|
|
# temperature=0.5,
|
|
# top_p=1,
|
|
# stream=true,
|
|
),
|
|
),
|
|
embedder=dict(
|
|
provider="google", # or openai, ollama, ...
|
|
config=dict(
|
|
model="models/embedding-001",
|
|
task_type="retrieval_document",
|
|
# Optional title for the embeddings can be added here.
|
|
# title="Embeddings",
|
|
),
|
|
),
|
|
)
|
|
)
|
|
``` |