Skip to content

Latest commit

 

History

History
234 lines (201 loc) · 8.57 KB

README_ptbr.md

File metadata and controls

234 lines (201 loc) · 8.57 KB

🗓️ ChatPDF AI Powered Document Interaction

🎉 Bem-vindo ao ChatPDF AI Powered Document Interaction! Este sistema foi projetado para permitir que os usuários interajam com seus documentos PDF de forma intuitiva e eficiente. Com o uso da tecnologia de geração de linguagem aumentada por recuperação (RAG), o ChatPDF facilita a consulta ao conteúdo dos PDFs, extraindo informações, resumindo textos e aprimorando a acessibilidade dos documentos. Basta carregar um PDF e começar a conversar com ele usando linguagem natural, tornando a extração e o gerenciamento de informações mais fáceis e rápidos.

Demonstração do ChatBot

Demonstração do ChatBot

📑 Sumário

🎯 Objetivos do Projeto

O principal objetivo do ChatPDF AI Powered Document Interaction é simplificar e otimizar a interação com documentos PDF, garantindo uma experiência personalizada e eficiente. Ele visa:

  • Facilitar a consulta ao conteúdo de PDFs carregados pelos usuários.
  • Simplificar a extração e o resumo de informações dos documentos.
  • Oferecer uma interface fácil de usar para melhorar a acessibilidade e a usabilidade dos PDFs.

🔍 Funcionalidades Principais

  • Interação com PDFs: O ChatPDF guia o usuário na consulta e interação com o conteúdo dos documentos PDF.
  • Consulta Dinâmica de Dados: Utiliza RAG para fornecer respostas precisas e contextuais baseadas no conteúdo do PDF.
  • Interface Amigável: Desenvolvido para uma experiência de usuário suave e acessível, facilitando a navegação e a utilização das funcionalidades.

🛠️ Tecnologias Utilizadas️

  • Python: Linguagem principal de programação.
  • LangChain: Para a lógica de conversação e processamento de linguagem natural.
  • Hugging Face Embeddings e FAISS: Para o armazenamento e recuperação eficiente de informações.
  • Streamlit: Para criação da interface do usuário.
  • API da Groq e Llama3-70b-8192: Para o processamento de alto desempenho e modelagem de linguagem de grande escala.
  • LangSmith (Opcional): Para rastrear e avaliar a qualidade da conversa.

📁 Estrutura do Projeto

O projeto está organizado da seguinte maneira:

  • .streamlit/: Contém arquivos de configuração do Streamlit.
  • config/: Contém arquivos de configuração, como variáveis de ambiente.
  • data/: Dados e arquivos de armazenamento.
  • docs/: Documentação relevante e guias de usuário.
  • notebooks/: Com arquivos Jupyter Notebook para análises e experimentos.
  • prints/: Capturas de tela da aplicação.
  • scripts/: Scripts auxiliares para tarefas específicas.
  • src/: Código-fonte da aplicação.
  • venv/: Ambiente virtual Python.
  • .gitignore: Arquivo de configuração do Git.
  • LICENSE: Licença do projeto.
  • README_ptbr.md: README em português.
  • README.md: README em inglês.
  • requirements.txt: Lista de dependências do projeto.
  • setup.bat: Script para instalar dependências e executar o chatbot no Windows.
  • setup.sh: Script para instalar dependências e executar o chatbot no Linux.
chatpdf-ai-powered-document-interaction/
├── .streamlit/
├── config/
│   ├── .env
│   └── .env.example
├── docs/
│   ├── commits_pattern_ptbr.md
│   └── commits_pattern.md
├── notebooks/
│   └── dependecies_list.ipynb
├── prints/
│   ├── chatbot_1.png
│   └── chatbot_2.png
├── src/
│   ├── assets/
│   |   ├── favicon.ico
|   |   └── vertical_logo.png
│   ├── static/
│   |   ├── ai_profile_photo.png
│   |   └── human_profile_photo.png
│   ├── app.py
│   ├── functions.py
│   ├── html_templates.py
│   └── models.py
├── venv/
├── .gitignore
├── LICENSE
├── README_ptbr.md
├── README.md
├── requirements.txt
├── setup.bat
└── setup.sh

