Spaces:
Build error
Build error
Fix YAML metadata with clean formatting
Browse files
README.md
CHANGED
|
@@ -9,4 +9,127 @@ app_file: app.py
|
|
| 9 |
pinned: false
|
| 10 |
license: mit
|
| 11 |
short_description: AI-powered document chat - Ask your files anything
|
| 12 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 9 |
pinned: false
|
| 10 |
license: mit
|
| 11 |
short_description: AI-powered document chat - Ask your files anything
|
| 12 |
+
---
|
| 13 |
+
|
| 14 |
+
# 🐆 Chat Cheetah
|
| 15 |
+
|
| 16 |
+
Chat Cheetah é uma aplicação web inteligente que permite interagir com seus documentos PDF através de um chat intuitivo. Utilizando o poder do Google Gemini Pro, a aplicação processa seus documentos e permite que você faça perguntas sobre seu conteúdo, obtendo respostas precisas e contextualizadas.
|
| 17 |
+
|
| 18 |
+
## 🌟 Funcionalidades
|
| 19 |
+
|
| 20 |
+
- 📤 Upload de múltiplos documentos PDF
|
| 21 |
+
- 📊 Processamento inteligente de documentos
|
| 22 |
+
- 💬 Interface de chat intuitiva
|
| 23 |
+
- 🔍 Análise profunda do conteúdo
|
| 24 |
+
- 📈 Estatísticas de processamento em tempo real
|
| 25 |
+
- 🎨 Design moderno e responsivo
|
| 26 |
+
|
| 27 |
+
## 🚀 Como Usar
|
| 28 |
+
|
| 29 |
+
1. **Upload de Documentos**
|
| 30 |
+
- Clique na área de upload ou arraste seus arquivos PDF
|
| 31 |
+
- Clique em "Processar Documentos"
|
| 32 |
+
- Aguarde o processamento ser concluído
|
| 33 |
+
|
| 34 |
+
2. **Faça Perguntas**
|
| 35 |
+
- Use a caixa de chat para fazer perguntas sobre seus documentos
|
| 36 |
+
- Receba respostas baseadas no conteúdo dos documentos
|
| 37 |
+
- O sistema mantém o contexto da conversa
|
| 38 |
+
|
| 39 |
+
3. **Visualize Estatísticas**
|
| 40 |
+
- Acompanhe o número de documentos processados
|
| 41 |
+
- Veja a quantidade de chunks gerados
|
| 42 |
+
- Monitore o status do processamento
|
| 43 |
+
|
| 44 |
+
## 💻 Tecnologias Utilizadas
|
| 45 |
+
|
| 46 |
+
- 🐍 Python
|
| 47 |
+
- 🎯 Gradio (Interface)
|
| 48 |
+
- 🧠 Google Gemini Pro (IA)
|
| 49 |
+
- 📄 PyPDF (Processamento de PDF)
|
| 50 |
+
- 🔄 LangChain (Processamento de Linguagem Natural)
|
| 51 |
+
|
| 52 |
+
## ⚙️ Configuração Local
|
| 53 |
+
|
| 54 |
+
1. Clone o repositório:
|
| 55 |
+
```bash
|
| 56 |
+
git clone https://github.com/YOUR_USERNAME/chat-cheetah.git
|
| 57 |
+
cd chat-cheetah
|
| 58 |
+
```
|
| 59 |
+
|
| 60 |
+
2. Crie um ambiente virtual:
|
| 61 |
+
```bash
|
| 62 |
+
conda create -n chat-cheetah python=3.10
|
| 63 |
+
conda activate chat-cheetah
|
| 64 |
+
```
|
| 65 |
+
|
| 66 |
+
3. Instale as dependências:
|
| 67 |
+
```bash
|
| 68 |
+
pip install -r requirements.txt
|
| 69 |
+
```
|
| 70 |
+
|
| 71 |
+
4. Configure a variável de ambiente:
|
| 72 |
+
```bash
|
| 73 |
+
export GOOGLE_API_KEY="sua_chave_api_aqui"
|
| 74 |
+
# ou no Windows
|
| 75 |
+
set GOOGLE_API_KEY="sua_chave_api_aqui"
|
| 76 |
+
```
|
| 77 |
+
|
| 78 |
+
5. Execute a aplicação:
|
| 79 |
+
```bash
|
| 80 |
+
python app.py
|
| 81 |
+
```
|
| 82 |
+
|
| 83 |
+
## 📋 Requisitos
|
| 84 |
+
|
| 85 |
+
- Python 3.10 ou superior
|
| 86 |
+
- Chave API do Google (Gemini Pro)
|
| 87 |
+
- Navegador web moderno
|
| 88 |
+
- Conexão com a internet
|
| 89 |
+
|
| 90 |
+
## 🔒 Privacidade e Segurança
|
| 91 |
+
|
| 92 |
+
- Os documentos são processados localmente
|
| 93 |
+
- Nenhum dado é armazenado permanentemente
|
| 94 |
+
- As informações são limvas ao fechar a aplicação
|
| 95 |
+
- Apenas o texto é extraído dos PDFs
|
| 96 |
+
|
| 97 |
+
## ⚡ Performance
|
| 98 |
+
|
| 99 |
+
- Processamento rápido de documentos
|
| 100 |
+
- Respostas em tempo real
|
| 101 |
+
- Suporte a documentos extensos
|
| 102 |
+
- Otimizado para uso em CPU
|
| 103 |
+
|
| 104 |
+
## 🤝 Contribuições
|
| 105 |
+
|
| 106 |
+
Contribuições são bem-vindas! Por favor, siga estes passos:
|
| 107 |
+
|
| 108 |
+
1. Fork o repositório
|
| 109 |
+
2. Crie uma branch para sua feature
|
| 110 |
+
3. Commit suas mudanças
|
| 111 |
+
4. Push para a branch
|
| 112 |
+
5. Abra um Pull Request
|
| 113 |
+
|
| 114 |
+
## 📝 Licença
|
| 115 |
+
|
| 116 |
+
Este projeto está sob a licença MIT. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.
|
| 117 |
+
|
| 118 |
+
## 👥 Autores
|
| 119 |
+
|
| 120 |
+
- Guilherme Favaron (https://www.guilhermefavaron.com.br)
|
| 121 |
+
|
| 122 |
+
## 📞 Suporte
|
| 123 |
+
|
| 124 |
+
- Abra uma issue no GitHub
|
| 125 |
+
- Envie um email para seu@email.com
|
| 126 |
+
|
| 127 |
+
## 🙏 Agradecimentos
|
| 128 |
+
|
| 129 |
+
- Google pela API do Gemini Pro
|
| 130 |
+
- Equipe Gradio pelo framework
|
| 131 |
+
- Comunidade Python
|
| 132 |
+
|
| 133 |
+
---
|
| 134 |
+
|
| 135 |
+
Desenvolvido com 🧡 pela comunidade
|