CRAG-Ollama-Chat 项目启动与配置教程

CRAG-Ollama-Chat 项目启动与配置教程

CRAG-Ollama-Chat Corrective RAG demo powerd by Ollama 项目地址: https://gitcode.com/gh_mirrors/cr/CRAG-Ollama-Chat

1. 项目的目录结构及介绍

CRAG-Ollama-Chat 项目是一个开源项目，其目录结构如下：

CRAG-Ollama-Chat/
├── .github/
│   └── workflows/
├── .gitignore
├── Dockerfile
├── LICENSE
├── README.md
├── app.py
├── config.example.yaml
├── poetry.lock
├── pyproject.toml
├── requirements.txt

以下是各目录和文件的简要介绍：

• .github/workflows/：存放项目的 GitHub Actions 工作流文件，用于自动化处理如代码提交、测试等任务。
• .gitignore：用于指定 Git 忽略的文件和目录。
• Dockerfile：用于构建项目镜像的 Docker 配置文件。
• LICENSE：项目使用的许可证文件，本项目使用 MIT 许可证。
• README.md：项目的说明文档，包含项目介绍、使用方法和配置指南。
• app.py：项目的启动文件，包含主要的业务逻辑。
• config.example.yaml：项目的配置文件示例，用于指导用户如何配置项目。
• poetry.lock 和 pyproject.toml：用于 Python 项目依赖管理的 Poetry 工具的配置文件。
• requirements.txt：项目的 Python 依赖文件，可用于通过 pip 安装依赖。

2. 项目的启动文件介绍

项目的启动文件为 app.py，该文件是项目的入口点。以下是启动文件的简要介绍：

• app.py：该文件包含项目的业务逻辑和启动 Flask 应用程序的代码。用户可以通过运行以下命令启动项目：

streamlit run app.py

3. 项目的配置文件介绍

项目的配置文件为 config.example.yaml，用户需要根据此示例文件创建一个 config.yaml 文件，并填入所需的配置信息。以下是配置文件的简要介绍：

• config.example.yaml：该文件包含项目所需的各种配置项，如下所示：

APIs:
  openai_api_key: "your_openai_api_key"
  openai_api_base: "https://api.openai.com/v1/chat/completions"
  google_api_key: "your_google_api_key"
  tavily_api_key: "your_tavily_api_key"

Ollama Config:
  run_local: "Yes"  # 是或否，如果是 "Yes"，则必须在你的电脑上运行 ollama
  local_llm: "openhermes"  # mistral, llama2 等

Model Config:
  models: "openai"  # 如果想要获得最佳结果，可以选择合适的模型

Document Config:
  doc_url: "your_document_url"  # 支持多个网站阅读，填写你的博客地址等

用户需要根据 config.example.yaml 的格式创建一个 config.yaml 文件，并填入相应的配置信息。配置完成后，即可运行 app.py 文件启动项目。

CRAG-Ollama-Chat Corrective RAG demo powerd by Ollama 项目地址: https://gitcode.com/gh_mirrors/cr/CRAG-Ollama-Chat