Memoripy 使用教程

Memoripy 使用教程

memoripy An AI memory layer with short- and long-term storage, semantic clustering, and optional memory decay for context-aware applications. 项目地址: https://gitcode.com/gh_mirrors/me/memoripy

1. 项目目录结构及介绍

Memoripy 是一个用于管理上下文感知内存交互的 Python 库。以下是项目的目录结构及其说明：

memoripy/
├── examples/                # 存放示例代码
├── memoripy/                # 包含 Memoripy 库的主要代码
│   ├── __init__.py          # 初始化模块
│   ├── MemoryManager.py     # 内存管理器类
│   ├── MemoryStore.py       # 内存存储类
│   ├── BaseStorage.py       # 存储方法的基础类
│   ├── InMemoryStorage.py   # 内存存储选项
│   ├── JSONStorage.py       # JSON 文件存储选项
│   └── ...                 # 其他模块和类
├── .gitignore               # 指定 Git 忽略的文件
├── LICENSE                  # Apache-2.0 许可证文件
├── README.md                # 项目描述文件
├── requirements.txt         # 项目依赖
└── setup.py                 # 设置安装脚本

2. 项目的启动文件介绍

Memoripy 的启动和初始化通常在 MemoryManager 类中完成。以下是一个简单的启动文件示例，演示如何使用 Memoripy：

from memoripy import MemoryManager, JSONStorage
from memoripy.implemented_models import OpenAIChatModel, OllamaEmbeddingModel

def main():
    api_key = "your-key"  # 替换为你的 OpenAI API 密钥
    if not api_key:
        raise ValueError("请设置你的 OpenAI API 密钥。")

    storage_option = JSONStorage("interaction_history.json")  # 或者使用 InMemoryStorage()
    memory_manager = MemoryManager(
        OpenAIChatModel(api_key, chat_model_name="gpt-4o-mini"),
        OllamaEmbeddingModel(embedding_model_name="mxbai-embed-large"),
        storage=storage_option
    )
    # 使用 memory_manager 进行交互和管理
    ...

if __name__ == "__main__":
    main()

3. 项目的配置文件介绍

Memoripy 的配置主要是通过修改 requirements.txt 文件来完成的，该文件列出了项目运行所需的依赖。以下是一个示例配置：

openai
faiss-cpu
numpy
networkx
scikit-learn
langchain
ollama

此外，如果需要使用不同的存储选项或模型设置，你可以在创建 MemoryManager 实例时传递相应的配置参数。例如，你可以选择不同的存储后端，如 JSONStorage 或 InMemoryStorage，或者配置不同的模型参数。

请注意，任何敏感信息，如 API 密钥，不应直接硬编码在代码中，而是应通过环境变量或配置文件安全地管理。

memoripy An AI memory layer with short- and long-term storage, semantic clustering, and optional memory decay for context-aware applications. 项目地址: https://gitcode.com/gh_mirrors/me/memoripy