minima (Dmayboroda)

最小 是一个开源的RAG本地容器，能够与ChatGPT和MCP集成。 Minima也可以用作完全本地的RAG或与您自己部署的LLM一起使用。

Minima目前支持四种模式：

1. 独立安装（Ollama） –使用容器完全在本地运行，不受ChatGPT或Claude等外部依赖。所有神经网络（LLM、重新登录、嵌入）都在您的云或PC上运行，确保您的数据保持安全。

1. 自定义LLM（与OpenAI兼容的API） –将您自己部署的LLM与OpenAI兼容的API（vLLM、Ollama服务器、TGI等）一起使用。索引器在本地运行，而LLM可以在您的服务器、云或本地计算机上运行。无需Ollama部署，资源使用量更低，完全控制LLM基础设施。

1. 自定义GPT –使用ChatGPT应用程序或带有自定义GPT的web查询您的本地文档。索引器在您的云或本地PC上运行，而主LLM仍然是ChatGPT。

1. 安thropic克劳德 –使用Anthropic Claude应用程序查询您的本地文档。索引器在您的本地PC上运行，而Anthropic Claude担任主要的LLM。

______________________________________________________________________

作为容器运行

run.sh快速入门

启动Minima最简单的方法是使用 run.sh 脚本：

./run.sh

您将看到以下选项：

Select an option:
1) Fully Local Setup (Ollama)
2) Custom LLM (OpenAI-compatible API)
3) ChatGPT Integration
4) MCP usage
5) Quit

手动Docker编写命令

1. 在项目的根目录中创建一个.env文件（您可以在其中找到.env.sample）。将.env放在同一个文件夹中，并将所有环境变量从.env.sample复制到.env。

1. 确保.env文件包含以下变量：

LOCAL_FILES_PATH

EMBEDDING_MODEL_ID

EMBEDDING_SIZE

OLLAMA_MODEL (only for Ollama mode)

RERANKER_MODEL (only for Ollama mode)

LLM_BASE_URL (only for Custom LLM mode)

LLM_MODEL (only for Custom LLM mode)

LLM_API_KEY (optional for Custom LLM mode)

USER_ID - required for ChatGPT integration, just use your email

PASSWORD - required for ChatGPT integration, just use any password

1. 对于完全本地安装使用： docker compose-f docker-compose-ollama.yml--环境文件.env up--构建.

1. 对于自定义LLM部署（与OpenAI兼容的API），请使用： docker-compose-f docker-compose-custom-llm.yml--环境文件.env-up--构建.

1. 对于启用ChatGPT的安装，请使用： docker compose-f docker-compose-chatgpt.yml-env文件.env-up-build.

1. 对于MCP集成（Anthropic Desktop应用程序使用）： docker compose-f docker-compose-mcp.yml--env文件.env up--build.

1. 如果启用了ChatGPT安装，请从启动docker的终端复制OTP并使用 GPT最小值

1. 如果你使用Anthropic Claude，只需添加以下内容 /库/应用程序\\支持/Claude/Claude_desktop_config json

{
    "mcpServers": {
      "minima": {
        "command": "uv",
        "args": [
          "--directory",
          "/path_to_cloned_minima_project/mcp-server",
          "run",
          "minima"
        ]
      }
    }
  }

1. 要使用完全本地安装，请转到 cd electron，然后运行 npm install 和 npm start 将推出Minima电子应用程序。

1. 问任何问题，你都会得到基于{local_files_PATH}文件夹中本地文件的答案。

______________________________________________________________________

变量解释

本地文件路径：指定用于索引的根文件夹（在您的云端或本地电脑上）。索引是一个递归过程，这意味着此根文件夹的子文件夹中的所有文档也将被索引。支持的文件类型：.pdf、.xls、.docx、.txt、.md、.csv。

嵌入模型ID：指定要使用的嵌入模型。目前，仅支持句子转换器模型。已经使用句子转换器/all-mpnet-base-v2进行了测试，但也可以使用其他句子转换器模型。

嵌入大小：定义模型提供的嵌入维度，这是配置Qdrant向量存储所必需的。确保此值与指定embedding_MODEL_ID的实际嵌入大小匹配。

OLLAMA_模型：设置Ollama模型，使用Ollama上提供的ID 站点。请在此处使用LLM模型，而不是嵌入。这仅在使用Ollama时需要（在使用自定义LLM时不需要）。

LLM_BASE_URL：（可选）自定义OpenAI兼容LLM API终结点的基本URL。设置此选项后，将不会使用Ollama，您也不需要部署它。

LLM模型：（可选）自定义LLM的型号名称。设置LLM_BASE_URL时需要。

LLM_API_KEY（LLM_API_密钥）：（可选）自定义LLM的API密钥。如果LLM不需要身份验证，则可以省略此项或将其设置为任何值。

