Metadata-Version: 2.1
Name: rmb-client
Version: 0.11.2
Summary: RMB SDK.
Home-page: https://github.com/DataMini/rmb
Author: lele
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: tabulate
Requires-Dist: pybase62

# 元数据大脑 Reliable Meta Brain（RMB）
[![Docker image](https://github.com/DataMini/rmb/actions/workflows/docker-image.yml/badge.svg)](https://github.com/DataMini/rmb/actions/workflows/docker-image.yml)

# Feature （功能）

- DataSource 支持 Excel/CSV/MySQL
- 支持以对话方式查询数据 
- 支持多轮对话
- 支持更新 Meta（字典/同义词），以识别意图，提高准确率
- 提供Restful API & Python SDK
- Excel的跨表关联查询
- Meta增强（获取数据样例便于生成准确的包含常量的Query语句，比如需要让LLM知道是sex='男'还是sex=1）

# Backlog（计划）
- 支持微信文档中的表格
- 支持飞书、钉钉表格、Airtable表格
- 支持跨数据源（MySQL+MySQL,MySQL+Hive）的联合查询



# Installation（安装）

- 安装客户端
```
pip install rmb-client
rmb-client -a https://api.rmb.datamini.ai/ -t token01
```

- 安装&运行服务端

方法1：通过pip
```
$ pip install rmb-server
$ rmb-server
```

方法2：通过docker（推荐）
镜像维护在 [hub.docker.com](https://hub.docker.com/repository/docker/datamini/rmb-server/general)
```
$ docker run -d -p 5000:5000 datamini/rmb-server
```

# 多租户

RMB 采用多租户架构，每个租户只可以查看自己的数据源、对话等信息。

参考文档 [README_AUTH.md](README_AUTH.md)


# 客户端CLI&SDK

RMB 客户端提供了命令行CLI和Python SDK两种方式来访问RMB。

参考文档 [rmbclient/README.md](rmbclient%2FREADME.md)


# 参与开发

本地环境启动

1. 先 `git clone ...`
2. 编辑配置文件  在目录 `rmbserver/config/` 下，执行 `cp default.py custom.py ` 然后编辑`custom.py`文件
3. pip install -r requirements.txt
4. 启动服务 `python rmbserver/run.py [<host> <port>]`
5. 运行客户端 `python rmbclient/cli.py [-a http://localhost:5000/ -t token01]`
