Introdução geral
O Minima é uma solução RAG (Retrieval-Augmented Generation) de código aberto que oferece suporte à implantação local e à integração com o ChatGPT Integração. Esse projeto é mantido por dmayboroda e foi desenvolvido para fornecer uma solução flexível e independente para a integração de aplicativos. RAG O Minima oferece três modos de operação: uma instalação local totalmente isolada, um modo híbrido com integração ao ChatGPT e um modo com total dependência de serviços externos. O objetivo do projeto é oferecer aos usuários uma solução RAG eficiente, dimensionável e fácil de usar.
O projeto é implantado usando o Docker e oferece suporte à indexação e à consulta de uma ampla variedade de formatos de arquivo, incluindo PDF, XLS, DOCX, TXT, MD e CSV. O Minima é lançado sob a Mozilla Public Licence v2.0 (MPLv2), o que garante aos usuários a liberdade de usar e modificar o código como acharem adequado.
Lista de funções
- Diálogo de documentos locaisDiálogo com arquivos locais por meio da instalação local.
- Modos GPT personalizadosConsulta de arquivos locais usando um modelo GPT personalizado.
- Suporte a vários formatos de arquivoSuporte a indexação e consulta de arquivos PDF, XLS, DOCX, TXT, MD e CSV.
- Implementação do DockerImplementação e gerenciamento rápidos via Docker.
- Configuração da variável de ambienteConfigure as variáveis de ambiente por meio do arquivo .env para definir com flexibilidade os caminhos dos arquivos e os parâmetros do modelo.
- índice recursivoIndexação recursiva: suporta a indexação recursiva de todas as subpastas e arquivos em uma pasta.
Usando a Ajuda
Processo de instalação
- armazém de clones::
git clone https://github.com/dmayboroda/minima.git
cd minima
- Criação e execução de contêineres::
docker-compose up --build
- arquivo de configuraçãoModificar conforme necessário
config.yml
para configurar o modo nativo ou integrado.
Diretrizes para uso
modo local
- Início dos serviços::
docker-compose up
- interface de acesso: Abrir no navegador
http://localhost:9001
A interface local do Minima pode ser acessada clicando no seguinte link: "Minima", "Minima" ou "Minima".
Modo integrado
- Configuração do ChatGPT: em
config.yml
Adicione a chave da API do ChatGPT e a configuração relacionada no arquivo - Início dos serviços::
docker-compose up
- interface de acesso: Abrir no navegador
http://localhost:9001
A interface do Minima, que integra o ChatGPT, pode ser acessada.
Operação detalhada da função
- Geração de consultasEnvio de uma solicitação de consulta por meio da interface da API e o Minima a processará no modo local ou integrado, dependendo da configuração, e retornará os resultados gerados.
- gerenciamento de configuração: modificando o
config.yml
você pode ajustar com flexibilidade os modos de operação e os parâmetros do Minima. - Visualização do registroTodos os registros de operação são armazenados no
logs
que pode ser visualizado e analisado pelo usuário a qualquer momento.
problemas comuns
- Não é possível iniciar o contêinerVerifique se o Docker e o Docker Compose estão instalados corretamente e se as portas não estão ocupadas.
- Falha na solicitação de API: Reconhecimento
config.yml
Configurado corretamente, especialmente a chave da API e o endereço do ponto de extremidade.