GenAI Stack 项目使用教程

GenAI Stack 项目使用教程

genai-stackLangchain + Docker + Neo4j + Ollama项目地址:https://gitcode.com/gh_mirrors/ge/genai-stack

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

GenAI Stack 项目的目录结构如下：

genai-stack/
├── README.md
├── env.example
├── docker-compose.yml
├── scripts/
│   └── setup.sh
├── src/
│   ├── main.py
│   ├── config.py
│   └── utils.py
└── docs/
    └── README.md

目录结构介绍

• README.md: 项目的主文档，包含项目的基本信息和使用说明。
• env.example: 环境变量配置文件的模板。
• docker-compose.yml: Docker 容器编排文件，用于启动项目所需的所有服务。
• scripts/: 包含项目的脚本文件，如 setup.sh 用于项目的初始化设置。
• src/: 项目的源代码目录，包含主要的 Python 文件。
  • main.py: 项目的入口文件。
  • config.py: 项目的配置文件。
  • utils.py: 包含项目中使用的工具函数。
• docs/: 项目的文档目录，包含额外的文档文件。

2. 项目的启动文件介绍

项目的启动文件是 src/main.py，该文件是项目的入口点，负责初始化配置和启动应用程序。

src/main.py 文件介绍

import config
from utils import setup_logging

def main():
    setup_logging()
    config.load_config()
    # 其他初始化代码

if __name__ == "__main__":
    main()

• import config: 导入配置模块。
• from utils import setup_logging: 导入日志设置工具函数。
• def main(): 定义主函数，负责初始化日志和加载配置。
• if __name__ == "__main__":: 确保脚本作为主程序运行时执行 main() 函数。

3. 项目的配置文件介绍

项目的配置文件是 src/config.py，该文件负责加载和管理项目的配置参数。

src/config.py 文件介绍

import os

def load_config():
    config = {
        "OLLAMA_BASE_URL": os.getenv("OLLAMA_BASE_URL", "http://host.docker.internal:11434"),
        "NEO4J_URI": os.getenv("NEO4J_URI", "neo4j://database:7687"),
        "NEO4J_USERNAME": os.getenv("NEO4J_USERNAME", "neo4j"),
        "NEO4J_PASSWORD": os.getenv("NEO4J_PASSWORD", "password"),
        "LLM": os.getenv("LLM", "llama2"),
        "EMBEDDING_MODEL": os.getenv("EMBEDDING_MODEL", "default_model")
    }
    return config

• import os: 导入操作系统模块，用于读取环境变量。
• def load_config(): 定义加载配置的函数，从环境变量中读取配置参数并返回配置字典。

以上是 GenAI Stack 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

genai-stackLangchain + Docker + Neo4j + Ollama项目地址:https://gitcode.com/gh_mirrors/ge/genai-stack