# simple-data-co-pilot

**Repository Path**: bytesc/simple-data-co-pilot

## Basic Information

- **Project Name**: simple-data-co-pilot
- **Description**: 自然语言查询数据表
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-03-27
- **Last Updated**: 2024-06-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: llm, RAG, Python

## README

# simple-data-co-pilot

自然语言查询数据表
数据来源：
GDP(现价美元):
https://data.worldbank.org.cn/indicator/NY.GDP.MKTP.CD
GDP增长率(年百分比):
https://data.worldbank.org.cn/indicator/NY.GDP.MKTP.KD.ZG
按购买力平价(PPP)衡量的GDP(现价国际元):
https://data.worldbank.org.cn/indicator/NY.GDP.MKTP.PP.CD

![](./md_img/flow.png)

## 效果展示
### 界面效果
![](./md_img/ask1.png)
![](./md_img/ans1.png)
![](./md_img/ans2.png)

### 数据展示
![](./md_img/data.png)

## 如何运行

### 获取apikey

从阿里云获取 `qwen` 大语言模型的 api-key

[阿里云dashscope](https://dashscope.console.aliyun.com/)

保存 `api-key` 到 `api_keys/api_key.txt`

### 安装依赖

```bash
pip install -r requirements.txt
```

### 运行
```bash
python data-co-pilot.py
```

以下是一些问题的例子

```txt
查询2019，2020年全球的gdp数据
查询法国的gdp情况
美国的gdp历史？
查询日本从2000到2010年的gdp
查询美国和中国2000到2010年的gdp数据
```

# 工作流程

## 代码提交流程
![](./md_img/代码工作流程.png)

## 关于仓库权限
- 所有人只能向自己的 `dev` 分支提交代码
- 可以对自己的 `dev` 分支使用 `push -f`
- 对 `master` 分支（用于统计贡献）的修改，需要通过提交 `pull request` 并通过审核

## 关于代码工作的一些规则
满足以下要求的 `pull request` 才能通过审核
- 谁后提交，谁负责处理冲突
- 每个提交的 `commit` 版本必须是可运行（可被测试）的
- 每个提交的 `commit` 版本必须和上一个版本有明显区别（新增功能或修复bug等）
- `commit` 的注释要体现更改内容

## 参考 git 命令

```bash
# 检查仓库情况
git status
git add .
# 提交更改
git commit -m "在readme文件中添加代码工作规范"

# 获取远程仓库最新内容
git fetch --all
# 合并
# 这一步如果出现冲突，手动解决冲突，回到开头
git merge gitee/master
# 推送到自己的远程 dev 分支
git push gitee master:dev-rcy
```