memvid

⚠ 该项目 README 未提供完整安装说明，以下步骤为通用流程，请以官方文档为准。

环境要求

• 本地已安装 Rust 工具链与 Cargo（README 未指定具体版本）
• 能访问 crates.io 拉取 memvid-core 依赖
• 系统有可写的用户缓存目录（用于存放本地嵌入模型）
• 如需使用 OpenAI 嵌入，需要 OpenAI API Key

安装与启动步骤

1. 1克隆项目源码

   从 GitHub 拉取 memvid 仓库并进入目录，后续示例与测试都在仓库内运行。

   git clone https://github.com/memvid/memvid.git
   cd memvid

   复制

2. 2确认 Rust 环境

   README 的 Installation (Rust) 一节未给出具体安装命令，请先自行确保 cargo 可用。

   cargo --version

   复制

3. 3运行测试验证

   跑全部测试确认编译与依赖正常，调试时可加 --nocapture 查看输出。

   cargo test

   复制

4. 4运行入门示例

   执行仓库自带的 basic_usage 示例，体验创建、写入、检索与时间线操作。

   cargo run --example basic_usage

   复制

5. 5下载本地嵌入模型

   创建 BGE-small 本地文本模型缓存目录，默认嵌入为 384 维，无需 API Key。

   mkdir -p ~/.cache/memvid/text-models

   复制

6. 6配置 OpenAI 密钥

   仅在改用 OpenAI 嵌入时需要；密钥写入环境变量，不要硬编码进源码。

   export OPENAI_API_KEY="sk-xxxxxxxx"

   复制

7. 7在代码中调用

   创建单文件记忆库 knowledge.mv2，写入内容后需 commit 才能持久化，再用 search 检索。

   use memvid_core::{Memvid, PutOptions, SearchRequest};
   
   fn main() -> memvid_core::Result<()> {
       let mut mem = Memvid::create("knowledge.mv2")?;
   
       let opts = PutOptions::builder()
           .title("Meeting Notes")
           .uri("mv2://meetings/2024-01-15")
           .tag("project", "alpha")
           .build();
       mem.put_bytes_with_options(b"Q4 planning discussion...", opts)?;
       mem.commit()?;
   
       let response = mem.search(SearchRequest {
           query: "planning".into(),
           top_k: 10,
           snippet_chars: 200,
           ..Default::default()
       })?;
   
       for hit in response.hits {
           println!("{}: {}", hit.title.unwrap_or_default(), hit.text);
       }
       Ok(())
   }

   复制

关键配置

如何确认成功

cargo test 全部通过，或 cargo run --example basic_usage 能打印出检索到的标题与文本，即表示环境可用。

常见问题

注意事项

• README 节选中 Installation (Rust) 一节为空，未给出 cargo add / cargo install 等依赖安装命令，请自行将 memvid-core 加入项目依赖。
• 调试测试输出可执行 cargo test -- --nocapture。
• 检索参数如 top_k、snippet_chars 可按需调整，检索结果通过 response.hits 遍历。