OpenAI .NET API 库：方便快捷地访问 OpenAI API

openai-dotnet

OpenAI .NET API 库简介

OpenAI .NET API 库是一个专为 .NET 应用程序设计的客户端库,旨在为开发者提供便捷的方式访问 OpenAI 的 REST API。该库由 OpenAI 与微软合作开发,基于 OpenAPI 规范生成,确保了与 OpenAI 服务的高度兼容性和可靠性。

OpenAI .NET API 库 NuGet 版本

主要特性

支持多种 OpenAI 功能:包括聊天完成、文本嵌入、图像生成、音频转录等。
命名空间组织:库按功能区域划分为多个命名空间,每个命名空间包含对应的客户端类。
同步和异步 API:每个客户端方法都提供同步和异步版本,满足不同的编程需求。
流式传输支持:支持聊天完成等功能的流式传输,实现实时响应。
工具和函数调用:允许在聊天完成过程中调用自定义函数和工具。
结构化输出:支持使用 JSON Schema 定义输出格式,实现更精确的响应控制。
Azure OpenAI 集成:提供与 Azure OpenAI 服务集成的便捷方法。

快速入门

安装

使用 NuGet 包管理器安装 OpenAI .NET API 库:

dotnet add package OpenAI --prerelease

基本使用

以下是使用聊天完成 API 的简单示例:

using OpenAI.Chat;

ChatClient client = new(model: "gpt-4o", Environment.GetEnvironmentVariable("OPENAI_API_KEY"));

ChatCompletion completion = client.CompleteChat("Say 'this is a test.'");

Console.WriteLine($"[ASSISTANT]: {completion}");

高级功能

流式聊天完成

流式传输允许在生成完整响应之前开始处理部分结果:

CollectionResult<StreamingChatCompletionUpdate> updates
    = client.CompleteChatStreaming("Say 'this is a test.'");

Console.WriteLine($"[ASSISTANT]:");
foreach (StreamingChatCompletionUpdate update in updates)
{
    foreach (ChatMessageContentPart updatePart in update.ContentUpdate)
    {
        Console.Write(updatePart);
    }
}

使用工具和函数调用

OpenAI .NET API 库支持在聊天完成过程中调用自定义函数和工具:

private static readonly ChatTool getCurrentLocationTool = ChatTool.CreateFunctionTool(
    functionName: nameof(GetCurrentLocation),
    functionDescription: "Get the user's current location"
);

// ... 定义更多工具和函数

ChatCompletionOptions options = new()
{
    Tools = { getCurrentLocationTool, getCurrentWeatherTool },
};

ChatCompletion chatCompletion = client.CompleteChat(messages, options);

// ... 处理工具调用和响应

生成文本嵌入

文本嵌入可用于测量文本字符串之间的相关性:

using OpenAI.Embeddings;

EmbeddingClient client = new(model: "text-embedding-3-small", Environment.GetEnvironmentVariable("OPENAI_API_KEY"));

string description = "Best hotel in town if you like luxury hotels. ...";

Embedding embedding = client.GenerateEmbedding(description);
ReadOnlyMemory<float> vector = embedding.Vector;

图像生成

OpenAI .NET API 库支持使用 DALL-E 3 模型生成图像:

using OpenAI.Images;

ImageClient client = new(model: "dall-e-3", Environment.GetEnvironmentVariable("OPENAI_API_KEY"));

string prompt = "The concept for a living room that blends Scandinavian simplicity with Japanese minimalism ...";

ImageGenerationOptions options = new()
{
    Quality = GeneratedImageQuality.High,
    Size = GeneratedImageSize.W1792xH1024,
    Style = GeneratedImageStyle.Vivid,
    ResponseFormat = GeneratedImageFormat.Bytes
};

GeneratedImage image = client.GenerateImage(prompt, options);
BinaryData bytes = image.ImageBytes;

DALL-E 生成的图像示例

与 Azure OpenAI 集成

OpenAI .NET API 库提供了与 Azure OpenAI 服务集成的便捷方法:

AzureOpenAIClient azureClient = new(
    new Uri("https://your-azure-openai-resource.com"),
    new DefaultAzureCredential());
ChatClient chatClient = azureClient.GetChatClient("my-gpt-35-turbo-deployment");

ChatCompletion completion = chatClient.CompleteChat(
    [
        new SystemChatMessage("You are a helpful assistant that talks like a pirate."),
        new UserChatMessage("Hi, can you help me?"),
        new AssistantChatMessage("Arrr! Of course, me hearty! What can I do for ye?"),
        new UserChatMessage("What's the best way to train a parrot?"),
    ]);

Console.WriteLine($"{completion.Role}: {completion[0].Content.Text}");

高级场景

使用协议方法

OpenAI .NET API 库提供了协议方法,允许更直接地访问 REST API:

ChatClient client = new("gpt-4o", Environment.GetEnvironmentVariable("OPENAI_API_KEY"));

BinaryData input = BinaryData.FromBytes("""
{
    "model": "gpt-4o",
    "messages": [
       {
           "role": "user",
           "content": "How does AI work? Explain it in simple terms."
       }
    ]
}
"""u8.ToArray());

using BinaryContent content = BinaryContent.Create(input);
ClientResult result = client.CompleteChat(content);
BinaryData output = result.GetRawResponse().Content;

// ... 解析输出

自动重试错误

客户端类默认会自动重试某些错误,如请求超时、服务器内部错误等,最多重试三次,并使用指数退避策略。

可观察性

OpenAI .NET API 库支持使用 OpenTelemetry 进行实验性的分布式跟踪和指标收集,有助于监控和诊断应用程序性能。

结论

OpenAI .NET API 库为 .NET 开发者提供了强大而灵活的工具,使其能够轻松集成 OpenAI 的各种人工智能能力。通过提供直观的 API、流式传输支持、工具调用等高级功能,该库极大地简化了 AI 应用程序的开发过程。无论是构建聊天机器人、生成图像,还是进行自然语言处理,OpenAI .NET API 库都是一个值得信赖的选择。

开发者可以访问 OpenAI .NET API 库的 GitHub 仓库获取更多信息、示例代码和最新更新。同时,我们也鼓励开发者积极参与到该开源项目中,贡献代码、报告问题或提出改进建议,共同推动 AI 技术在 .NET 生态系统中的发展。