Skip to content

README_PT.md

Latest commit

 

History

History
422 lines (299 loc) · 13.7 KB

README_PT.md

File metadata and controls

422 lines (299 loc) · 13.7 KB

📰 Notícias

[2026.3.24] DeepTutor v1.0.0 chegou ✨ — evolução nativa de agentes: refactor leve, TutorBot e modos flexíveis sob Apache-2.0.

[2026.2.6] 🚀 10k estrelas em 39 dias — obrigado à comunidade!

[2026.1.1] Feliz Ano Novo! Junte-se ao Discord, WeChat ou Discussions.

[2025.12.29] DeepTutor é lançado oficialmente.

📦 Lançamentos

[2026.3.24] v1.0.0 — Refatoração nativa de agentes, integração flexível de ferramentas, entradas CLI e SDK, TutorBot com nanobot, Co-Writer, aprendizado guiado e memória persistente.

Lançamentos anteriores

[2026.1.23] v0.6.0 — Persistência de sessão, upload incremental, RAG flexível, localização em chinês.

[2026.1.18] v0.5.2 — Docling, logs, correções.

[2026.1.15] v0.5.0 — Config unificada, RAG por KB, geração de questões, barra lateral.

[2026.1.9] v0.4.0 — Multi-provedor LLM/embeddings, nova home, desacoplamento RAG, variáveis de ambiente.

[2026.1.5] v0.3.0 — PromptManager, CI/CD, imagens GHCR.

[2026.1.2] v0.2.0 — Docker, Next.js 16 e React 19, WebSocket, vulnerabilidades.

✨ Principais recursos

  • Workspace de chat unificado — Cinco modos, um fio: Chat, Deep Solve, quiz, Deep Research e Math Animator compartilham contexto.
  • TutorBots pessoais — Não são chatbots: tutores autônomos com espaço de trabalho, memória, personalidade e habilidades. nanobot.
  • AI Co-Writer — Markdown com IA como colaborador: reescrever, expandir ou encurtar com KB e web.
  • Aprendizado guiado — Jornadas visuais passo a passo a partir dos seus materiais.
  • Hub de conhecimento — PDF, Markdown e texto para bases RAG; cadernos coloridos.
  • Memória persistente — Resumo de progresso e perfil do aprendiz; compartilhado com TutorBots.
  • CLI nativo para agentes — Capacidades, KB, sessões e TutorBot em um comando; Rich e JSON. SKILL.md.

🚀 Começar

Opção A — Tour de configuração (recomendado)

Script interativo: dependências, ambiente, testes de conexão e inicialização.

git clone https://github.com/HKUDS/DeepTutor.git
cd DeepTutor

conda create -n deeptutor python=3.11 && conda activate deeptutor
# ou: python -m venv .venv && source .venv/bin/activate

python scripts/start_tour.py
  • Modo web — Perfil, pip + npm, servidor temporário, página Configurações, tour em 4 passos.
  • Modo CLI — Tudo no terminal.

http://localhost:3782

Opção B — Instalação local manual

git clone https://github.com/HKUDS/DeepTutor.git
cd DeepTutor

conda create -n deeptutor python=3.11 && conda activate deeptutor
pip install -e ".[server]"

cd web && npm install && cd ..
cp .env.example .env
LLM_BINDING=openai
LLM_MODEL=gpt-4o-mini
LLM_API_KEY=sk-xxx
LLM_HOST=https://api.openai.com/v1

EMBEDDING_BINDING=openai
EMBEDDING_MODEL=text-embedding-3-large
EMBEDDING_API_KEY=sk-xxx
EMBEDDING_HOST=https://api.openai.com/v1
EMBEDDING_DIMENSION=3072
python -m deeptutor.api.run_server
cd web && npm run dev -- -p 3782
Serviço Porta
Backend 8001
Frontend 3782

Opção C — Docker

git clone https://github.com/HKUDS/DeepTutor.git
cd DeepTutor
cp .env.example .env

Como na opção B.

2a. Imagem oficial — GHCR

docker compose -f docker-compose.ghcr.yml up -d

2b. Build — docker compose up -d

3. http://localhost:3782

