# mtl-rag

**Repository Path**: component-rd-team/mtl-rag

## Basic Information

- **Project Name**: mtl-rag
- **Description**: rag知识库应用
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-02-26
- **Last Updated**: 2025-02-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mtl-rag

## 介绍
rag知识库应用

## 软件架构说明

### 概述
`mtl-rag` 是一个基于 Flask 的知识库应用，旨在提供高效的知识管理和检索功能。软件架构设计如下：

- **Flask 应用**：核心 Web 框架，处理 HTTP 请求和响应。
- **Blueprints**：用于组织和管理不同的路由模块。
- **Utils 模块**：包含通用的工具函数和响应处理。
- **API 模块**：包含具体的业务逻辑和 API 路由。

### 依赖
- **Python 3.12**：确保使用 Python 3.12 版本以获得最佳性能和兼容性。
- **Flask**：用于构建 Web 应用。
- **Jinja2**：用于模板渲染。
- **Werkzeug**：用于 WSGI 工具和中间件。
- **itsdangerous**：用于安全地处理数据签名。
- **click**：用于命令行接口。
- **MarkupSafe**：用于安全地处理 HTML 内容。
- **gunicorn**：用于生产环境的 WSGI 服务器。

## 安装教程

1. **安装 Python 3.12**：
   - 确保你的系统上安装了 Python 3.12 版本。你可以从 [Python 官方网站](https://www.python.org/downloads/release/python-3120/) 下载并安装。

2. **克隆仓库**：
```shell
git clone https://gitee.com/component-rd-team/mtl-rag.git 
cd mtl-rag
```

3. **安装依赖**：
```shell
pip install -r requirements.txt
```

4. **运行应用**：
```shell
python app.py
```
   
## 使用说明

1. **访问主页**：
   - 打开浏览器，访问 `http://127.0.0.1:5000/`。

2. **访问 API**：
   - **GET 请求**：访问 `http://127.0.0.1:5000/api/data`。
   - **POST 请求**：使用工具（如 Postman）发送 POST 请求到 `http://127.0.0.1:5000/api/submit`，并提供 JSON 数据。

## 参与贡献

1. **Fork 本仓库**：
   - 点击仓库页面右上角的 "Fork" 按钮。

2. **新建 Feat_xxx 分支**：
```shell
   git checkout -b Feat_xxx
```

3. **提交代码**：
```shell
git add . 
git commit -m "Add new feature" 
git push origin Feat_xxx
```
4. **新建 Pull Request**：
   - 在 Gitee 上打开你的 Fork 仓库，点击 "Pull Request" 按钮，创建一个新的 Pull Request。

## 特技

1. **使用 Readme\_XXX.md 来支持不同的语言**，例如 Readme\_en.md, Readme\_zh.md
2. **Gitee 官方博客** [blog.gitee.com](https://blog.gitee.com)
3. **你可以** [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4. **GVP** 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5. **Gitee 官方提供的使用手册** [https://gitee.com/help](https://gitee.com/help)
6. **Gitee 封面人物** 是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)