Microsoft 示例驱动的程序合成 SDK

重要提示：自2025年10月14日起，我们已停止发布 PROSE SDK 的新版本。

示例驱动的程序合成（PROSE）SDK 包含一套技术，用于根据输入-输出示例自动生成程序。本仓库包含与 Microsoft PROSE SDK 相关的示例、发行说明以及其他一些杂项项目。

这些示例分为两类：

• 用于使用现有 PROSE DSL API 完成任务的示例，位于 api-samples/api-samples.sln。
• 用于通过在 dsl-samples 目录中编写 DSL 来构建程序合成解决方案的示例：
  • DSL 编写教程
  • ProseSample
  • 用于合并冲突解决的 DSL

您可以在以下链接找到部分示例项目的指南以及有关 PROSE 项目的其他信息： https://aka.ms/prose/

贡献

本仓库中所有信息的真实来源实际上是微软内部的一个仓库，此处所做的任何更改都有可能被 PROSE 团队未来的公开发布所覆盖。如果您发现本仓库中的任何示例或其他内容存在问题，请 提交一个问题，PROSE 团队的成员将与您合作，确保问题得到解决。

---

本项目已采用 Microsoft 开源行为准则。如需更多信息，请参阅 行为准则常见问题解答 或发送电子邮件至 opencode@microsoft.com 咨询更多问题或意见。

PROSE SDK 快速上手指南

重要提示：微软已于 2025 年 10 月 14 日停止发布 PROSE SDK 的新版本。本指南基于现有稳定版本编写，适用于学习和维护现有项目。

PROSE (Program Synthesis using Examples) 是一个通过输入 - 输出示例自动生成程序的 SDK。它允许开发者定义领域特定语言 (DSL)，从而实现智能代码生成、数据转换或冲突解决等功能。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统: Windows 10/11 或 Linux (需安装 .NET 运行时)。
• 核心框架: .NET SDK 6.0 或更高版本（推荐 .NET 8）。
  • 下载地址：https://dotnet.microsoft.com/download
  • 国内加速: 如遇下载缓慢，可尝试使用清华大学镜像源配置环境变量或直接下载离线安装包。
• 开发工具:
  • Visual Studio 2022 (推荐，需安装 ".NET 桌面开发" 工作负载)
  • 或 VS Code + C# Dev Kit 扩展
• 版本控制: Git

安装步骤

由于 PROSE SDK 主要通过源码示例提供，推荐使用 Git 克隆官方仓库并构建示例项目。

1. 克隆仓库 打开终端，执行以下命令获取源代码：

   git clone https://github.com/microsoft/prose.git
   cd prose
   

2. 构建示例项目 进入示例解决方案目录并还原依赖：

   # 构建 API 使用示例
   dotnet build api-samples/api-samples.sln
   
   # 或者构建 DSL 创作示例（适合自定义合成逻辑）
   dotnet build dsl-samples/ProseSample/ProseSample.sln
   

   注：如果 dotnet restore 速度较慢，可临时配置 NuGet 国内镜像：

   dotnet nuget add source https://api.nuget.org/v3/index.json -n official --configfile ./NuGet.Config
   # 建议手动编辑 NuGet.Config 添加阿里云或清华源以加速
   

基本使用

PROSE 的核心工作流是：定义 DSL -> 提供示例 -> 合成程序。以下以 ProseSample 为例展示最基础的用法。

1. 运行预置示例

直接进入示例目录运行，观察如何从示例中推断逻辑：

cd dsl-samples/ProseSample
dotnet run --project ProseSample.csproj

2. 代码调用示例 (C#)

在您自己的项目中，可以通过引用 SDK 并编写简单的合成逻辑来使用。以下是一个概念性示例，展示如何调用合成引擎：

using Microsoft.ProgramSynthesis;
using Microsoft.ProgramSynthesis.Rules;

// 1. 定义你的 DSL 语法树节点 (需在 DSL 项目中预先定义)
// 2. 准备输入 - 输出示例
var examples = new List<(string input, string output)>
{
    ("john doe", "Doe, John"),
    ("jane smith", "Smith, Jane")
};

// 3. 创建合成上下文并执行合成
// 注意：具体 API 取决于你定义的 DSL 类型
var spec = Specification.FromExamples(examples);
var program = Synthesizer.Solve(spec, dslGrammar);

// 4. 输出生成的程序
if (program != null)
{
    Console.WriteLine($"Synthesized program: {program}");
}

3. 进阶：自定义 DSL

若要解决特定领域问题（如合并冲突解决），请参考 dsl-samples/MergeConflictsResolution 目录。你需要：

1. 使用 PROSE DSL 语言定义语法规则。
2. 编写转换逻辑。
3. 编译生成特定的合成器。

更多详细教程和 API 文档请访问：https://aka.ms/prose/