typechat.net

typechat.net

Typechat.net将Typechat的想法带到.NET。

Typechat.net提供了跨平台库，可帮助您使用强大类型，类型验证和简单类型安全程序（计划）构建自然语言界面。强大的打字可能有助于制造使用语言模型更确定性和可靠的软件。

 // Translates user intent into strongly typed Calendar Actions
var model = new LanguageModel(Config.LoadOpenAI());
var translator = new JsonTranslator<CalendarActions>(model);

// Translate natural language request 
CalendarActions actions = await translator.TranslateAsync(requestText);

typechat.net处于主动开发，并频繁更新。当团队探索空间并结合反馈时，该框架将不断发展。随附的示例中显示了支持的方案。文档也将继续改善。如有疑问，请查看代码。

集会

typechat.net当前由以下组件组成：

• Microsoft.typechat ：将用户意图转化为强烈键入和验证的对象的类。

• Microsoft.typechat.program ：综合，验证和运行JSON程序的类。

• Microsoft.typechat.semantickernel ：与Microsoft语义内核集成，用于型号，插件，嵌入和其他功能。

Microsoft.typechat

Typechat使用语言模型将用户意图转化为符合模式的JSON。然后，将此JSON验证并进行验证为打字对象。根据需要进行其他约束检查。验证错误将发送回该语言模型，该模型使用它们来修复其最初返回的JSON。

Typechat提供：

• JSON翻译，验证，维修和挑选化。
• 可扩展性：定制模式，验证器和提示的接口。
• 架构导出：为要翻译成的.NET类型生成架构的类。导出的模式包括依赖项和基础类。使用Typescript指定导出的模式，可以简单地表达JSON对象的模式。
  • 支持Typechat示例中显示的常见场景。当您遇到限制（例如当前如何导出通用物）时，您可以提供架构文本，例如手工撰写的打字稿。
  • 词汇和评论的辅助属性。词汇是字符串表，可约束可以分配给字符串属性的值。词汇的动态加载可以使场景在运行时变化。
  • 注意：像Typechat一样，Typechat.net仅使用Typescript中指定的模式进行了测试。

 [Comment("Milks currently in stock")]
public class Milks
{
    [JsonVocab("whole milk | two percent milk | nonfat milk | soy milk | almond milk")]
    public string Name { get; set; }
}

microsoft.typechat.program

TypeChat.Program将自然语言请求转换为简单程序（计划），表示为JSON。

可以将JSON程序视为在JSON中表达的DSL或计划，并具有相关的语法。 JSON程序可以按照其针对目标的API进行检查。然后可以使用解释器运行它们，也可以将其编译到.NET代码中。

typechat.program包括：

• 程序翻译：将用户转化为遵循程序语法的程序
• 程序解释器：运行使用解释器通过programTranslator生成的程序。
• 程序编译器：使用动态语言运行时（DLR）与类型检查一起编译程序/计划。汇编诊断用于维修程序。

 // Translates user intent into typed Programs that call methods on a Math API
var model = new LanguageModel(Config.LoadOpenAI());
var api = new MathAPI();
var translator = new ProgramTranslator<IMathAPI>(model, api);

// Translate natural language request
Program program = await translator.TranslateAsync(requestText);
// Run the program
program.Run(api);

Microsoft.typechat.semantickernel

typechat.semantickernel使用语义内核1.0。它包括：

• 插件的JSON程序：将注册插件变成JSON程序可以定位的API 。请参阅插件示例。
• 语言模型和嵌入使用语义内核访问。

Typechat.net的先前版本使用了语义内核的预释放编程模型。您可以使用SK_PRERELEASE分支访问此弃用版本。

入门

先决条件：Openai

• OpenAI语言模型：Typechat.net及其示例目前需要熟悉OpenAI的语言模型。
• Typechat.net已通过测试并支持以下模型：
  • GPT-35-Turbo
  • GPT-4
  • ADA-002
• 一些示例和场景最适合GPT-4

建筑

• Visual Studio 2022。
  • 从根目录中加载Typechat.sln 。
  • 还原软件包
  • 建造
• dotnet构建
  • 启动命令提示 /终端
  • 转到项目的根目录
  • dotnet build typechat.sln

Nuget软件包

• Microsoft.typechat

 dotnet add package Microsoft.TypeChat

• microsoft.typechat.program

 dotnet add package Microsoft.TypeChat.Program

• Microsoft.typechat.semantickernel

 dotnet add package Microsoft.TypeChat.SemanticKernel

例子

要查看“行动中的Typechat.net”，请探索示例项目和Typechat.examples库。

每个示例都包含一个带有示例输入的Input.txt 。将输入文件作为参数传递以在批处理模式下运行示例。

下面的节描述了哪些示例将最好地介绍哪些概念。一些示例或场景可能与GPT-4最有效。

