chromem-go

环境要求

• 已安装 Go 工具链，终端可直接执行 go 命令（README 未指定最低版本）
• 使用 OpenAI 嵌入时需准备 OPENAI_API_KEY 环境变量
• 若改用 Ollama 本地嵌入模型，需本地已运行 Ollama 服务
• 无需另行部署 Chroma 或其他外部数据库服务

安装与启动步骤

1. 1初始化 Go 模块

   为项目创建 go.mod，作为后续拉取依赖的基础；已有模块可跳过此步。

   go mod init your-module-name

   复制

2. 2安装 chromem-go

   README 给出的唯一安装命令，直接拉取最新版本作为项目依赖。

   go get github.com/philippgille/chromem-go@latest

   复制

3. 3配置嵌入密钥

   示例中 CreateCollection 传 nil 表示使用 OpenAI 嵌入，必须设置该环境变量。

   export OPENAI_API_KEY=sk-xxxxxxxx

   复制

4. 4编写最小示例

   把 README 的 minimal 示例保存为 main.go，创建集合、写入文档并查询。

   package main
   
   import (
   	"context"
   	"fmt"
   	"runtime"
   
   	"github.com/philippgille/chromem-go"
   )
   
   func main() {
   	ctx := context.Background()
   
   	db := chromem.NewDB()
   
   	// Passing nil as embedding function leads to OpenAI being used and requires
   	// "OPENAI_API_KEY" env var to be set. Other providers are supported as well.
   	// For example pass `chromem.NewEmbeddingFuncOllama(...)` to use Ollama.
   	c, err := db.CreateCollection("knowledge-base", nil, nil)
   	if err != nil {
   		panic(err)
   	}
   
   	err = c.AddDocuments(ctx, []chromem.Document{
   		{
   			ID:      "1",
   			Content: "The sky is blue because of Rayleigh scattering.",
   		},
   		{
   			ID:      "2",
   			Content: "Leaves are green because chlorophyll absorbs red and blue light.",
   		},
   	}, runtime.NumCPU())
   	if err != nil {
   		panic(err)
   	}
   
   	res, err := c.Query(ctx, "Why is the sky blue?", 1, nil, nil)
   	if err != nil {
   		panic(err)
   	}
   
   	fmt.Printf("ID: %v\nSimilarity: %v\nContent: %v\n", res[0].ID, res[0].Similarity, res[0].Content)
   }

   复制

5. 5运行示例程序

   运行后会调用嵌入模型并做相似度检索，首次运行需联网访问嵌入接口。

   go run main.go

   复制

关键配置

如何确认成功

程序输出 ID: 1、Similarity 约为 0.6833369、Content 为 The sky is blue because of Rayleigh scattering. 即成功。

常见问题

注意事项

• 本库定位是简洁与常见场景的性能，不以百万级文档规模或功能数量为目标。
• 官方 README 的基准数据：中端 2020 款 Intel 笔记本 CPU 上查询 1000 条约 0.3 ms，100000 条约 40 ms。
• 它既不是连接 Chroma 的客户端，也不是 Chroma 的 Go 重写，而是一个独立的数据库。
• README 的 minimal 示例需要联网调用嵌入模型，离线场景请改用 Ollama 等本地嵌入函数。