mirror of
https://github.com/crewAIInc/crewAI.git
synced 2025-12-16 04:18:35 +00:00
410db1ff39
Some checks failed
* docs(tools): migrate embedder->embedding_model, require vectordb; add Chroma/Qdrant examples across en/ko/pt-BR PDF/TXT/XML/MDX/DOCX/CSV/Directory docs * docs(observability): apply latest Datadog tweaks in ko and pt-BR
72 lines
2.7 KiB
Plaintext
72 lines
2.7 KiB
Plaintext
---
|
|
title: Pesquisa MDX RAG
|
|
description: O `MDXSearchTool` foi projetado para pesquisar arquivos MDX e retornar os resultados mais relevantes.
|
|
icon: markdown
|
|
mode: "wide"
|
|
---
|
|
|
|
# `MDXSearchTool`
|
|
|
|
<Note>
|
|
O MDXSearchTool está em desenvolvimento contínuo. Recursos podem ser adicionados ou removidos, e a funcionalidade pode mudar de forma imprevisível à medida que refinamos a ferramenta.
|
|
</Note>
|
|
|
|
## Descrição
|
|
|
|
A Ferramenta de Pesquisa MDX é um componente do pacote `crewai_tools` focado em facilitar a extração avançada de dados do markdown. Ela permite que usuários pesquisem e extraiam informações relevantes de arquivos MD utilizando buscas baseadas em consulta. Esta ferramenta é indispensável para análise de dados, gestão de informações e tarefas de pesquisa, agilizando o processo de encontrar informações específicas em grandes coleções de documentos.
|
|
|
|
## Instalação
|
|
|
|
Antes de utilizar a Ferramenta de Pesquisa MDX, certifique-se de que o pacote `crewai_tools` está instalado. Caso não esteja, você pode instalá-lo com o comando abaixo:
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
## Exemplo de Uso
|
|
|
|
Para utilizar a Ferramenta de Pesquisa MDX, primeiro defina as variáveis de ambiente necessárias. Em seguida, integre a ferramenta ao seu projeto crewAI para começar sua pesquisa de mercado. Veja abaixo um exemplo básico de como fazer isso:
|
|
|
|
```python Code
|
|
from crewai_tools import MDXSearchTool
|
|
|
|
# Inicialize a ferramenta para pesquisar qualquer conteúdo MDX que ela conheça durante a execução
|
|
tool = MDXSearchTool()
|
|
|
|
# OU
|
|
|
|
# Inicialize a ferramenta com um caminho específico para o arquivo MDX, realizando buscas exclusivamente neste documento
|
|
tool = MDXSearchTool(mdx='path/to/your/document.mdx')
|
|
```
|
|
|
|
## Parâmetros
|
|
|
|
- mdx: **Opcional**. Especifica o caminho do arquivo MDX para pesquisa. Pode ser informado durante a inicialização.
|
|
|
|
## Personalização do Modelo e Embeddings
|
|
|
|
A ferramenta utiliza, por padrão, o OpenAI para embeddings e sumarização. Para personalizar, utilize um dicionário de configuração conforme exemplo abaixo:
|
|
|
|
```python Code
|
|
from chromadb.config import Settings
|
|
|
|
tool = MDXSearchTool(
|
|
config={
|
|
"embedding_model": {
|
|
"provider": "openai",
|
|
"config": {
|
|
"model": "text-embedding-3-small",
|
|
# "api_key": "sk-...",
|
|
},
|
|
},
|
|
"vectordb": {
|
|
"provider": "chromadb", # ou "qdrant"
|
|
"config": {
|
|
# "settings": Settings(persist_directory="/content/chroma", allow_reset=True, is_persistent=True),
|
|
# from qdrant_client.models import VectorParams, Distance
|
|
# "vectors_config": VectorParams(size=384, distance=Distance.COSINE),
|
|
}
|
|
},
|
|
}
|
|
)
|
|
``` |