diff --git a/README.md b/README.md index f05c7a24..a6bb9d9a 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,12 @@ -### 准备 +## 准备 1. 提供 API 服务商的 API_KEY,并放置在 `src/.env` 文件中,参考 `src/.env.template`。默认使用的是智谱AI。 2. 配置 python 环境 `pip install -r requirements.txt` -**如果不启用知识库,可以jin** +**如果不启用知识库,可以仅安装下面的依赖** ``` FlagEmbedding==1.2.10 @@ -20,14 +20,19 @@ PyYAML==6.0.1 zhipuai ``` +### 【可选】配置图数据库 neo4j -### 启动命令行模式 +使用 docker 部署 neo4j 服务,配置文件见 [local_neo4j/docker-compose.yml](local_neo4j/docker-compose.yml). 默认账号密码见最后一行,可以使用 `http://localhost:7474/` 在浏览器可视化访问。 ```bash -python -m src.cli +cd local_neo4j +docker compose up -d ``` -### 启动网页模式 +可以使用 `python test_neo4j.py` 来测试是否正常启动。使用 `docker compose down` 可停止服务。 + + +## 启动 ```bash python -m src.api