| Name | airda JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | None |
| Summary | airda |
| upload_time | 2024-04-26 11:17:52 |
| maintainer | None |
| docs_url | None |
| author | hitsz-ids |
| requires_python | <4.0,>=3.10 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## 📖 介绍
airda(Air Data Agent)是面向数据分析的多智能体，能够理解数据开发和数据分析需求、理解数据、生成面向数据查询、数据可视化、机器学习等任务的SQL和Python代码。
### 特性：
- **精准数据检索**：airda具有强大的数据处理和搜索能力，可以从成百上千张表中精准找数，满足您在大数据环境下的数据查找需求。
- **业务知识理解**：airda不仅能处理数据，还深入理解数据指标、计算公式等业务知识，为您提供更深层次、更具业务价值的数据分析。
- **多智能体协同工作**：airda采用面向数据分析需求的多轮对话设计，多智能体可以协同工作，进行数据分析代码的self-debug，提升分析效率，降低错误率。
- **数据可视化**：airda可以将复杂的数据通过可视化的方式呈现，让数据分析结果更易于理解，帮助您更好地做出决策。
### airda工作流程：
- **需求确认：** airda与用户建立对话，理解用户的需求。在这一阶段，airda会提出一系列问题，以便更准确地了解用户的需求。
- **任务规划：** airda会根据最终确认的需求内容为用户制定任务规划。这个规划包括一系列步骤，airda会按照这些步骤来为用户提供服务。
- **任务执行：** airda将规划好的任务分配给不同的智能体，如数据查找智能体、SQL生成智能体、代码生成智能体、可视化分析智能体等。每个智能体负责其专业领域的任务执行，协同工作以确保任务的高效完成。
- **应用生成：** airda根据用户需求任务将结果数据转化为应用成果，如指标大屏展示、数据API服务和数据应用等，这些成果能够以可视化的形式展示关键数据指标，提供API接口供其他系统或服务调用，以及根据用户需求生成具体的应用程序。
### 完成进度：
- [x] SQL生成
- [x] 数据接入
- [x] 知识库
- [ ] 语料库
- [ ] 图表生成
- [ ] 任务规划
## ✨ 快速开始
### 环境要求
Python>=3.10
### 安装 airda
pip安装
```
pip install airda -i https://pypi.python.org/simple/
```
### 依赖安装
使用airda需要用到mongodb,可采用docker安装mongodb
```
#拉取mongo镜像
docker pull mongo
docker run -itd --name mongo -v /{path_of_mongo_data}:/data/db -p 27017:27017 mongo
```
### 自定义配置
环境变量
下载https://github.com/hitsz-ids/airda/blob/main/.env.template文件,自定义embedding模型,mongo配置,以及openai配置
```
airda env load -p {your_path}/.env_template
```
日志文件（非必须）
下载https://github.com/hitsz-ids/airda/blob/main/log_config.yml.template文件,自定义日志配置
```
airda log load -p {your_path}/log_config.yml.template
```
### 相关配置命令
添加你的数据源
```
airda datasource add -n {datasource_name} -h {host} -p {port} -k MYSQL -d {database} -u {username} -w {password}
#当前只支持kind为MYSQL的数据源
```
训练数据源的schema
```
airda datasource sync -n {datasource_name}
```
查询当前可用的数据源
```
airda datasource ls
```
### 开始问答
```
airda run cli -n {datasource_name}
#输入你的问题:
```
## 👏 贡献
我们欢迎各种贡献和建议，共同努力，使本项目更上一层楼！麻烦遵循以下步骤：
- **步骤1：** 如果您想添加任何额外的功能、增强功能或在使用过程中遇到任何问题，请发布一个 [问题](https://github.com/hitsz-ids/SQLAgent/issues) 。如果您能遵循 [问题模板](https://github.com/hitsz-ids/SQLAgent/issues/1) 我们将不胜感激。问题将在那里被讨论和分配。
- **步骤2：** 无论何时，当一个问题被分配后，您都可以按照 [PR模板](https://github.com/hitsz-ids/SQLAgent/pulls) 创建一个 [拉取请求](https://github.com/hitsz-ids/SQLAgent/pulls) 进行贡献。您也可以认领任何公开的问题。共同努力，我们可以使airda变得更好！
- **步骤3：** 在审查和讨论后，PR将被合并或迭代。感谢您的贡献！
在您开始之前，我们强烈建议您花一点时间检查 [这里](https://github.com/hitsz-ids/SQLAgent/blob/developing/CONTRIBUTING.md) 再进行贡献。
Raw data
{
"_id": null,
"home_page": null,
"name": "airda",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "hitsz-ids",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a0/60/7e10c18f7dd866ec9334ca05fd2d12297e3d39643ae59d7bae89e4f23a0e/airda-0.0.3.tar.gz",
"platform": null,
"description": "## \ud83d\udcd6 \u4ecb\u7ecd\nairda(Air Data Agent)\u662f\u9762\u5411\u6570\u636e\u5206\u6790\u7684\u591a\u667a\u80fd\u4f53\uff0c\u80fd\u591f\u7406\u89e3\u6570\u636e\u5f00\u53d1\u548c\u6570\u636e\u5206\u6790\u9700\u6c42\u3001\u7406\u89e3\u6570\u636e\u3001\u751f\u6210\u9762\u5411\u6570\u636e\u67e5\u8be2\u3001\u6570\u636e\u53ef\u89c6\u5316\u3001\u673a\u5668\u5b66\u4e60\u7b49\u4efb\u52a1\u7684SQL\u548cPython\u4ee3\u7801\u3002\n### \u7279\u6027\uff1a\n\n- **\u7cbe\u51c6\u6570\u636e\u68c0\u7d22**\uff1aairda\u5177\u6709\u5f3a\u5927\u7684\u6570\u636e\u5904\u7406\u548c\u641c\u7d22\u80fd\u529b\uff0c\u53ef\u4ee5\u4ece\u6210\u767e\u4e0a\u5343\u5f20\u8868\u4e2d\u7cbe\u51c6\u627e\u6570\uff0c\u6ee1\u8db3\u60a8\u5728\u5927\u6570\u636e\u73af\u5883\u4e0b\u7684\u6570\u636e\u67e5\u627e\u9700\u6c42\u3002\n- **\u4e1a\u52a1\u77e5\u8bc6\u7406\u89e3**\uff1aairda\u4e0d\u4ec5\u80fd\u5904\u7406\u6570\u636e\uff0c\u8fd8\u6df1\u5165\u7406\u89e3\u6570\u636e\u6307\u6807\u3001\u8ba1\u7b97\u516c\u5f0f\u7b49\u4e1a\u52a1\u77e5\u8bc6\uff0c\u4e3a\u60a8\u63d0\u4f9b\u66f4\u6df1\u5c42\u6b21\u3001\u66f4\u5177\u4e1a\u52a1\u4ef7\u503c\u7684\u6570\u636e\u5206\u6790\u3002\n- **\u591a\u667a\u80fd\u4f53\u534f\u540c\u5de5\u4f5c**\uff1aairda\u91c7\u7528\u9762\u5411\u6570\u636e\u5206\u6790\u9700\u6c42\u7684\u591a\u8f6e\u5bf9\u8bdd\u8bbe\u8ba1\uff0c\u591a\u667a\u80fd\u4f53\u53ef\u4ee5\u534f\u540c\u5de5\u4f5c\uff0c\u8fdb\u884c\u6570\u636e\u5206\u6790\u4ee3\u7801\u7684self-debug\uff0c\u63d0\u5347\u5206\u6790\u6548\u7387\uff0c\u964d\u4f4e\u9519\u8bef\u7387\u3002\n- **\u6570\u636e\u53ef\u89c6\u5316**\uff1aairda\u53ef\u4ee5\u5c06\u590d\u6742\u7684\u6570\u636e\u901a\u8fc7\u53ef\u89c6\u5316\u7684\u65b9\u5f0f\u5448\u73b0\uff0c\u8ba9\u6570\u636e\u5206\u6790\u7ed3\u679c\u66f4\u6613\u4e8e\u7406\u89e3\uff0c\u5e2e\u52a9\u60a8\u66f4\u597d\u5730\u505a\u51fa\u51b3\u7b56\u3002\n### airda\u5de5\u4f5c\u6d41\u7a0b\uff1a\n- **\u9700\u6c42\u786e\u8ba4\uff1a** airda\u4e0e\u7528\u6237\u5efa\u7acb\u5bf9\u8bdd\uff0c\u7406\u89e3\u7528\u6237\u7684\u9700\u6c42\u3002\u5728\u8fd9\u4e00\u9636\u6bb5\uff0cairda\u4f1a\u63d0\u51fa\u4e00\u7cfb\u5217\u95ee\u9898\uff0c\u4ee5\u4fbf\u66f4\u51c6\u786e\u5730\u4e86\u89e3\u7528\u6237\u7684\u9700\u6c42\u3002\n- **\u4efb\u52a1\u89c4\u5212\uff1a** airda\u4f1a\u6839\u636e\u6700\u7ec8\u786e\u8ba4\u7684\u9700\u6c42\u5185\u5bb9\u4e3a\u7528\u6237\u5236\u5b9a\u4efb\u52a1\u89c4\u5212\u3002\u8fd9\u4e2a\u89c4\u5212\u5305\u62ec\u4e00\u7cfb\u5217\u6b65\u9aa4\uff0cairda\u4f1a\u6309\u7167\u8fd9\u4e9b\u6b65\u9aa4\u6765\u4e3a\u7528\u6237\u63d0\u4f9b\u670d\u52a1\u3002\n- **\u4efb\u52a1\u6267\u884c\uff1a** airda\u5c06\u89c4\u5212\u597d\u7684\u4efb\u52a1\u5206\u914d\u7ed9\u4e0d\u540c\u7684\u667a\u80fd\u4f53\uff0c\u5982\u6570\u636e\u67e5\u627e\u667a\u80fd\u4f53\u3001SQL\u751f\u6210\u667a\u80fd\u4f53\u3001\u4ee3\u7801\u751f\u6210\u667a\u80fd\u4f53\u3001\u53ef\u89c6\u5316\u5206\u6790\u667a\u80fd\u4f53\u7b49\u3002\u6bcf\u4e2a\u667a\u80fd\u4f53\u8d1f\u8d23\u5176\u4e13\u4e1a\u9886\u57df\u7684\u4efb\u52a1\u6267\u884c\uff0c\u534f\u540c\u5de5\u4f5c\u4ee5\u786e\u4fdd\u4efb\u52a1\u7684\u9ad8\u6548\u5b8c\u6210\u3002\n- **\u5e94\u7528\u751f\u6210\uff1a** airda\u6839\u636e\u7528\u6237\u9700\u6c42\u4efb\u52a1\u5c06\u7ed3\u679c\u6570\u636e\u8f6c\u5316\u4e3a\u5e94\u7528\u6210\u679c\uff0c\u5982\u6307\u6807\u5927\u5c4f\u5c55\u793a\u3001\u6570\u636eAPI\u670d\u52a1\u548c\u6570\u636e\u5e94\u7528\u7b49\uff0c\u8fd9\u4e9b\u6210\u679c\u80fd\u591f\u4ee5\u53ef\u89c6\u5316\u7684\u5f62\u5f0f\u5c55\u793a\u5173\u952e\u6570\u636e\u6307\u6807\uff0c\u63d0\u4f9bAPI\u63a5\u53e3\u4f9b\u5176\u4ed6\u7cfb\u7edf\u6216\u670d\u52a1\u8c03\u7528\uff0c\u4ee5\u53ca\u6839\u636e\u7528\u6237\u9700\u6c42\u751f\u6210\u5177\u4f53\u7684\u5e94\u7528\u7a0b\u5e8f\u3002\n\n### \u5b8c\u6210\u8fdb\u5ea6\uff1a\n\n- [x] SQL\u751f\u6210\n- [x] \u6570\u636e\u63a5\u5165\n- [x] \u77e5\u8bc6\u5e93\n- [ ] \u8bed\u6599\u5e93\n- [ ] \u56fe\u8868\u751f\u6210\n- [ ] \u4efb\u52a1\u89c4\u5212\n\n## \u2728 \u5feb\u901f\u5f00\u59cb\n\n### \u73af\u5883\u8981\u6c42\n\nPython>=3.10\n\n### \u5b89\u88c5 airda\n\npip\u5b89\u88c5\n\n```\npip install airda -i https://pypi.python.org/simple/\n```\n\n### \u4f9d\u8d56\u5b89\u88c5\n\n\u4f7f\u7528airda\u9700\u8981\u7528\u5230mongodb,\u53ef\u91c7\u7528docker\u5b89\u88c5mongodb\n\n```\n#\u62c9\u53d6mongo\u955c\u50cf\ndocker pull mongo\ndocker run -itd --name mongo -v /{path_of_mongo_data}:/data/db -p 27017:27017 mongo\n\n```\n\n### \u81ea\u5b9a\u4e49\u914d\u7f6e\n\n\u73af\u5883\u53d8\u91cf\n\n\u4e0b\u8f7dhttps://github.com/hitsz-ids/airda/blob/main/.env.template\u6587\u4ef6,\u81ea\u5b9a\u4e49embedding\u6a21\u578b,mongo\u914d\u7f6e,\u4ee5\u53caopenai\u914d\u7f6e\n\n```\nairda env load -p {your_path}/.env_template\n```\n\n\u65e5\u5fd7\u6587\u4ef6\uff08\u975e\u5fc5\u987b\uff09\n\n\u4e0b\u8f7dhttps://github.com/hitsz-ids/airda/blob/main/log_config.yml.template\u6587\u4ef6,\u81ea\u5b9a\u4e49\u65e5\u5fd7\u914d\u7f6e\n\n```\nairda log load -p {your_path}/log_config.yml.template\n```\n\n\n\n### \u76f8\u5173\u914d\u7f6e\u547d\u4ee4\n\n\u6dfb\u52a0\u4f60\u7684\u6570\u636e\u6e90\n```\nairda datasource add -n {datasource_name} -h {host} -p {port} -k MYSQL -d {database} -u {username} -w {password}\n#\u5f53\u524d\u53ea\u652f\u6301kind\u4e3aMYSQL\u7684\u6570\u636e\u6e90\n```\n\u8bad\u7ec3\u6570\u636e\u6e90\u7684schema\n\n```\nairda datasource sync -n {datasource_name}\n```\n\u67e5\u8be2\u5f53\u524d\u53ef\u7528\u7684\u6570\u636e\u6e90\n```\nairda datasource ls\n```\n\n### \u5f00\u59cb\u95ee\u7b54\n\n```\nairda run cli -n {datasource_name}\n#\u8f93\u5165\u4f60\u7684\u95ee\u9898:\n```\n\n\n\n\n\n\n\n## \ud83d\udc4f \u8d21\u732e\n\n\u6211\u4eec\u6b22\u8fce\u5404\u79cd\u8d21\u732e\u548c\u5efa\u8bae\uff0c\u5171\u540c\u52aa\u529b\uff0c\u4f7f\u672c\u9879\u76ee\u66f4\u4e0a\u4e00\u5c42\u697c\uff01\u9ebb\u70e6\u9075\u5faa\u4ee5\u4e0b\u6b65\u9aa4\uff1a\n\n- **\u6b65\u9aa41\uff1a** \u5982\u679c\u60a8\u60f3\u6dfb\u52a0\u4efb\u4f55\u989d\u5916\u7684\u529f\u80fd\u3001\u589e\u5f3a\u529f\u80fd\u6216\u5728\u4f7f\u7528\u8fc7\u7a0b\u4e2d\u9047\u5230\u4efb\u4f55\u95ee\u9898\uff0c\u8bf7\u53d1\u5e03\u4e00\u4e2a [\u95ee\u9898](https://github.com/hitsz-ids/SQLAgent/issues) \u3002\u5982\u679c\u60a8\u80fd\u9075\u5faa [\u95ee\u9898\u6a21\u677f](https://github.com/hitsz-ids/SQLAgent/issues/1) \u6211\u4eec\u5c06\u4e0d\u80dc\u611f\u6fc0\u3002\u95ee\u9898\u5c06\u5728\u90a3\u91cc\u88ab\u8ba8\u8bba\u548c\u5206\u914d\u3002\n- **\u6b65\u9aa42\uff1a** \u65e0\u8bba\u4f55\u65f6\uff0c\u5f53\u4e00\u4e2a\u95ee\u9898\u88ab\u5206\u914d\u540e\uff0c\u60a8\u90fd\u53ef\u4ee5\u6309\u7167 [PR\u6a21\u677f](https://github.com/hitsz-ids/SQLAgent/pulls) \u521b\u5efa\u4e00\u4e2a [\u62c9\u53d6\u8bf7\u6c42](https://github.com/hitsz-ids/SQLAgent/pulls) \u8fdb\u884c\u8d21\u732e\u3002\u60a8\u4e5f\u53ef\u4ee5\u8ba4\u9886\u4efb\u4f55\u516c\u5f00\u7684\u95ee\u9898\u3002\u5171\u540c\u52aa\u529b\uff0c\u6211\u4eec\u53ef\u4ee5\u4f7fairda\u53d8\u5f97\u66f4\u597d\uff01\n- **\u6b65\u9aa43\uff1a** \u5728\u5ba1\u67e5\u548c\u8ba8\u8bba\u540e\uff0cPR\u5c06\u88ab\u5408\u5e76\u6216\u8fed\u4ee3\u3002\u611f\u8c22\u60a8\u7684\u8d21\u732e\uff01\n\n\u5728\u60a8\u5f00\u59cb\u4e4b\u524d\uff0c\u6211\u4eec\u5f3a\u70c8\u5efa\u8bae\u60a8\u82b1\u4e00\u70b9\u65f6\u95f4\u68c0\u67e5 [\u8fd9\u91cc](https://github.com/hitsz-ids/SQLAgent/blob/developing/CONTRIBUTING.md) \u518d\u8fdb\u884c\u8d21\u732e\u3002\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "airda",
"version": "0.0.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "08965bb43ccdd2462f9b69a7de93d94eb243685463cc43e0ad8f3bcb4cae435e",
"md5": "537b9d81c2ca79d5344938d97a80ce24",
"sha256": "bc9452949d517f0fc329efe6d1cbeaef7fef38faf2127e25fa6fdcf615a74173"
},
"downloads": -1,
"filename": "airda-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "537b9d81c2ca79d5344938d97a80ce24",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 60100,
"upload_time": "2024-04-26T11:17:51",
"upload_time_iso_8601": "2024-04-26T11:17:51.619459Z",
"url": "https://files.pythonhosted.org/packages/08/96/5bb43ccdd2462f9b69a7de93d94eb243685463cc43e0ad8f3bcb4cae435e/airda-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a0607e10c18f7dd866ec9334ca05fd2d12297e3d39643ae59d7bae89e4f23a0e",
"md5": "15e4cec855a4004e85bb5aea2d20d370",
"sha256": "c6a7a2aede85c1dc02973088a6f416e1f0c53120fc62605946cb000c1267521f"
},
"downloads": -1,
"filename": "airda-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "15e4cec855a4004e85bb5aea2d20d370",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 33860,
"upload_time": "2024-04-26T11:17:52",
"upload_time_iso_8601": "2024-04-26T11:17:52.861203Z",
"url": "https://files.pythonhosted.org/packages/a0/60/7e10c18f7dd866ec9334ca05fd2d12297e3d39643ae59d7bae89e4f23a0e/airda-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 11:17:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "airda"
}