你好世界

情感示例是Typechat的Hello World，也是Jsontranslator的最小介绍。

JSONTRANSLATOR

以下示例演示了如何使用jsontranslator，架构和词汇：

• 咖啡店：自然语言在咖啡店订购。表现出具有多态性测定的复杂模式。
• 日历：将语言转换为日历动作
• 餐厅：在披萨餐厅订购处理

等级模式

• MultiSchema：动态路由用户意图与其他“子应用”
• SchemahierArchy：JSON翻译器比使用多个儿童jsontranslators。对于每个用户请求，它选择了语义上最近的儿童翻译器，并将输入路由到它。
• TextClassifier和VeTortExtIndex展示了如何构建简单的分类器以路由输入。

JSON程序

• 数学：如何将用户请求变成简单的计算器程序
• 插件：如何将用户意图转化为调用语义内核插件的程序

互动剂

• HealthData：如何使用交互式机器人收集用户的健康信息。
• 与具有历史记录的交互式代理合作的代理类。这些类表明了如何将Typechat.net用于与消息传递剂或机器人的强烈键入相互作用。这些代理可以包括内置互动历史等功能。

API键和配置

要使用typechat.net或运行示例，您都需要：

• OpenAi服务的API密钥。 Azure Openai和Openai服务都得到了支持。
• 具有访问Azure OpenAi服务的Azure身份。要使用Azure身份，您必须配置OpenAI服务以使用基于角色的访问并授予对身份的访问。

配置API密钥或Azure身份以示例

• 转到解决方案中的示例文件夹
• 制作AppSettings.json文件的副本，并将其命名为AppSettings.development.json 。确保它与AppSettings.json在同一文件夹中
• AppSettings.development.json是局部开发仅覆盖AppSettings.json中的设置，并且从未签入。
• 将您的API密钥添加到AppSettings.development.json 。
  • 使用Azure身份：使用众所周知的键“身份” 。该代码将使用默认Azure凭据返回的访问令牌：DefaultazureCrecreCredential。您可以使用AZ登录提供这些。

典型的appsettings.development.json看起来像这样：

 // For Azure OpenAI service
{
  "OpenAI": {
    "Azure": true,
    "ApiKey": "YOUR API KEY",
    "Endpoint": "https://YOUR_RESOURCE_NAME.openai.azure.com",
    "Model": "gpt-35-turbo"  // Name of Azure deployment
  }
}
// For Azure OpenAI service with Azure Identity: DefaultCredentials
{
  "OpenAI": {
    "Azure": true,
    "ApiKey": "identity",
    "Endpoint": "https://YOUR_RESOURCE_NAME.openai.azure.com",
    "Model": "gpt-35-turbo"  // Name of Azure deployment
  }
}

// For OpenAI Service:
{
  "OpenAI": {
    "Azure": false,
    "ApiKey": "YOUR API KEY",
    "Endpoint": "https://api.openai.com/v1/chat/completions",
    "Model": "gpt-3.5-turbo"  // Name of OpenAI model
  }
}

Openaiconfig

Typechat示例使用LanguageModel类访问语言模型。 Openaiconfig类为LanguageModel提供配置。您可以从应用程序的配置，JSON文件或环境变量初始化OpenAiConfig。

有关：

• 可配置的属性
• 支持的环境变量。

 // Your configuration 
OpenAIConfig config = Config.LoadOpenAI();
// Or Json file
OpenAIConfig config = OpenAIConfig.LoadFromJsonFile(...);
// Or from config
config = OpenAIConfig.FromEnvironment();

var model = new LanguageModel(config);

使用语义内核

您还可以使用使用内核构造器创建的SemantickerNel内核对象访问LanguageModel。

 const string modelName = "gpt-35-turbo";
new ChatLanguageModel(_kernel.GetService<IChatCompletionService>(modelName), modelName);

使用自己的客户

Typechat使用IlanguageModel接口访问语言模型。 LanguageModel实现IlanguageModel。

您可以通过实现IlanguageModel来使用自己的模型客户端。如果您不使用上面列出的开放AI模型之一，则可能还需要提供最适合您模型的JSONTRANSLATORPROMPTS。

行为守则

该项目采用了Microsoft开源的行为代码。有关更多信息，请参见《行为守则常见问题守则》或与其他问题或评论联系[email protected]。

执照

版权（C）Microsoft Corporation。版权所有。

根据MIT许可获得许可。

商标

该项目可能包含用于项目，产品或服务的商标或徽标。 Microsoft商标或徽标的授权使用受到了Microsoft的商标和品牌准则的约束。在此项目的修改版本中使用Microsoft商标或徽标不得引起混乱或暗示Microsoft赞助。任何使用第三方商标或徽标都遵守这些第三方政策。