Introdução geral
O Minima é um projeto de código aberto que tem como objetivo fornecer uma ferramenta RAG (Retrieval Augmentation Generation) totalmente localizada. Os usuários podem usar o Minima para se comunicar com arquivos locais, com suporte a dois modos: instalação totalmente local e modo GPT personalizado. 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 que os usuários tenham liberdade para usar e modificar o código.
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
- projeto de clonagemClone o projeto Minima localmente a partir do GitHub.
git clone https://github.com/dmayboroda/minima.git
cd minima
- Configuração de variáveis de ambienteCrie um arquivo .env no diretório raiz do projeto e copie o conteúdo do arquivo .env.sample para o arquivo .env e defina as variáveis relevantes.
cp .env.sample .env
As variáveis a serem configuradas incluem:
LOCAL_FILES_PATH
Especifica o caminho para a pasta a ser indexada.EMBEDDING_MODEL_ID
Modelo de incorporação: Especifica o modelo de incorporação a ser usado.EMBEDDING_SIZE
Define a dimensão de incorporação.START_INDEXING
Inicialização inicial definida comoverdadeiro
para iniciar a indexação.ID DO USUÁRIO
responder cantandoSENHA
Autenticação de usuário para o modo GPT personalizado.
- Iniciando o contêiner do Docker::
- Instalação totalmente local:
bash
docker compose -f docker-compose-ollama.yml --env-file .env up --build
- Personalizar o modo GPT:
bash
docker compose --env-file .env up --build
- Instalação totalmente local:
Processo de uso
- Diálogo de documentos locais::
- Conecte-se ao servidor local:
ws://localhost:8003/llm/
- Inicia um diálogo com o arquivo local para consultar o conteúdo do arquivo.
- Modos GPT personalizados::
- Depois de iniciar o contêiner do Docker, copie o OTP do terminal e consulte-o usando o Minima GPT.
- Faça uma pergunta e o Minima fornecerá uma resposta com base no conteúdo do arquivo local.
Operação detalhada da função
- Indexação de documentosIndexação de arquivos: Após iniciar o contêiner, o Minima indexa automaticamente todos os arquivos na pasta especificada. O processo de indexação é recursivo e todos os arquivos em subpastas também são indexados.
- Consultar o conteúdo do documentoSe os usuários se conectarem a um servidor local via WebSocket, enviarão uma solicitação de consulta e o Minima retornará uma resposta com base no conteúdo do arquivo.
- Configuração da variável de ambienteOs usuários podem ajustar a configuração do Minima de forma flexível, modificando as variáveis no arquivo .env, como alterar os caminhos dos arquivos, incorporar modelos etc.