前言
在之前的章节中我们或多或少的已经接触到了 Semantic Kernel
的 Plugins
,本章我们讲详细介绍如何使用插件。
Semantic Kernel
的一大特点是拥有强大的插件,通过结合自定义/预定义的插件解决智能业务的问题。让传统的代码和智能插件一起工作灵活地接入到应用场景简化传统应用向智能化转型的过程。
什么是Plugins
?
我们知道LLMs
(大模型)的训练数据和我们使用之间有时间差,还有一个问题 LLMs
对自己企业化内的知识认知有缺陷。OpenAI
通过插件将ChatGPT
和第三方的应用程序之间进行连接,这些插件使 ChatGPT
能够与开发人员定义的 API
进行交互,从而增强 ChatGPT
的功能并允许有更广泛的操作,如:
检索实时信息
,例如,体育赛事比分、股票价格、最新新闻等。检索知识库信息
, 例如,公司文档、个人笔记等。协助用户进行相关操作
,例如,预订航班、公司内预定会议、订餐等。
Semantic Kernel
遵循OpenAI
的插件的插件规范,可以很方便地接入和导出插件(如基于Bing, Microsoft 365
,OpenAI
的插件),这样可以让开发人员很简单地调用不同的插件服务。除了兼容OpenAI
的插件外,Semantic Kernel
内也有属于自己插件定义的方式。不仅可以在规定模版格式上定义 Plugins
, 更可以在函数内定义 Plugins
.
从高层次上理解插件是一组可以公开给 AI
应用程序和服务的功能。
插件要提供在语义上描述其行为方式的详细信息,从函数的输入、输出到副作用,一切都需要以 AI
可以理解的方式进行描述.
定义插件
在 Semantic Kernel 中定义 Plugins 插件有两种方式,第一种是通过模版定义插件 也叫Semantic Plugins
(语义插件),第二种是通过函数创建插件 也叫 Native Plugins
(本地插件)
Sermantic Plugins
通过模版定义插件
我们知道可以通过Prompts
(提示词工程)可以和LLMs
进行对话,我们在处理一系列特定业务过程中,可能不止一个Prompts
,可能是一组Prompts
的集合。我们可以把这些针对业务能力的Prompts
集合放到Semantic Kernel
的插件集合内。
模版格式
在 Semantic Kernel
模版定义格式有固定的格式,Prompts
(提示词)都放在 skprompt.txt
文件内,而相关参数设置都放在 config.json
文件内,文件结构参考如下图
c#
const string ConfigFile = "config.json";
const string PromptFile = "skprompt.txt";
这些都是在
SK
写死的配置,所以插件内的命名一定要遵循这个规则!
txt
|-plugins
|-Prompts
|-Translator
|-skprompt.txt
|-config.json
|-WriterPlugins
|-Joke
|-skprompt.txt
|-config.json
|-ShortPoem
|-skprompt.txt
|-config.json
skprompt.txt
我们先来看看 skprompt.txt
的定义,这里一般是放置和业务相关的 Prompt
,可以支持多个参数,每个参数都放置在 {{$参数名}}
内,如以下格式:
txt
Translate {{$input}} into {{$language}}
在之前的章节我们介绍过这是SK
里 TemplateFormat
的默认格式"semantic-kernel"
config.json
这是配置相关的内容,随了设置和 LLMs
相关的参数外,你也可以设定输入的参数以及相关描述
json
{
"schema": 1,
"description": "Translate sentenses into a language of your choice",
"execution_settings": {
"default": {
"max_tokens": 2000,
"temperature": 0.7,
"top_p": 0.0,
"presence_penalty": 0.0,
"frequency_penalty": 0.0,
"stop_sequences": ["[done]"]
}
},
"input_variables": [
{
"name": "input",
"description": "sentense to translate",
"default": ""
},
{
"name": "language",
"description": "Language to translate to",
"default": ""
}
]
}
这其实就是对PromptTemplateConfig
提示词模版配置类的 json
数据,最后在 SK
内会被反序列化到对象内。
c#
// Load prompt configuration. Note: the configuration is optional.
var configPath = Path.Combine(functionDirectory, ConfigFile);
var promptConfig = File.Exists(configPath) ?
PromptTemplateConfig.FromJson(File.ReadAllText(configPath)) :
new PromptTemplateConfig();
之前我们对PromptTemplateConfig
类进行过详细的讲解,不熟悉的可以看看深入学习 Semantic Kernel:创建和配置 prompts functions。
从解决方案的角度看一下配置的目录图
注册 Semantic Plugins
要从 Semantic Kernel
中要实现Semantic Plugins
模板化插件的注册,需要KernelExtensions
类中的CreatePluginFromPromptDirectory
扩展方法。
再开始之前在我们代码的解决方案Plugins
文件夹下对每一个skprompt.txt
和config.json
进行生成设置
核心代码
c#
var kernel = Kernel.CreateBuilder()
.AddAzureOpenAIChatCompletion(config.ModelId, endpoint: config.Endpoint, apiKey: config.ApiKey)
.Build();
//注册插件
string folder = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Plugins");
kernel.ImportPluginFromPromptDirectory(folder);
string[] pluginNames = ["Prompts", "WriterPlugins"];
foreach (var pluginName in pluginNames)
{
kernel.ImportPluginFromPromptDirectory(Path.Combine(folder, pluginName));
}
//测试从插件获得funciton
var jokeKernelFunction = kernel.Plugins.GetFunction("Prompts", "Translator");
Console.WriteLine("System: 请输入要翻译的内容");
var userResuest = Console.ReadLine();
Console.WriteLine("System: 请输入要翻译的语言语种");
var language = Console.ReadLine();
var results = await jokeKernelFunction.InvokeAsync(kernel, new KernelArguments()
{
{"input", userResuest},
{"language", language}
});
Console.WriteLine($"Assistant: {results.ToString()}");
插件名称约定
ImportPluginFromPromptDirectory
这个方法在注册插件过程中如果没有指定插件名字会默认用文件夹名称
c#
pluginName ??= new DirectoryInfo(pluginDirectory).Name;
输出
c#
System: 请输入要翻译的内容
User: 那么近那么美周末去河北
System: 请输入要翻译的语言语种
User: 英文
Assistant: So close, so beautiful, go to Hebei for the weekend.
最后
本章我们详细介绍了如何使用 Semantic Kernel
的插件功能,包括插件的概念、定义插件的两种方式(Semantic Plugins 和 Native Plugins)、以及如何注册和调用 Semantic Plugins。通过插件,我们可以扩展 ChatGPT
的功能,使其能够与第三方应用程序进行连接,实现更广泛的操作和服务。
通过注册插件并调用相应函数,我们可以实现诸如翻译、笑话生成等功能。在下一篇中,我们将关注 Native Plugins
原生函数插件的介绍。
参考文献
示例代码