openai-dotnet

环境要求

• 安装 .NET SDK（README 示例使用 .NET 10，库兼容 .NET Standard 2.0）
• 一个可编译的 .NET 项目
• 能够访问 NuGet 包源以安装 OpenAI 包
• 了解 C# 异步编程与 await foreach 基本用法

安装与启动步骤

1. 1准备 .NET 环境

   安装 .NET SDK 并准备一个可编译的 .NET 项目，README 示例使用 .NET 10，库兼容 .NET Standard 2.0。

2. 2安装 NuGet 包

   在 .NET 项目目录执行安装命令，把 OpenAI 客户端库加入项目依赖。

   dotnet add package OpenAI

   复制

3. 3注册依赖注入

   在 Program.cs 中调用 AddChatClient，传入配置节名；客户端线程安全，可注册为单例。

   builder.AddChatClient("Clients:ChatClient");

   复制

4. 4注入并调用客户端

   在控制器构造函数注入 ChatClient，调用 CompleteChatAsync 并读取 Content[0].Text。

   ChatCompletion completion = await _chatClient.CompleteChatAsync(message);

   复制

5. 5启用流式输出

   改用 CompleteChatStreamingAsync，用 await foreach 枚举更新并输出 ContentUpdate。

   AsyncCollectionResult completionUpdates = client.CompleteChatStreamingAsync("Say 'this is a test.'");

   复制

6. 6处理工具调用

   用 CreateFunctionTool 定义工具并加入 Tools，FinishReason 为 ToolCalls 时回传结果。

关键配置

如何确认成功

在应用中调用 CompleteChatAsync，若返回 completion.Content[0].Text 且有内容，说明客户端已正常工作。

常见问题

注意事项

• 安装命令需在 .NET 项目目录执行，确保项目文件存在。
• README 未给出 API 密钥配置与客户端初始化完整示例，请按库的配置体系自行设置。
• 流式结果必须枚举后才会处理分片，不要只创建对象不遍历。
• 工具调用需要循环处理，直到 FinishReason 为 Stop。