Memobase 使用与配置指南

Memobase 使用与配置指南

memobase Profile-Based Long-Term Memory for AI Applications 项目地址: https://gitcode.com/gh_mirrors/me/memobase

1. 项目目录结构及介绍

Memobase 是一个基于用户档案的记忆系统，旨在为生成式 AI 应用程序带来长期用户记忆。以下是 Memobase 的目录结构及其各部分的简要介绍：

memobase/
├── .github/              # GitHub 工作流和模板
├── assets/               # 静态资源，如图标、图片等
├── docs/                 # 项目文档
├── src/                  # 源代码
├── .gitignore            # Git 忽略文件
├── CONTRIBUTING.md       # 贡献指南
├── Changelog.md          # 更新日志
├── LICENSE               # 许可证文件
├── MANIFEST.in           # 打包配置文件
├── README.md             # 项目说明文件
├── requirements.txt      # 项目依赖
├── setup.py              # 设置文件，用于安装 Python 包

2. 项目的启动文件介绍

Memobase 的启动主要依赖于 Python SDK。以下是如何使用 Python SDK 启动 Memobase 的基本步骤：

首先，您需要安装 Memobase 的 Python SDK：

pip install memobase

然后，您可以使用以下代码启动 Memobase：

from memobase import MemoBaseClient, ChatBlob

# 配置项目 URL 和 token
mb = MemoBaseClient(project_url=PROJECT_URL, api_key=PROJECT_TOKEN)

# 确保 MemoBase 服务正在运行
assert mb.ping()

# 添加、更新、获取用户信息
uid = mb.add_user({"any_key": "any_value"})
mb.update_user(uid, {"any_key": "any_value2"})
u = mb.get_user(uid)

# 插入数据
messages = [
    {"role": "user", "content": "Hello, I'm Gus"},
    {"role": "assistant", "content": "Hi, nice to meet you, Gus!"}
]
bid = u.insert(ChatBlob(messages=messages))

# 获取记忆
u.flush()
print(u.profile(need_json=True))

这段代码演示了如何与 MemoBase 服务交互，包括添加用户、更新用户信息、插入数据和获取用户记忆。

3. 项目的配置文件介绍

Memobase 的配置文件通常是 config.py 或 .env 文件，其中包含项目运行所需的配置信息。以下是一些基本的配置选项：

• project_url: MemoBase 服务地址
• api_key: 用于身份验证的项目 token
• flush_interval: 缓冲区刷新间隔，单位为秒
• max_buffer_size: 缓冲区最大大小，单位为 token 数

一个简单的配置文件示例可能如下所示：

# config.py
project_url = 'http://localhost:8019'
api_key = 'secret'
flush_interval = 3600  # 1小时刷新一次
max_buffer_size = 1024  # 缓冲区大小为1024个token

确保您在实际部署时更新这些配置，以符合您的实际需求和环境。

memobase Profile-Based Long-Term Memory for AI Applications 项目地址: https://gitcode.com/gh_mirrors/me/memobase