docker compose logs -f
docker compose down
Nuvem / servidor remoto 
NEXT_PUBLIC_API_BASE_EXTERNAL=https://your-server.com:8001
Modo desenvolvimento (hot-reload) 
docker compose -f docker-compose.yml -f docker-compose.dev.yml up
Portas personalizadas 
BACKEND_PORT=9001
FRONTEND_PORT=4000
Persistência de dados
Caminho no contêiner Host Conteúdo
/app/data/user ./data/user Configurações, memória, workspace, sessões, logs
/app/data/knowledge_bases ./data/knowledge_bases Documentos e vetores
Variáveis de ambiente
Variável Obrigatório Descrição
LLM_BINDING Sim Provedor LLM
LLM_MODEL Sim Modelo
LLM_API_KEY Sim Chave
LLM_HOST Sim URL
EMBEDDING_BINDING Sim Embeddings
EMBEDDING_MODEL Sim Modelo
EMBEDDING_API_KEY Sim Chave
EMBEDDING_HOST Sim URL
EMBEDDING_DIMENSION Sim Dimensão
SEARCH_PROVIDER Não Busca
SEARCH_API_KEY Não Chave
BACKEND_PORT Não Padrão 8001
FRONTEND_PORT Não Padrão 3782
NEXT_PUBLIC_API_BASE_EXTERNAL Não URL pública
DISABLE_SSL_VERIFY Não Padrão false

Opção D — Apenas CLI

pip install -e ".[cli]"
deeptutor chat
deeptutor run chat "Explain Fourier transform"
deeptutor run deep_solve "Solve x^2 = 4"
deeptutor kb create my-kb --doc textbook.pdf

Guia completo: DeepTutor CLI.

📖 Explorar o DeepTutor

Arquitetura DeepTutor

💬 Chat — Workspace inteligente unificado

Chat

Cinco modos com contexto unificado.

Modo Função
Chat RAG, web, código, raciocínio, brainstorming, papers.
Deep Solve Multiagente com citações.
Geração de quiz Avaliações na KB.
Deep Research Subtópicos, agentes paralelos, relatório citado.
Math Animator Manim.

Ferramentas desacopladas dos fluxos.

✍️ Co-Writer — IA no editor

Co-Writer

Reescrever, Expandir, Encurtar; desfazer/refazer; cadernos.

🎓 Aprendizado guiado

Guiado
  1. Plano (3–5 pontos).
  2. Páginas interativas.
  3. P&R contextuais.
  4. Resumo.

📚 Gestão do conhecimento

Conhecimento
  • Bases de conhecimento — PDF, TXT, MD.
  • Cadernos — Cores e sessões.

🧠 Memória

Memória
  • Resumo — Progresso.
  • Perfil — Preferências, nível, metas. Compartilhado com TutorBots.

🦞 TutorBot — Tutores de IA persistentes e autônomos

Arquitetura TutorBot

Agente multi-instância persistente com nanobot.

TutorBot
  • Modelos Soul — Personalidade e pedagogia.
  • Workspace independente — Memória, sessões, habilidades; camada compartilhada.
  • Heartbeat proativo — Lembretes e tarefas.
  • Ferramentas completas — RAG, código, web, papers, raciocínio, brainstorming.
  • Habilidades — Arquivos skill.
  • Multicanal — Telegram, Discord, Slack, Feishu, WeCom, DingTalk, e-mail, etc.
  • Equipes e subagentes.
deeptutor bot create math-tutor --persona "Socratic math teacher who uses probing questions"
deeptutor bot create writing-coach --persona "Patient, detail-oriented writing mentor"
deeptutor bot list

⌨️ DeepTutor CLI — Interface nativa para agentes

CLI

Sem navegador: capacidades, KB, sessões, memória, TutorBot. Rich + JSON. SKILL.md.

deeptutor run chat "Explain the Fourier transform" -t rag --kb textbook
deeptutor run deep_solve "Prove that √2 is irrational" -t reason
deeptutor run deep_question "Linear algebra" --config num_questions=5
deeptutor run deep_research "Attention mechanisms in transformers"
deeptutor chat --capability deep_solve --kb my-kb
deeptutor kb create my-kb --doc textbook.pdf
deeptutor kb add my-kb --docs-dir ./papers/
deeptutor kb search my-kb "gradient descent"
deeptutor kb set-default my-kb
deeptutor run chat "Summarize chapter 3" -f rich
deeptutor run chat "Summarize chapter 3" -f json
deeptutor session list
deeptutor session open <id>
Referência completa da CLI
Comando Descrição
deeptutor run <capability> <message> Uma passagem
deeptutor chat REPL
deeptutor serve Servidor API

bot, kb, memory, session, notebook, config / plugin / provider — como no README em inglês.

🌐 Comunidade e ecossistema

Projeto Papel
nanobot Motor do TutorBot
LlamaIndex RAG
ManimCat Math Animator
⚡ LightRAG 🤖 AutoAgent 🔬 AI-Researcher 🧬 nanobot
RAG rápido Agentes sem código Pesquisa automática Agente ultraleve

🤝 Contribuir

Veja CONTRIBUTING.md.

⭐ Histórico de estrelas