Knotie-AI 项目启动与配置教程

1. 项目目录结构及介绍

Knotie-AI 是一个完全开源的内外部 AI 销售代理项目，其目录结构如下：

• .github/：包含 GitHub Actions 工作流文件，用于自动化项目的一些操作，如代码构建和测试等。
• Ai_Model_Training/：存放训练 AI 模型的相关代码和数据。
• ConversationCache/：用于缓存对话信息。
• docs/：存放项目的文档文件。
• generated_tools/：存放由代码生成的一些工具。
• openapi_specs/：定义项目使用的 OpenAPI 规范。
• templates/：存放项目使用的 HTML 模板文件。
• .env_sample：项目环境变量样本文件。
• .gitignore：Git 忽略文件列表。
• Dockerfile：用于构建 Docker 容器的文件。
• LICENSE：项目使用的 GPL-2.0 许可证文件。
• README.md：项目说明文件。
• ai_helpers.py：AI 辅助功能模块。
• app.py：项目的主要启动文件。
• appUtils.py：项目辅助工具模块。
• audio_helpers.py：音频处理辅助模块。
• config.py：项目配置文件。
• docker-compose-deploy.yaml：Docker Compose 部署配置文件。
• docker-compose-redis_only.yaml：只包含 Redis 的 Docker Compose 配置文件。
• docker-compose.yml：Docker Compose 配置文件。
• prompts.py：提示信息模块。
• requirements.txt：项目依赖文件。
• retype.json 和 retype.yml：数据格式转换文件。
• stages.py：项目阶段模块。
• testAISalesAgent.py：AI 销售代理测试模块。
• testConversationCache.py：对话缓存测试模块。
• tools.py：工具模块。
• tools_helper.py：工具辅助模块。

2. 项目的启动文件介绍

项目的启动文件是 app.py，它是 Flask 应用的入口点。以下是 app.py 的基本结构：

from flask import Flask
app = Flask(__name__)

@app.route('/')
def home():
    return "Hello, Knotie-AI!"

if __name__ == '__main__':
    app.run(debug=True)

在这个文件中，我们创建了一个 Flask 应用，定义了一个路由 /，当访问这个路由时，会返回 "Hello, Knotie-AI!"。

3. 项目的配置文件介绍

项目的配置文件是 config.py，它用于存储项目运行时的配置信息。以下是一个示例的配置文件结构：

import os

class Config:
    # Flask 通用配置
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'a_very_secret_key'
    FLASK_APP = 'app.py'
    FLASK_ENV = 'development'

    # 数据库配置
    SQLALCHEMY_DATABASE_URI = 'sqlite:///data.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

    # 其他配置
    # ...

在这个配置文件中，我们定义了一些基本的配置项，如密钥、数据库连接信息等。这些配置项可以通过环境变量进行覆盖，以提高配置的灵活性。

启动项目时，Flask 会自动加载 config.py 文件中的配置信息，使其在应用中生效。