🚀 Executando o Projeto

No Linux (Método 1):

Para executar o chatbot localmente, siga os passos abaixo:

  1. Clone o repositório: 
    git clone https://github.com/BrunoTanabe/chatpdf-ai-powered-document-interaction.git
  2. Acesse o diretório do projeto: 
    cd chatpdf-ai-powered-document-interaction
  3. Instale o pip e venv, caso ainda não estejam instalados: 
    sudo apt-get update && sudo apt-get install python3-pip python3-venv
  4. Crie um ambiente virtual: 
    python3 -m venv venv
  5. Ative o ambiente virtual: 
    source venv/bin/activate
  6. Instale as dependências: 
    pip install -r requirements.txt
  7. Execute o Streamlit: 
    python3 -m streamlit run src/app.py

NOTA: Execute os comandos acima na pasta principal do projeto.

No Linux (Método 2):

Execute o script setup.sh para instalar as dependências e executar o chatbot:

  1. Clone o repositório: 
    git clone https://github.com/BrunoTanabe/chatpdf-ai-powered-document-interaction.git
  2. Acesse o diretório do projeto: 
    cd chatpdf-ai-powered-document-interaction
  3. Dê permissão de execução ao script: 
    chmod +x setup.sh
  4. Execute o script: 
    ./setup.sh

NOTA: Execute os comandos acima na pasta principal do projeto.

No Windows (Método 1):

Para executar o chatbot localmente, siga os passos abaixo:

  1. Clone o repositório: 
    git clone https://github.com/BrunoTanabe/chatpdf-ai-powered-document-interaction.git
  2. Acesse o diretório do projeto: 
    cd chatpdf-ai-powered-document-interaction
  3. Instale o pip e venv, caso ainda não estejam instalados: 
    python -m ensurepip --upgrade
  4. Crie um ambiente virtual: 
    python -m venv venv
  5. Ative o ambiente virtual: 
    venv\Scripts\activate
  6. Instale as dependências: 
    pip install -r requirements.txt
  7. Execute o Streamlit: 
    python -m streamlit run src/app.py

NOTA: Execute os comandos acima na pasta principal do projeto.

No Windows (Método 2):

Execute o script setup.bat para instalar as dependências e executar o chatbot:

  1. Clone o repositório: 
    git clone https://github.com/BrunoTanabe/chatpdf-ai-powered-document-interaction.git
  2. Acesse o diretório do projeto: 
    cd chatpdf-ai-powered-document-interaction
  3. Execute o script: 
    setup.bat

NOTA: Execute os comandos acima na pasta principal do projeto.

🌟 Próximos Passos

  • Atualmente, a variável que recebe a resposta do llm recebe recebe chunk a chunk da mensagem, no entanto, ela só é exibe a resposta quando está completa, para melhorar a experiência do usuário, seria interessante exibir a resposta chunk a chunk.
  • Atualmente, o usuário pode mandar uma nova mensagem enquanto o modelo ainda está respondendo a solicitação anterior, isso normalmente quebra a aplicação, seria interessante implementar um mecanismo que impeça o usuário de mandar uma nova mensagem enquanto o modelo ainda está respondendo a solicitação anterior.

❗ Nota Importante

  • O app é executado em localhost:8501, mas você pode alterar a porta no arquivo .streamlit/config.toml.

📜 Licença

Distribuído sob a licença MIT. Veja LICENSE para mais informações.

🤝 Como Contribuir

Contribuições são o que fazem a comunidade open source um lugar incrível para aprender, inspirar e criar. Quaisquer contribuições que você fizer são muito apreciadas.

  1. Faça um Fork do projeto
  2. Crie sua Feature Branch (git checkout -b feature/NovaFeature)
  3. Faça commit de suas mudanças (git commit -m 'Add some NovaFeature')
  4. Push para a Branch (git push origin feature/novaFeature)
  5. Abra um Pull Request

📬 Autor e Contato

Espero que você aproveite a utilização do ChatPDF! Para qualquer dúvida ou sugestão, não hesite em entrar em contato. 🚀