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
78 lines
2.9 KiB
Plaintext
78 lines
2.9 KiB
Plaintext
---
|
|
title: Busca RAG em XML
|
|
description: O `XMLSearchTool` foi projetado para realizar uma busca RAG (Geração Aumentada por Recuperação) dentro do conteúdo de um arquivo XML.
|
|
icon: file-xml
|
|
mode: "wide"
|
|
---
|
|
|
|
# `XMLSearchTool`
|
|
|
|
<Note>
|
|
Ainda estamos trabalhando na melhoria das ferramentas, então pode haver comportamentos inesperados ou mudanças no futuro.
|
|
</Note>
|
|
|
|
## Descrição
|
|
|
|
O XMLSearchTool é uma ferramenta RAG de ponta, desenvolvida para realizar buscas semânticas em arquivos XML.
|
|
Ideal para usuários que precisam analisar e extrair informações do conteúdo XML de forma eficiente, esta ferramenta permite inserir uma consulta de busca e um caminho opcional para o arquivo XML.
|
|
Ao especificar um caminho de arquivo XML, o usuário pode direcionar sua busca de forma mais precisa ao conteúdo daquele arquivo, obtendo assim resultados mais relevantes.
|
|
|
|
## Instalação
|
|
|
|
Para começar a usar o XMLSearchTool, é necessário instalar primeiro o pacote crewai_tools. Isso pode ser feito facilmente com o seguinte comando:
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
## Exemplo
|
|
|
|
Aqui estão dois exemplos demonstrando como usar o XMLSearchTool.
|
|
O primeiro exemplo mostra a busca dentro de um arquivo XML específico, enquanto o segundo exemplo ilustra como iniciar uma busca sem definir previamente um caminho XML, oferecendo flexibilidade no escopo da busca.
|
|
|
|
```python Code
|
|
from crewai_tools import XMLSearchTool
|
|
|
|
# Permite que agentes busquem no conteúdo de qualquer arquivo XML
|
|
# conforme aprendem seus caminhos durante a execução
|
|
tool = XMLSearchTool()
|
|
|
|
# OU
|
|
|
|
# Inicializa a ferramenta com um caminho específico para arquivo XML
|
|
# para busca exclusiva dentro desse documento
|
|
tool = XMLSearchTool(xml='path/to/your/xmlfile.xml')
|
|
```
|
|
|
|
## Argumentos
|
|
|
|
- `xml`: Este é o caminho para o arquivo XML que você deseja buscar.
|
|
Este parâmetro é opcional durante a inicialização da ferramenta, mas deve ser fornecido ou na inicialização ou como parte dos argumentos do método `run` para executar a busca.
|
|
|
|
## Modelo customizado e embeddings
|
|
|
|
Por padrão, a ferramenta utiliza a OpenAI tanto para embeddings quanto para sumarização. Para personalizar o modelo, você pode usar um dicionário de configuração conforme o exemplo a seguir:
|
|
|
|
```python Code
|
|
from chromadb.config import Settings
|
|
|
|
tool = XMLSearchTool(
|
|
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),
|
|
}
|
|
},
|
|
}
|
|
)
|
|
``` |