Cledev.OpenAI

Cledev.OpenAI 项目介绍

Cledev.OpenAI 是一个非官方的 .NET SDK，旨在简化与 OpenAI 的交互，提供便于使用的 API。它还包含一个基于 Blazor Server 的 Playground，助力用户探索和测试不同的功能。此 SDK 设计为一个强大的工具，以支持各种人工智能功能，从文本生成到图像创建，适合开发人员在其项目中无缝集成 OpenAI 的能力。

核心功能

Cledev.OpenAI 提供了多种强大的 API 功能，让开发者能够轻松实现与 OpenAI 服务的集成。

模型管理

列出模型：获取所有可用模型的列表。
检索模型：详细获取某个特定模型的信息。

文本生成

创建补全：生成基于输入提示的文本内容，适用于自动写作、聊天机器人等应用场景。

ChatGPT

创建 Chat 补全：使用最新的聊天模型（如 ChatGPT-4）生成对话式交互内容。

编辑功能

创建编辑：对文本内容进行编辑和修改，以提高文本质量或风格。

图像处理

创建图像：生成基于文本描述的图像。
图像编辑：对已生成的图像进行编辑。
创建图像变化：通过现有图像生成不同风格或内容的变体。

嵌入技术

创建嵌入：生成用于文本相似性检测或其他嵌入应用的向量。

音频处理

创建转录：将音频文件转化为文字记录。
创建翻译：将音频内容翻译成目标语言。

文件管理

文件列表：列出所有上传的文件。
上传文件：上传文件以供模型使用。
删除文件：从系统中移除文件。
检索文件：获取特定文件的信息。

微调管理

创建微调：通过训练新的模型以优化性能。
列出微调：查看所有可用的微调模型。
检索微调：获取特定微调的详细信息。
取消微调：停止进行中的微调任务。
微调事件列表：查看微调过程中发生的所有事件。
删除微调模型：从系统中移除微调模型。

内容审核

创建审核：对内容进行安全性和合规性检查。

工具和支持

Azure OpenAI 支持：即将推出，允许在 Azure 环境下使用 OpenAI 服务。

配置选项

提供两种灵活的配置方法以连接到 OpenAI 服务：

选项一

通过 appsettings.json 文件进行配置：

{
  "OpenAI": {
    "ApiKey": "YOUR_API_KEY",
    "Organization": "OUR_ORGANIZATION"
  }
}

选项二

通过环境变量进行配置，确保安全性：

services.AddOpenAIClient(options =>
{
     options.ApiKey = Environment.GetEnvironmentVariable("YOUR_API_KEY");
     options.Organization = Environment.GetEnvironmentVariable("YOUR_ORGANIZATION");
});

使用示例

ChatGPT 流示例

通过流的方式接收 ChatGPT 的响应：

var request = new CreateChatCompletionRequest
{
    Model = ChatModel.Gpt35Turbo.ToStringModel(),
    Stream = true,
    MaxTokens = 500,
    Messages = new List<ChatCompletionMessage>
    {
        new("system", "You are a helpful assistant."),
        new("user", "Who won the world series in 2020?"),
        new("assistant", "The Los Angeles Dodgers won the World Series in 2020."),
        new("user", "Where was it played?")
    }
};

var completions = client.CreateChatCompletionAsStream(request);

await foreach (var completion in completions)
{
    Console.Write(completion.Choices[0].Message?.Content);
}

文本补全流示例

实时生成文本的过程：

var request = new CreateCompletionRequest
{
    Model = CompletionsModel.TextDavinciV3.ToStringModel(),
    Stream = true,
    Prompt = "Please write a 1000 word assay about differences between functional programming and object oriented programming",
    MaxTokens = 500
};

var completions = client.CreateCompletionAsStream(request);

await foreach (var completion in completions)
{
    Console.Write(completion.Choices[0].Text);
}

音频转录示例（Whisper）

将音频文件转成文本并进行翻译：

const string fileName = "YOUR_RECORDING.m4a";
var fileBytes = await File.ReadAllBytesAsync($"Data/{fileName}");

var request = new CreateAudioTranslationRequest
{
    Model = AudioModel.Whisper1.ToStringModel(),
    File = fileBytes,
    FileName = fileName,
    ResponseFormat = AudioResponseFormat.VerboseJson.ToStringFormat()
};

var response = await client.CreateAudioTranslation(request);

Console.Write($"{JsonSerializer.Serialize(response, jsonSerializerOptions)}");

图像创建示例（Dall-E）

通过文本提示生成图像：

var request = new CreateImageRequest
{
    Prompt = "Once upon a time",
    Size = ImageSize.Size512x512.ToStringSize(),
    ResponseFormat = ImageResponseFormat.B64Json.ToStringFormat(),
    N = 1
};

var response = await client.CreateImage(Request);

<img src="@response.Data[0].Url" />