Package Information
Downloads: 150 weekly / 150 monthly
Latest Version: 1.0.1
Author: RAG System
Documentation
n8n RAG Knowledge Base Node
Node customizado do n8n para integração simplificada com o sistema RAG Knowledge Base.
🚀 Instalação
⭐ Instalação via npm (RECOMENDADO - Mais Fácil!)
cd ~/.n8n/custom
npm install @rag-system/n8n-nodes-rag
Depois, reinicie o n8n. Pronto! ✅
Opção 2: Instalação manual (se npm não funcionar)
- Clone este repositório
- Execute
npm installna pastan8n-node-rag - Execute
npm run build - Copie a pasta
n8n-node-ragpara a pastacustomdo seu n8n
📖 Como Usar
1. Configurar Credenciais
- No n8n, vá em Credentials → Add Credential
- Procure por "RAG API"
- Preencha:
- API URL: URL da sua instalação (ex:
https://seu-app.easypanel.host) - API Key: Sua chave API (começa com
sk_)
- API URL: URL da sua instalação (ex:
- Clique em Test para verificar a conexão
- Salve as credenciais
2. Adicionar o Node
- No seu workflow, clique em + para adicionar um node
- Procure por "RAG Knowledge Base"
- Arraste o node para o canvas
3. Operações Disponíveis
Query Knowledge Base (Consultar Base de Conhecimento)
- Knowledge Base: Dropdown que lista automaticamente suas bases ativas
- Query: Sua pergunta ou busca
- Top K Results: Número de resultados (1-20, padrão: 5)
Saída:
{
"answer": "Resposta da IA baseada nos documentos...",
"sources": [
{
"documentId": 123,
"chunkId": 456,
"content": "Trecho relevante...",
"similarity": 0.92
}
],
"knowledgeBase": {
"id": 1,
"name": "Minha Base"
}
}
List Knowledge Bases (Listar Bases)
Lista todas as bases de conhecimento disponíveis.
Saída:
{
"knowledgeBases": [
{
"id": 1,
"name": "Base 1",
"description": "Descrição...",
"isActive": true
}
],
"count": 1
}
🎯 Exemplos de Uso
Exemplo 1: Chatbot com RAG
Webhook → RAG Query → Respond to Webhook
Exemplo 2: Busca Automatizada
Schedule Trigger → RAG Query → Send Email
Exemplo 3: Integração com WhatsApp
WhatsApp Trigger → RAG Query → WhatsApp Send
🔧 Desenvolvimento
# Instalar dependências
npm install
# Compilar TypeScript
npm run build
# Modo desenvolvimento (watch)
npm run dev
# Lint
npm run lint
# Formatar código
npm run format
📝 Estrutura
n8n-node-rag/
├── credentials/ # Definição de credenciais
│ └── RAGApi.credentials.ts
├── nodes/ # Nodes customizados
│ └── RAG/
│ └── RAG.node.ts
├── package.json
├── tsconfig.json
└── README.md
🐛 Troubleshooting
Erro: "Invalid API key"
- Verifique se a API Key está correta
- Certifique-se de que a API Key está ativa no sistema RAG
Erro: "Knowledge base not found"
- Verifique se a base de conhecimento está ativa
- Certifique-se de que você tem permissão para acessar a base
Dropdown de bases vazio
- Verifique se você tem bases de conhecimento criadas
- Certifique-se de que pelo menos uma base está ativa
- Verifique a conexão com a API
📄 Licença
MIT
🤝 Contribuindo
Contribuições são bem-vindas! Por favor, abra uma issue ou pull request.