重新链接模型：指定Ollama模式的重新定位模型。目前，我们已经使用BAAI重新登录器进行了测试。您可以使用此功能探索所有可用的重新登录者 链接. 注： 对于自定义LLM模式，这不是必需的-如果您使用LLM_BASE_URL，则不会下载重新链接器模型。

USER_ID：只需在此处使用您的电子邮件，这是验证自定义GPT以搜索您的数据所必需的。

密码：在此处输入任何密码，这用于为上面指定的电子邮件创建一个firebase帐户。

______________________________________________________________________

例子

Ollama本地/本地使用的.env文件示例：

LOCAL_FILES_PATH=/Users/davidmayboroda/Downloads/PDFs/
EMBEDDING_MODEL_ID=sentence-transformers/all-mpnet-base-v2
EMBEDDING_SIZE=768
OLLAMA_MODEL=qwen2:0.5b # must be LLM model id from Ollama models page
RERANKER_MODEL=BAAI/bge-reranker-base # please, choose any BAAI reranker model

自定义LLM部署的.env文件示例（与OpenAI兼容的API）：

LOCAL_FILES_PATH=/Users/davidmayboroda/Downloads/PDFs/
EMBEDDING_MODEL_ID=sentence-transformers/all-mpnet-base-v2
EMBEDDING_SIZE=768
LLM_BASE_URL=http://your-llm-address:port/v1 # Your custom LLM endpoint
LLM_MODEL=Qwen/Qwen-1.7B # Your model name
LLM_API_KEY=not-needed # Optional: API key if required

# NOTE: OLLAMA_MODEL and RERANKER_MODEL are NOT needed for custom LLM mode
# The Docker build will skip reranker download automatically

重要提示： 使用自定义LLM模式时，您不需要设置 OLLAMA_MODEL 或 RERANKER_MODEL 变量。自定义LLM工作流使用直接检索而无需重新排序，以获得更好的性能。在构建过程中，Dockerfile将自动跳过下载重新链接器模型。

要使用聊天用户界面，请导航到 http://localhost:3000

与Ollama相比，自定义LLM模式使用不同的工作流程：

Ollama工作流程：

1. 用户查询→ 查询增强（LLM调用）
2. 通过重新排序进行文档检索（HuggingFace CrossEncoder）
3. 应答生成（LLM呼叫）

自定义LLM工作流：

1. 用户查询→ LLM决定是否需要文档搜索（函数调用）
2. 如果需要：直接矢量搜索（无需重新排序）
3. LLM在有或没有检索到的上下文的情况下生成答案

兼容的LLM服务器：

• vLLM -高性能推理服务器(http://your-server:8000/v1)
• 文本生成推理（TGI） -Hugging Face的推理服务器
• Ollama服务器 -Ollama在API模式下运行
• 文学硕士 -多个LLM提供商的代理
• LocalAI -OpenAI兼容的局部推理
• OpenAI API -直接使用OpenAI的API
• 任何与OpenAI兼容的端点

这将自动使用 docker-compose-custom-llm.yml 其仅部署必要的服务（没有Ollama容器）。

Claude应用程序的.env文件示例：

LOCAL_FILES_PATH=/Users/davidmayboroda/Downloads/PDFs/
EMBEDDING_MODEL_ID=sentence-transformers/all-mpnet-base-v2
EMBEDDING_SIZE=768

对于Claude应用程序，请按照上述说明将更改应用于Claude_desktop_config.json文件。

要将MCP与GitHub Copilot一起使用：

1. 在项目的根目录中创建一个.env文件（您可以在其中找到env.sample）。将.env放在同一个文件夹中，并将所有环境变量从env.sample复制到.env。

1. 确保.env文件包含以下变量：

- 本地文件路径 - 嵌入模型ID - 嵌入大小

1. 创建或更新 .vscode/mcp.json 具有以下配置：

{
  "servers": {
    "minima": {
      "type": "stdio",
      "command": "path_to_cloned_minima_project/run_in_copilot.sh",
      "args": [
        "path_to_cloned_minima_project"
      ]
    }
  }
}

ChatGPT自定义GPT使用的.env文件示例：

LOCAL_FILES_PATH=/Users/davidmayboroda/Downloads/PDFs/
EMBEDDING_MODEL_ID=sentence-transformers/all-mpnet-base-v2
EMBEDDING_SIZE=768
USER_ID=user@gmail.com # your real email
PASSWORD=password # you can create here password that you want

此外，您还可以使用以下命令运行最小值 run.sh.

______________________________________________________________________

对于MCP的使用，请确保您的本地计算机python>=3.10并且安装了“uv”。

迷你马(https://github.com/dmayboroda/minima)根据Mozilla公共许可证v2.0（MPLv2）获得许可。