# rag-chat-api

**Repository Path**: xiaonan96/rag-chat-api

## Basic Information

- **Project Name**: rag-chat-api
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-02-24
- **Last Updated**: 2025-02-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

确保以下软件或服务已安装并配置好：

- Python (版本 3.10 或更高)
- Mysql (版本 5.7 或更高)
- Milvus (版本 2.3.7 或更高)

### 安装步骤

1. 克隆仓库并安装依赖：
    ```bash
    cd ragchat-api
    pip install -r requirements.txt
    ```
2. 本地部署Mysql服务并启动
   - [**Ubuntu系统上安装Mysql**](/docs/01_Ubuntu系统上安装Mysql.md)
   
3. 初始化关系型数据库表
    ```bash
    python /ragchat-api/server/db/create_all_model.py
    ```
4. 初始化Faiss向量数据库
    ```bash
    python /ragchat-api/server/knowledge_base/init_vs.py
    ```
5. 本地部署milvus向量数据库并启动
   
6. 启动后端服务：
    ```bash
    python startup.py
    ```

## API接口示例
请求地址：http://{server_ip}:8000/docs
<div align="center">
<img src="https://muyu001.oss-cn-beijing.aliyuncs.com/img/image-20240717192132838.png" alt="image-20240713010710534" width="1000"/>
</div>

## 使用示例

使用 Postman 或其他 HTTP 客户端工具访问 API 接口：

### POST 请求示例

```http
http://192.168.110.131:8000/api/chat  # 替换为自己实际启动的服务 IP + 端口

{
    "query":"什么是机器学习",
    "conversation_id":"18b352a0-42de-419c-ada1-a0fa44dbee1d",
    "model_name":"chatglm3-6b"
}
```