Home
Login

Uma ferramenta de assistente de documentação de IA generativa de código aberto que ajuda os usuários a obter respostas confiáveis de bases de conhecimento, evitando alucinações, suportando implantação privada e recuperação de informações confiáveis.

MITTypeScript 15.7karc53 Last Updated: 2025-06-19

DocsGPT - Assistente de Documentação Inteligente de Código Aberto

Visão Geral do Projeto

DocsGPT é uma ferramenta de IA generativa de código aberto que ajuda os usuários a obter respostas confiáveis de qualquer fonte de conhecimento, evitando problemas de alucinação. Ele implementa recuperação de informações rápida e confiável, com ferramentas integradas e funcionalidades de sistema de agentes.

DocsGPT é um assistente de documentação de código aberto baseado na tecnologia RAG (Retrieval-Augmented Generation), projetado especificamente para cenários de perguntas e respostas sobre documentos e gerenciamento de conhecimento.

Principais Características

📁 Amplo Suporte a Formatos

  • Formatos Suportados: PDF, DOCX, CSV, XLSX, EPUB, MD, RST, HTML, MDX, JSON, PPTX e arquivos de imagem
  • Acesso a Dados de Múltiplas Fontes: Suporte para URL, sitemaps, Reddit, GitHub e web scraping

🎯 Geração de Respostas Confiáveis

  • Garantia de Precisão: Fornece respostas precisas e sem alucinações
  • Citação de Fontes: Exibe citações de fontes visualizáveis em uma interface de usuário clara
  • Baseado em Contexto: Otimizado especificamente para o contexto fornecido pelos documentos

🔑 Gerenciamento Simplificado de API

  • Gerenciamento de Chaves de API: Gere e configure chaves associadas a documentos e modelos
  • Integração Simplificada: Simplifica a configuração de chatbots e integrações

🔗 Integração de Ferramentas Acionáveis

  • Conexão API: Conecte-se a APIs, ferramentas e outros serviços
  • Operações LLM: Habilita funcionalidades de operação de modelos de linguagem grandes

🧩 Integrações Pré-construídas

  • Componentes Prontos para Uso: Widget de chat HTML/React
  • Ferramentas de Busca: Funcionalidade de busca integrada
  • Integração de Bots: Suporte para bots Discord/Telegram

🔌 Opções de Implantação Flexíveis

  • Suporte a Múltiplos Modelos: Compatível com os principais fornecedores de LLM (OpenAI, Google, Anthropic)
  • Modelos Locais: Suporte para modelos locais (Ollama, llama_cpp)
  • Métodos de Implantação: Suporte para Docker, Kubernetes e outros métodos de implantação

🏢 Segurança e Escalabilidade

  • Execução Privada: Suporte para implantação privada
  • Nível Empresarial: Projetado para confiabilidade de nível empresarial
  • Suporte a Kubernetes: Suporte para implantação em contêineres

Arquitetura Técnica

Estrutura do Projeto

  • Application: Aplicação Flask (aplicação principal)
  • Extensions: Componentes de extensão, como widgets React ou bots Discord
  • Scripts: Vários scripts auxiliares

Métodos de Implantação

O projeto oferece várias opções de implantação:

  1. Usando API pública
  2. Execução local
  3. Conectando-se a um mecanismo de inferência local
  4. Usando um provedor de API na nuvem

Início Rápido

Requisitos do Sistema

Certifique-se de que o Docker esteja instalado

Passos de Instalação

  1. Clone o Repositório
git clone https://github.com/arc53/DocsGPT.git
cd DocsGPT
  1. Execute o Script de Configuração

Para macOS e Linux:

./setup.sh

Para Windows:

PowerShell -ExecutionPolicy Bypass -File .\setup.ps1
  1. Acesse a Aplicação Navegue para http://localhost:5173/

  2. Pare os Serviços

docker compose -f deployment/docker-compose.yaml down

Casos de Uso

Gerenciamento de Documentos Empresariais

  • Perguntas e respostas sobre base de conhecimento interna
  • Recuperação de documentação técnica
  • Suporte ao treinamento de funcionários

Suporte ao Desenvolvedor

  • Consulta de documentação de código
  • Assistente de documentação de API
  • Automação de suporte técnico

Educação e Treinamento

  • Perguntas e respostas sobre materiais de estudo
  • Recuperação de conteúdo do curso
  • Auxílio à educação online

Resumo

DocsGPT, como um assistente de documentação de código aberto poderoso e flexível, oferece às organizações de todos os tamanhos uma solução para melhorar os fluxos de trabalho de documentação e aumentar a produtividade. Sua capacidade de implantação privada e recursos de nível empresarial o tornam particularmente adequado para organizações com requisitos rigorosos de segurança de dados.