kernel-memory

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

环境要求

• Docker 环境（README 提供 kernelmemory/service 容器镜像）
• OpenAI API Key（示例中用 OpenAI 作为文本生成与嵌入模型）
• 一个向量数据库，如 Azure AI Search 或 Qdrant
• 可选：.NET / Aspire、Semantic Kernel 等集成环境

安装与启动步骤

1. 1确认项目定位

   README 顶部声明这是已归档的研究项目，代码仅作学习参考，不是生产软件，无官方支持，使用风险自负。

2. 2准备密钥与向量库

   KM 通过 LLM 生成嵌入并写入向量索引，需先准备 OpenAI API Key，以及 Azure AI Search、Qdrant 等向量库之一。

3. 3用 Aspire 启动容器

   README 给出的 Aspire 示例：以 kernelmemory/service 镜像添加容器，并通过环境变量指定 OpenAI 文本生成、嵌入生成与检索嵌入类型及 API Key。

   var builder = DistributedApplication.CreateBuilder();
   
   builder.AddContainer("kernel-memory", "kernelmemory/service")
       .WithEnvironment("KernelMemory__TextGeneratorType", "OpenAI")
       .WithEnvironment("KernelMemory__DataIngestion__EmbeddingGeneratorTypes__0", "OpenAI")
       .WithEnvironment("KernelMemory__Retrieval__EmbeddingGeneratorType", "OpenAI")
       .WithEnvironment("KernelMemory__Services__OpenAI__APIKey", "sk-xxxxxxxx");
   
   builder.Build().Run();

   复制

4. 4索引文档数据

   通过 Kernel Memory OpenAPI Web Service 调用默认摄入管道：提取文本→分块→生成嵌入→写入向量索引；用 Tags 标注文档归属以隔离私有信息。

5. 5按需选择集成方式

   KM 还提供 .NET 库（用于嵌入式应用）与 Plugin（用于 ChatGPT/Copilot/Semantic Kernel），README 未给出对应安装命令。

关键配置

如何确认成功

README 未给出启动成功校验方式；服务以 Web Service/OpenAPI 形式对外提供，可据此确认服务已运行。

常见问题

注意事项

• 项目已归档，代码仅作演示与学习参考，非官方支持的 Microsoft 产品
• README 未提供 pip/npm/docker run 等具体安装命令，本教程步骤以 README 明确提及的容器镜像与配置项为准
• 示例中的 API Key 请替换为你自己的真实密钥，切勿提交到代码仓库
• 嵌入式应用集成可参考 .NET 库方式，具体用法需查阅仓库文档