doc: readme, example query

Author: tbjuechen

README.md

@@ -0,0 +1,16 @@
+# Usage
+
+### docker
+
+```bash
+docker run -d ghcr.io/ec-rag/ec-rag:latest -v path/to/your/config:/app/config.yaml
+```
+
+### source code
+
+```bash
+git clone https://github.com/EC-RAG/backend.git
+cd backend
+pip install -r requirements.txt
+python main.py
+```

app/routers/graph_route.py

@@ -22,7 +22,6 @@ async def gen_graph(ws: WebSocket):
         sql = await client.generate_sql()
         await ws.send_json({"type":'sql',"data": sql})
         data = client.load_data()
-        print(convert_array_to_list(data.head().to_dict()))
         await ws.send_json({"type":'data',"data": {"data": convert_array_to_list(data.head().to_dict())}})
         res = await client.generate_graph()
         res = convert_array_to_list(res)

example/ex_config.yaml

@@ -0,0 +1,20 @@
+database:
+  mysql:
+    host: 127.0.0.1
+    port: 3306
+    user: 
+    password: 
+  
+  chromadb:
+    name: chromadb.db
+
+models:
+  llm:
+    type: deepseek 
+    api_key: 
+    model: deepseek-chat
+
+  embedding:
+    base_url: https://ark.cn-beijing.volces.com/api/v3
+    api_key: 
+    model: doubao-embedding-text-240715

example/ex_query.md

@@ -4,4 +4,10 @@ Q：查询奥利奥旗舰店的退款率
 
 ![1746786497331](images/ex_query/1746786497331.png)
 
-Q: 查询
+Q: 在测试表中 四月20日店铺A 三张种商品的销售额占比
+
+![1746806441523](images/ex_query/1746806441523.png)
+
+Q: 测试表种店铺B在四月一号到五号 商品ABC分别销量是多少
+
+![1746806784426](images/ex_query/1746806784426.png)

example/images/ex_query/1746806441523.png

@@ -44,4 +44,4 @@
 
     # 根据环境变量设置 reload 参数
     reload = env == "development"
-    uvicorn.run('main:app', host="0.0.0.0", port=8000, reload=reload, workers=None)
+    uvicorn.run('main:app', host="0.0.0.0", port=8188, reload=reload, workers=None)

example/images/ex_query/1746806784426.png

@@ -4,4 +4,5 @@ langchain-openai
 pandas
 chromadb
 pydantic
-pymysql
+pymysql
+loguru