diff --git a/README.md b/README.md index 23424ae7..fc1cb425 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,8 @@ 1、本项目为开源软件,本软件与对接的任何第三方API服务商(包括但不限于语音识别、大模型、语音合成等平台)均不存在商业合作关系,不为其服务质量及资金安全提供任何形式的担保。 建议使用者优先选择持有相关业务牌照的服务商,并仔细阅读其服务协议及隐私政策。本软件不托管任何账户密钥、不参与资金流转、不承担充值资金损失风险。 -2、本项目成立时间较短,还未通过网络安全测评,请勿在生产环境中使用。 如果您在公网环境中部署学习本项目,请务必在配置文件 `config.yaml` 中开启防护: +2、本项目成立时间较短,还未通过网络安全测评,请勿在生产环境中使用。 如果您在公网环境中部署学习本项目,请务必在配置文件 +`config.yaml` 中开启防护: ```yaml server: @@ -193,6 +194,14 @@ server: --- +### Memory + +| 类型 | 平台名称 | 使用方式 | 收费模式 | 备注 | +|:------:|:------:|:----:|:----:|:--:| +| Memory | mem0ai | 接口调用 | 免费 | | + +--- + ## 使用方式 🚀 ### 一、[部署文档](./docs/Deployment.md) diff --git a/config.yaml b/config.yaml index 4185640b..6d9cd989 100644 --- a/config.yaml +++ b/config.yaml @@ -85,7 +85,8 @@ selected_module: Memory: mem0ai: type: mem0ai - # https://app.mem0.ai/dashboard/api-keys,注册可获得试用credits + # https://app.mem0.ai/dashboard/api-keys + # 每月有1000次免费调用 api_key: 你的mem0ai api key ASR: diff --git a/docs/Deployment.md b/docs/Deployment.md index 81c4d7f9..8f5b4f91 100644 --- a/docs/Deployment.md +++ b/docs/Deployment.md @@ -231,9 +231,10 @@ python app.py 如果你的`项目目录`目录没有`data`,你需要创建`data`目录。 如果你的`data`下面没有`.config.yaml`文件,你可以把源码目录下的`config.yaml`文件复制一份,重命名为`.config.yaml` -修改`项目目录`下`data`目录下的`.config.yaml`文件,配置本项目所需的各种参数。默认的LLM使用的是`ChatGLMLLM` -,你需要配置密钥,因为他们的模型,虽然有免费的,但是仍要去[官网](https://bigmodel.cn/usercenter/proj-mgmt/apikeys)注册密钥,才能启动。 -默认的TTS使用的是`EdgeTTS`,这个无需配置,如果你需要更换成`豆包TTS`,则需要配置密钥。 +修改`项目目录`下`data`目录下的`.config.yaml`文件,配置本项目必须的两个配置。 + +- 默认的LLM使用的是`ChatGLMLLM`,你需要配置密钥,因为他们的模型,虽然有免费的,但是仍要去[官网](https://bigmodel.cn/usercenter/proj-mgmt/apikeys)注册密钥,才能启动。 +- 默认的记忆层`mem0ai`,你需要配置密钥,因为他们的API,虽然有免费额度,但是仍要去[官网](https://app.mem0.ai/dashboard/api-keys)注册密钥,才能启动。 配置说明:这里是各个功能使用的默认组件,例如LLM默认使用`ChatGLMLLM`模型。如果需要切换模型,就是改对应的名称。 本项目的默认配置仅是成本最低配置(`glm-4-flash`和`EdgeTTS`都是免费的),如果需要更优的更快的搭配,需要自己结合部署环境切换各组件的使用。 diff --git a/requirements.txt b/requirements.txt index 4d75889d..9716c825 100755 --- a/requirements.txt +++ b/requirements.txt @@ -17,4 +17,6 @@ ormsgpack==1.7.0 ruamel.yaml==0.18.10 loguru==0.7.3 requests==2.32.3 -cozepy==0.12.0 \ No newline at end of file +cozepy==0.12.0 +miniaudio==1.61 +mem0ai==0.1.62