基于ChatGPT的API的C#接入研究

今年开年，最火的莫过于ChatGPT的相关讨论，这个提供了非常强大的AI处理，并且整个平台也提供了很多对应的API进行接入的处理，使得我们可以在各种程序上无缝接入AI的后端处理，从而实现智能AI的各种应用。ChatGPT的API可以在前端，以及一些后端进行API的接入，本篇随笔主要介绍基于ChatGPT的API的C#接入研究。

1、ChatGPT的介绍

ChatGPT（全名：Chat Generative Pre-trained Transformer），美国OpenAI研发的聊天机器人程序 ，于2022年11月30日发布。ChatGPT是人工智能技术驱动的自然语言处理工具，它能够通过学习和理解人类的语言来进行对话，还能根据聊天的上下文进行互动，真正像人类一样来聊天交流，甚至能完成撰写邮件、视频脚本、文案、翻译、代码，写论文 等任务。

ChatGPT是美国人工智能研究实验室OpenAI新推出的一种人工智能技术驱动的自然语言处理工具，使用了Transformer神经网络架构，也是GPT-3.5架构，这是一种用于处理序列数据的模型，拥有语言理解和文本生成能力，尤其是它会通过连接大量的语料库来训练模型，这些语料库包含了真实世界中的对话，使得ChatGPT具备上知天文下知地理，还能根据聊天的上下文进行互动的能力，做到与真正人类几乎无异的聊天场景进行交流。ChatGPT不单是聊天机器人，还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

ChatGPT 的官网地址如下：https://platform.openai.com/ ，如果我们需要使用它的对话处理以及强大的API能力，需要注册才能使用，至于如何注册以及接收验证码的操作，请百度一下一下即可，这里忽略，只是介绍它的功能以及如何介入使用。

ChatGPT 可以做很多不同类型的工作，常规的问答聊天，编写各种语言的应用代码，编写论文、摘要等，以及图片处理，翻译等等，如下是它们的一些功能分类和介绍。

如我们可以在对话中测试其聊天/应答功能。

我们也可以让它编写一段操作代码，如下所示。

如果我们要了解ChatGPT平台的API介绍，可以参考 https://platform.openai.com/docs/api-reference/introduction ，其大概分类也是很常规的功能应用相关的，如下是它的列表介绍。

我们要学会如何使用API的话，需要了解它的相关模型概念，以及对各种处理的定义。

2、基于ChatGPT的API的C#接入

从上面的API介绍中，我们可以看到，API平台没有针对不同的语义给出不同的实现方式，只是给出了一个通用的调用方式，主要是基于输入参数，响应的数据格式的参考，具体的不同语言的应用如C#的接入，需要根据实际的格式进行对接。

主要的代码如下所示。

using RestSharp;
using System;

namespace Gpt3APIExample
{
    class Program
    {
        static void Main(string[] args)
        {
            // OpenAI API地址
            string apiUrl = "https://api.openai.com/v1/engines/gpt-3/jobs";

            // OpenAI API密钥
            string apiKey = "YOUR_API_KEY";

            // 创建一个RestClient对象
            var client = new RestClient(apiUrl);

            // 创建一个RestRequest对象
            var request = new RestRequest(Method.POST);

            // 在请求头中添加API密钥
            request.AddHeader("Authorization", "Bearer " + apiKey);

            // 添加请求内容
            request.AddJsonBody(new
            {
                model = "text-davinci-002",
                prompt = "What is the capital of France?",
                max_tokens = 100,
                n = 1,
                stop = null,
                temperature = 0.5,
            });

            // 发送请求并获取响应
            IRestResponse response = client.Execute(request);

            // 显示响应内容
            Console.WriteLine(response.Content);
            Console.ReadLine();
        }
    }
}

这个代码主要就是针对输入信息和输出的内容进行简单的包装，使用 RestSharp 的一个Http类库进行访问的包装。

而为了更好的使用ChatGPT的API处理，我们可以使用更高级一点的类库，如下面介绍的两个开源C#包装ChatGPT的类库：

https://github.com/OkGoDoIt/OpenAI-API-dotnet

https://github.com/RageAgainstThePixel/OpenAI-DotNet

我觉得他们都是很不错的，都是基于ChatGPT的API格式进行了一定程度的面向对象的包装，使得我们基于C#开发起来更方便。

例如我们基于 https://github.com/RageAgainstThePixel/OpenAI-DotNet

来查看使用代码，它的介绍也比较详细，基本上覆盖到了各个方面。

我们可以模仿来生成自己的代码即可，如下所示。

    /// <summary>
    /// 基于OpenAI-DotNet的使用
    /// </summary>
    public class Test2
    {
        public static async Task ExcuteCode()
        {
            var api = new OpenAIClient(new OpenAIAuthentication(Constants.ApiKey));

            var result = await api.CompletionsEndpoint.CreateCompletionAsync("读取图片文件的展示到窗体的C#代码", null, null, 1000, 0.1);
            Log.Information(result.ToJson());
        }

运行效果，可以看到输出的结果。

对于图片的生成和处理，我们也可以按照类似的API进行调用接口，如下是一段寻找图片的代码。

            var results = await api.ImagesEndPoint.GenerateImageAsync("中国布达拉宫的全景图片", 1, ImageSize.Large);
            foreach (var item in results)
            {
                Log.Information(item);
            }

为了验证图片的AI处理，我们生成两张正方形的图片，图片右下角扣掉一块空白的图片，图片格式使用PNG格式，然后调用如下代码进行替换处理。

            var imageAssetPath = "images/休息区.png";
            var maskAssetPath = "images/休息区2.png";
            var imageResults = await api.ImagesEndPoint.CreateImageEditAsync(Path.GetFullPath(imageAssetPath), Path.GetFullPath(maskAssetPath), "阳光明媚的室内休息区，有一个鸭子在池塘中", 1, ImageSize.Small);
            foreach (var item in imageResults)
            {
                Log.Information(item);
            }

生成后的图片效果如下所示。

生成的空白地方，填入一个所需要的区域，红色框是我加上去醒目的。