Skip to content

Chatbot de inteligência artificial para suporte à pesquisa acadêmica, projetado para trabalhar com cofres do Obsidian.

License

Notifications You must be signed in to change notification settings

germanocastanho/oraculo-delfos

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Oráculo de Delfos 📖

Projetado para pesquisadores, estudantes e entusiastas, o Oráculo é uma ferramenta poderosa e intuitiva que transforma documentos Markdown em conhecimento acionável. Com tecnologias avançadas de inteligência artificial generativa, ele processa, resume e recupera informações relevantes com rapidez e precisão. Totalmente compatível com ferramentas como o Obsidian, o Oráculo proporciona uma experiência fluida, transformando diretórios de arquivos .md em cofres de conhecimento acessível, enquanto você explora suas ideias. ✨

🛠️ Funcionalidades Principais

  • Pesquisa Avançada 🔍: Recupere informações relevantes em segundos, utilizando índices vetoriais e modelos de linguagem de última geração.
  • Personalização Flexível 🛠️: Configure o modelo de IA, insira sua chave API e escolha o diretório de trabalho conforme suas necessidades.
  • Conversa Inteligente 💬: Receba respostas detalhadas e contextuais baseadas no conteúdo de seus arquivos, com suporte a histórico de interação.
  • Integração Simplificada 🤝: Compatível com ferramentas como o Obsidian, permitindo o uso direto de diretórios sem configurações complexas.
  • Interface Amigável 🎨: Design acessível e responsivo em Streamlit, pensado para todos os tipos de usuários.

📋 Pré-requisitos e Instalação

Pré-requisitos

Antes de começar, certifique-se de ter:

  • Python 3.12+ 🐍: Versão mínima recomendada para compatibilidade com as dependências do projeto.
  • Chave API 🔑: Necessária para acessar os modelos de GenAI, como ChatGPT-4o (OpenAI) ou Llama 3.3 (Groq).
  • Bibliotecas 📚: Dependências listadas no arquivo requirements.txt, que incluem ferramentas LangChain e FAISS.

Instalação

  1. Clone o repositório:
    git clone https://github.com/germanocastanho/oraculo-delfos.git
  2. Navegue até o diretório:
    cd oraculo-delfos/
  3. (Opcional) Crie um VENV:
  • Linux/macOS:

    python3 -m venv .venv
    source .venv/bin/activate
  • Windows:

    python -m venv .venv
    .venv\Scripts\activate
  1. Instale as dependências:
    pip install -r requirements.txt
  2. Execute o Oráculo:
    streamlit run app.py

🚀 Configuração e Utilização

Configurar suas Preferências

  • Escolha o modelo de IA (ChatGPT-4o ou Llama 3.3) e insira a chave API (OpenAI ou Groq, respectivamente).
  • Forneça o diretório contendo seus arquivos .md, seja do Obsidian, seja de outro software compatível.

Utilizar o Oráculo

  • Utilize a interface de chat para enviar perguntas relacionadas ao conteúdo dos seus documentos.
  • Obtenha resumos e insights, economizando tempo com a análise automatizada de grandes volumes de texto.

Exemplo Prático de Uso

Veja como o Oráculo transforma sua pesquisa acadêmica com um exemplo. Imagine que você possui um diretório com anotações acadêmicas sobre filosofia política ou qualquer outro tema. Basta carregar esse diretório, e o Oráculo estará pronto para responder questões como:

  • "Quais são as principais ideias de Rousseau sobre o contrato social?"
  • "Resuma as diferenças entre Hobbes e Locke em relação ao estado de natureza."
  • "Quais são os principais argumentos críticos ao capitalismo em Marx?"

🗂️ Arquitetura do Projeto

oraculo-delfos/
|-- interface/           # Módulos da interface do usuário
|-- logica/              # Lógica principal e modelos de IA
|-- app.py               # Script para iniciar a aplicação
|-- LICENSE              # Arquivo de licença (GPL-3.0)
|-- poetry.lock          # Bloqueio de dependências do Poetry
|-- pyproject.toml       # Metadados e configurações do Poetry
|-- README.md            # Documentação do projeto
|-- requirements.txt     # Dependências do Python

⚙️ Detalhes Técnicos

  1. Modelos de GenAI: Suporte nativo para ChatGPT-4o e Llama 3.3, com uma arquitetura flexível que facilita a incorporação de novos modelos, garantindo adaptabilidade para diferentes contextos de uso.
  2. Sumarização e Indexação: Utiliza pipelines avançados com LangChain para processamento de texto, FAISS para buscas vetoriais otimizadas e embeddings da HuggingFace para representação semântica precisa.
  3. Memória Conversacional: Armazena o histórico de interações, permitindo respostas mais precisas e alinhadas ao contexto da conversa.
  4. Interface e Configuração: Desenvolvida com o Streamlit, a interface é intuitiva e responsiva. As preferências do usuário são armazenadas em JSON, garantindo continuidade entre sessões e facilidade de personalização.

🤝 Contribuições

Contribuições são sempre bem-vindas! Se deseja colaborar, siga boas práticas de programação e implemente melhorias. Faça um fork do repositório e implemente suas alterações. Envie um pull request com uma descrição clara do que foi feito. Caso encontre problemas ou tenha ideias, abra uma issue. Juntos, podemos tornar o Oráculo ainda mais incrível! 🚀

📜 Licença GPL-3.0

Distribuído sob a Licença Pública Geral GNU v3.0 (GPL-3.0), garantindo liberdade de uso, modificação e redistribuição do software, desde que os mesmos direitos sejam preservados em quaisquer versões derivadas. Ao utilizar ou contribuir com o projeto, você apoia a filosofia de software livre e a promoção de um ambiente colaborativo e aberto para inovação! 🔬

✉️ Créditos e Contato

  • Créditos: Copyleft 🄯, Germano Castanho, 2024
  • E-mail: [email protected]
  • Problemas?: Abra uma issue no repositório oficial.

Cada linha, um manifesto pela liberdade! ✊🏴

About

Chatbot de inteligência artificial para suporte à pesquisa acadêmica, projetado para trabalhar com cofres do Obsidian.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages