# Prophet **Repository Path**: chhw/prophet ## Basic Information - **Project Name**: Prophet - **Description**: **Prophet**(先知)- 一个专为 C# 开发者设计的现代化 AI Agent 开发框架 - **Primary Language**: C# - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1 - **Created**: 2026-11-09 - **Last Updated**: 2026-11-09 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Prophet > 面向 .NET 的 AI Agent 库:对话、工具调用、记忆与 RAG 等能力以可组合包的形式提供,并带有示例应用与大量自动化测试。 [![.NET](https://img.shields.io/badge/.NET-8.0-512BD4?logo=dotnet)](https://dotnet.microsoft.com/) [![C#](https://img.shields.io/badge/C%23-12.0-239120?logo=c-sharp)](https://docs.microsoft.com/dotnet/csharp/) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) ## 项目定位 Prophet 将 **LLM 调用、Agent 编排、内置工具、记忆与向量检索** 拆成多个项目,便于在控制台、自建宿主或 ASP.NET Core 应用中按需引用。仓库同时包含 **示例工程**(`examples/`)和 **可运行的 Web 应用**(`apps/Prophet.Web`),用于验证端到端场景。 API 与模块边界仍在演进;以源码与测试为准,文档描述的是**当前方向**,而非已全部完成的商业产品特性清单。 ## 当前能力(与代码一致) - **多 LLM**:OpenAI 兼容(`OpenAIProvider`)、Ollama、通义千问(`QianwenProvider`)、智谱、火山方舟(`VolcengineArkProvider`)、Mock;可通过 `IProvider` 自行接入其他服务。使用 `Prophet.Hosting` 时,`AddProphetRuntime` 支持 `Provider:Mode` 为 **`OpenAI` / `VolcengineArk` / `Qianwen` / `Zhipu`**(未满足条件时回退 Mock);详见 [Provider 指南](docs/references/providers.md) 中的「宿主配置(AddProphetRuntime)」一节。 - **模块化仓库结构**:`Prophet.Abstractions` / `Prophet.Models` / `Prophet.Orchestration` / `Prophet.Core` 等;宿主侧有 `Prophet.Hosting`、`Prophet.AspNetCore`。 - **工具**:核心包内提供多类 `ITool`(如计算器、HTTP、文件读写、日期时间、网络搜索、代码执行等);**`DatabaseQueryTool` / `RagQueryTool`** 需在 DI 中提供 `DbContext` 工厂或 `RagService` 后才会出现在内置工具枚举的“带依赖”路径中(见 `ToolRegistry.GetBuiltInTools(IServiceProvider)`)。**`Prophet.Hosting` 的默认注册仅挂载部分常用工具**(计算器、HTTP、文件、日期等),与“核心包内全部工具”不完全相同;需要时在应用中自行 `AddTool<>`。 - **对话与编排**:Agent、链式/条件/并行编排、工作流引擎等(详见示例与 `Prophet.Orchestration` 测试)。 - **记忆与 RAG**:会话内短期记忆、长期记忆(含内存实现与 **EF Core + SQLite** 持久化路径)、向量存储(**Qdrant / Chroma** 包与示例)、RAG 服务与可选工具。 - **插件扩展**:存在插件管理器与加载扩展点;示例中有自定义工具/Provider 插件代码。**从磁盘自动扫描加载**等能力以实际 `PluginServiceCollectionExtensions` 与测试为准,生产环境需自行评估安全与隔离。 - **宿主与观测**:依赖注入、日志、配置、部分 HTTP 重试等;Web 侧另有健康检查、观测相关文档(见 `docs/ops/`)。 ## 测试 仓库内 **xUnit 用例约三百条**(分布在 `Prophet.Core.Tests`、`Prophet.Web.Tests`、`Prophet.Hosting.Tests` 等),覆盖核心逻辑、编排、记忆、插件与大量 Web/聊天管线场景。本地/CI 需能还原 NuGet 包并满足各集成测试对外部服务或配置的要求;并非所有用例都在默认单机无网络环境下通过。 ## 快速开始 ### 安装 #### 方式一:NuGet 包(暂未发布) > 正式包尚未发布到 nuget.org;当前以 **源码引用** 为主。发布与运维文档入口见 [docs/ops/README.md](docs/ops/README.md)。 #### 方式二:从源码构建 ```bash git clone https://github.com/prophet-ai/prophet.git cd prophet dotnet build Prophet.sln ``` ### 基础示例 ```csharp using Prophet; using Prophet.Providers.OpenAI; // 创建 Agent var agent = new AgentBuilder() .WithProvider(new OpenAIProvider(apiKey: "your-api-key")) .Build(); // 简单对话 var response = await agent.ChatAsync("你好,介绍一下你自己"); Console.WriteLine(response); // 工具调用 var result = await agent.ExecuteAsync("帮我查询今天的天气"); ``` ### 启用 SQLite 长期记忆(持久化) 使用 `AddProphetMemoryWithSqlite` 在 DI 中注册长期记忆存储(EF Core + SQLite),并可选择启用自动迁移: ```csharp builder.Services.AddProphet(); builder.Services.AddProphetMemoryWithSqlite(opts => { opts.ConnectionString = "Data Source=prophet_memory.db"; opts.AutoMigrate = true; // 应用启动时自动迁移 }); // 可选:注册 RAG 并让其使用已注册的长期记忆回退检索 builder.Services.AddProphetRag(); ``` 实现位于 `Prophet.Core`(如 `Memory/SqliteLongTermMemoryStore.cs`),配套测试在 `tests/Prophet.Core.Tests/`。 ## 文档 文档按主题分层,入口见 **[docs/README.md](docs/README.md)**。常用链接: - [文档索引与分层说明](docs/README.md) - [快速开始](docs/references/quickstart/getting-started.md) - [API 快速配置(通义/智谱等)](docs/references/quickstart/quick-start-api.md) - [Ollama 快速开始](docs/references/quickstart/quick-start-ollama.md) - [架构总览](docs/architecture/system-overview.md) - [宿主与 Web 集成](docs/references/hosting-integration.md) - [Provider 参考](docs/references/providers.md) - [向量存储](docs/references/vector-stores.md) - [工具说明](docs/references/tools.md) - [无 API 密钥测试(Mock)](docs/ops/testing-without-api-key.md) - [测试与运行](docs/ops/testing.md) - 历史规划归档:[开发计划](docs/archive/development-plan.md)、[框架方案](docs/archive/framework-plan.md)、[框架使用(归档)](docs/archive/framework-usage.md) ## 使用场景示例 ### 使用国内大模型 ```csharp using Prophet.Providers.Qianwen; using Prophet.Providers.Zhipu; using Prophet.Providers.VolcengineArk; // 通义千问 var qianwenProvider = new QianwenProvider(apiKey: "your-key"); var agent1 = new AgentBuilder() .WithProvider(qianwenProvider) .Build(); // 智谱AI var zhipuProvider = new ZhipuProvider(apiKey: "your-id.your-secret"); var agent2 = new AgentBuilder() .WithProvider(zhipuProvider) .Build(); // 火山方舟 var arkProvider = new VolcengineArkProvider(apiKey: "your-key", model: "your-model-name"); var agent3 = new AgentBuilder() .WithProvider(arkProvider) .Build(); ``` ### 代码助手 Agent ```csharp var codeAgent = new AgentBuilder() .WithProvider(new OpenAIProvider(apiKey: "your-api-key")) .WithTool(new FileReadTool()) .WithTool(new FileWriteTool()) .Build(); var review = await codeAgent.ChatAsync("请审查这段代码并给出改进建议"); ``` ### 数据分析 Agent 可运行示例与命令说明见 [examples/Prophet.Examples/README.md](examples/Prophet.Examples/README.md)(如 `dotnet run --project examples/Prophet.Examples -- data`)。需自备 LLM API 密钥(如 `OPENAI_API_KEY`);未配置时 Mock Provider 仅作演示。**`CodeExecutionTool` 具有执行任意代码的风险**,生产环境务必自行做沙箱、白名单与配额控制。 可选:在 Prophet.Web 技能目录中参考内置提示技能 [bundled-skills/data-analysis-hint/SKILL.md](bundled-skills/data-analysis-hint/SKILL.md)。 ```csharp var dataAgent = new AgentBuilder() .WithProvider(new OpenAIProvider(apiKey: "your-api-key")) .WithTool(new CalculatorTool()) .WithTool(new CodeExecutionTool()) .WithTool(new DateTimeTool()) .Build(); var analysis = await dataAgent.ChatAsync("帮我分析这组数据的统计特征"); ``` ### 文档生成 Agent ```csharp var docAgent = new AgentBuilder() .WithProvider(new OpenAIProvider(apiKey: "your-api-key")) .WithTool(new FileReadTool()) .WithTool(new FileWriteTool()) .WithTool(new DateTimeTool()) .Build(); var doc = await docAgent.ChatAsync("生成一份项目总结文档"); ``` ## 示例与应用 - **`examples/Prophet.Examples`**:链式/多 Agent/工作流/RAG/数据分析等演示入口见该项目 `Program.cs` 与 [README](examples/Prophet.Examples/README.md)。 - **`apps/Prophet.Web`**:带前端的 Web 应用,用于集成聊天、记忆、技能等能力的端到端验证。 ## 项目结构(概要) ``` Prophet/ ├── src/ │ ├── Prophet.Abstractions/ │ ├── Prophet.Models/ │ ├── Prophet.Orchestration/ │ ├── Prophet.Core/ │ ├── Prophet.Hosting/ │ ├── Prophet.AspNetCore/ │ ├── Providers/ # Prophet.Providers.* │ └── VectorStores/ # Prophet.VectorStores.* ├── apps/ │ └── Prophet.Web/ ├── examples/ │ └── Prophet.Examples/ └── tests/ # Prophet.Core.Tests, Prophet.Web.Tests, … ``` ### 解耦原则 - `src/` 为**框架与可复用库**;应用不应把业务特有的硬编码下沉进公共抽象。 - `apps/`、`examples/` 依赖 `src/`,反向依赖不允许(见 `docs/architecture/adr/001-apps-src-decoupling.md`)。 ## 贡献 欢迎贡献;说明见 [CONTRIBUTING.md](CONTRIBUTING.md)。 CI 工作流: [.github/workflows/ci.yml](.github/workflows/ci.yml)、[build-and-test.yml](.github/workflows/build-and-test.yml)。可选静态分析: [.github/workflows/static-analysis.yml](.github/workflows/static-analysis.yml),本地可运行 `powershell -File scripts/ci-static-analysis.ps1`。 ## 许可证 [MIT 许可证](LICENSE)。 --- **说明**:本仓库持续迭代,公共 API 可能变更。若文档与实现不一致,以源码与测试为准;欢迎通过 Issue 指出偏差。