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
95 lines
3.7 KiB
Plaintext
95 lines
3.7 KiB
Plaintext
---
|
|
title: Pesquisa TXT RAG
|
|
description: O `TXTSearchTool` foi projetado para realizar uma busca RAG (Geração Aumentada por Recuperação) dentro do conteúdo de um arquivo de texto.
|
|
icon: file-lines
|
|
mode: "wide"
|
|
---
|
|
|
|
## Visão Geral
|
|
|
|
<Note>
|
|
Ainda estamos trabalhando para melhorar as ferramentas, por isso pode haver comportamentos inesperados ou mudanças no futuro.
|
|
</Note>
|
|
|
|
Esta ferramenta é utilizada para realizar uma busca RAG (Geração Aumentada por Recuperação) dentro do conteúdo de um arquivo de texto.
|
|
Ela permite uma busca semântica de uma consulta dentro do conteúdo de um arquivo de texto especificado,
|
|
tornando-se um recurso valioso para extrair rapidamente informações ou encontrar seções específicas do texto com base na consulta fornecida.
|
|
|
|
## Instalação
|
|
|
|
Para usar o `TXTSearchTool`, primeiro é necessário instalar o pacote `crewai_tools`.
|
|
Isso pode ser feito usando o pip, um gerenciador de pacotes para Python.
|
|
Abra seu terminal ou prompt de comando e digite o seguinte comando:
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
Este comando fará o download e instalará o TXTSearchTool junto com todas as dependências necessárias.
|
|
|
|
## Exemplo
|
|
|
|
O exemplo a seguir demonstra como usar o TXTSearchTool para pesquisar dentro de um arquivo de texto.
|
|
Este exemplo mostra tanto a inicialização da ferramenta com um arquivo de texto específico quanto a pesquisa subsequente dentro do conteúdo desse arquivo.
|
|
|
|
```python Code
|
|
from crewai_tools import TXTSearchTool
|
|
|
|
# Inicialize a ferramenta para pesquisar no conteúdo de qualquer arquivo de texto
|
|
# que o agente aprender durante sua execução
|
|
tool = TXTSearchTool()
|
|
|
|
# OU
|
|
|
|
# Inicialize a ferramenta com um arquivo de texto específico,
|
|
# para que o agente possa pesquisar dentro do conteúdo desse arquivo de texto
|
|
tool = TXTSearchTool(txt='path/to/text/file.txt')
|
|
```
|
|
|
|
## Argumentos
|
|
- `txt` (str): **Opcional**. O caminho para o arquivo de texto que você deseja pesquisar.
|
|
Este argumento só é necessário se a ferramenta não foi inicializada com um arquivo de texto específico;
|
|
caso contrário, a pesquisa será realizada no arquivo de texto fornecido inicialmente.
|
|
|
|
## Modelo e embeddings personalizados
|
|
|
|
Por padrão, a ferramenta utiliza o OpenAI tanto para embeddings quanto para sumarização.
|
|
Para personalizar o modelo, você pode usar um dicionário de configuração como o exemplo a seguir:
|
|
|
|
```python Code
|
|
from chromadb.config import Settings
|
|
|
|
tool = TXTSearchTool(
|
|
config={
|
|
# Obrigatório: provedor de embeddings + configuração
|
|
"embedding_model": {
|
|
"provider": "openai", # ou google-generativeai, cohere, ollama, ...
|
|
"config": {
|
|
"model": "text-embedding-3-small",
|
|
# "api_key": "sk-...", # opcional se variável de ambiente estiver definida
|
|
# Exemplos por provedor:
|
|
# Google → model: "models/embedding-001", task_type: "retrieval_document"
|
|
},
|
|
},
|
|
|
|
# Obrigatório: configuração do banco vetorial
|
|
"vectordb": {
|
|
"provider": "chromadb", # ou "qdrant"
|
|
"config": {
|
|
# Configurações do Chroma (persistência opcional)
|
|
# "settings": Settings(
|
|
# persist_directory="/content/chroma",
|
|
# allow_reset=True,
|
|
# is_persistent=True,
|
|
# ),
|
|
|
|
# Exemplo de parâmetros de vetor do Qdrant:
|
|
# from qdrant_client.models import VectorParams, Distance
|
|
# "vectors_config": VectorParams(size=384, distance=Distance.COSINE),
|
|
|
|
# Observação: o nome da coleção é controlado pela ferramenta (padrão: "rag_tool_collection").
|
|
}
|
|
},
|
|
}
|
|
)
|
|
``` |