OpenAI-API-dotnet 项目使用教程

1. 项目介绍

OpenAI-API-dotnet 是一个非官方的 C#/.NET SDK，用于访问 OpenAI 的 GPT-3 API。该项目提供了一个简单的 C#/.NET 包装库，方便开发者与 OpenAI 的 API 进行交互，支持 GPT-3、GPT-3.5/4、GPT-3.5/4-Turbo 以及 DALL-E 2/3 等模型。

该项目由 OkGoDoIt 开发，目前已被微软接管，并推出了官方版本。本教程基于原始版本（v1.11）进行编写。

2. 项目快速启动

2.1 安装

首先，通过 NuGet 安装 OpenAI 包：

Install-Package OpenAI -Version 1.11.0

2.2 初始化 API

在项目中初始化 OpenAI API：

using OpenAI_API;

// 使用 API 密钥初始化
var api = new OpenAIAPI("YOUR_API_KEY");

2.3 使用 Chat API

以下是一个简单的示例，展示如何使用 Chat API 与 GPT-3 进行交互：

// 创建对话
var chat = api.Chat.CreateConversation();

// 添加系统消息
chat.AppendSystemMessage("You are a teacher who helps children understand if things are animals or not. If the user tells you an animal, you say \"yes\". If the user tells you something that is not an animal, you say \"no\". You only ever respond with \"yes\" or \"no\". You do not say anything else.");

// 添加用户输入
chat.AppendUserInput("Is this an animal? Cat");

// 获取响应
string response = await chat.GetResponseFromChatbotAsync();
Console.WriteLine(response); // 输出: "Yes"

3. 应用案例和最佳实践

3.1 聊天机器人

使用 OpenAI-API-dotnet 可以轻松构建一个聊天机器人。以下是一个简单的聊天机器人示例：

var chat = api.Chat.CreateConversation();
chat.AppendSystemMessage("You are a helpful assistant.");

while (true)
{
    Console.Write("You: ");
    string userInput = Console.ReadLine();
    chat.AppendUserInput(userInput);

    string response = await chat.GetResponseFromChatbotAsync();
    Console.WriteLine("Assistant: " + response);
}

3.2 图像识别

使用 GPT-4 Vision 模型进行图像识别：

var chat = api.Chat.CreateConversation();
chat.Model = Model.GPT4_Vision;
chat.AppendSystemMessage("You are a graphic design assistant who helps identify colors.");

chat.AppendUserInput("What are the primary non-white colors in this logo?", ImageInput.FromFile("path/to/logo.png"));
string response = await chat.GetResponseFromChatbotAsync();
Console.WriteLine(response); // 输出: "Blue and purple"

4. 典型生态项目

4.1 微软官方 OpenAI .NET SDK

微软已经接管了 OpenAI-API-dotnet 项目，并推出了官方版本。新版本提供了更全面的功能和更好的支持，建议开发者使用官方版本：

• 官方仓库：Microsoft.SemanticKernel

4.2 其他相关项目

• OpenAI API Python SDK: 如果你使用 Python 进行开发，可以参考 OpenAI Python SDK。
• OpenAI API Node.js SDK: 如果你使用 Node.js 进行开发，可以参考 OpenAI Node.js SDK。

通过这些项目，开发者可以更方便地与 OpenAI 的 API 进行交互，构建各种智能应用。