大模型C# SDK使用教程:从安装到调用与排错
在 .NET 项目里调用大模型,最省事的方式是使用官方或社区维护的 C# SDK,而不是自己拼 HTTP 请求。
下面按“建项目、装包、配密钥、写调用、验结果”的顺序走一遍,每一步都给出可执行的命令和检查点。
先确认环境和前置条件
开始前需要准备三样东西:
- 一个可用的 .NET 开发环境,建议 .NET 6 或更高版本,执行
dotnet --version能正常输出版本号。 - 大模型服务商提供的 API Key 和接口地址(Base URL)。不同厂商的兼容方式不同,有的兼容 OpenAI 接口格式,有的需要专用 SDK,选包前先看服务商文档。
- 一个空目录用来放测试项目,避免和现有工程混在一起。
如果 dotnet 命令不存在,先安装对应平台的 .NET SDK,再继续后面的步骤。
创建项目并安装大模型 C# SDK
打开终端,执行以下命令创建控制台项目:
dotnet new console -n LlmDemo
cd LlmDemo
以兼容 OpenAI 接口的 SDK 为例,安装 NuGet 包:
dotnet add package OpenAI
安装完成后,用 dotnet list package 确认包已出现在依赖列表中。
如果服务商提供的是自有 SDK,把包名换成文档中给出的名称即可,后面的调用代码以该 SDK 的示例为准。
配置密钥与接口地址
不要把 API Key 直接写死在代码里。
推荐放在环境变量或项目根目录的配置文件,并在 .gitignore 中排除敏感文件。
使用环境变量的方式:
export LLM_API_KEY="你的密钥"
export LLM_BASE_URL="https://服务商提供的接口地址/v1"
Windows PowerShell 对应写法:
$env:LLM_API_KEY="你的密钥"
$env:LLM_BASE_URL="https://服务商提供的接口地址/v1"
在代码中读取这两个变量,避免密钥进入版本库。
编写第一个调用示例
将 Program.cs 替换为下面的结构,注意 SDK 的类名和参数以你实际安装的包版本为准:
using OpenAI;
using OpenAI.Chat;
var apiKey = Environment.GetEnvironmentVariable("LLM_API_KEY")
?? throw new InvalidOperationException("未设置 LLM_API_KEY");
var baseUrl = Environment.GetEnvironmentVariable("LLM_BASE_URL");
var client = new ChatClient(
model: "服务商支持的模型名称",
apiKey: apiKey,
options: baseUrl is null ? null : new OpenAIClientOptions { Endpoint = new Uri(baseUrl) });
var response = await client.CompleteChatAsync(
new[] { new UserChatMessage("用一句话解释什么是依赖注入") });
Console.WriteLine(response.Value.Content[0].Text);
保存后执行 dotnet run。
如果模型和接口地址填写正确,控制台会输出一段回答文本。
验证结果与常见报错处理
调用成功时,除了看到文本输出,还应该检查返回对象中的模型名称和用量字段是否符合预期,确认请求确实到达了目标服务。
遇到问题时按下面顺序排查:
- 认证失败或返回 401:检查环境变量是否在当前终端生效,密钥是否有多余空格,以及接口地址是否包含正确的版本路径。
- 连接超时或 DNS 错误:确认服务器出网正常,
curl测试接口地址能否连通,代理配置是否影响 .NET 请求。 - 模型不存在或参数错误:核对模型名称是否与服务商文档一致,不要照搬其他平台的模型名。
- 返回内容为空:检查消息列表是否为空,部分 SDK 要求至少一条用户消息。
避坑提醒:不同服务商对 OpenAI 接口的兼容程度不一样,SDK 能装上不代表所有方法都能直接调通。
遇到方法不存在或参数不匹配,优先查 SDK 版本对应的文档,而不是反复改密钥。
把调用封装成可复用方法
测试通过后,建议把客户端创建和对话调用封装成独立的服务类,用依赖注入管理生命周期,避免每次请求都新建客户端。
这样在 Web 项目里更容易控制超时、重试和日志。
封装时注意:
- 客户端对象通常应复用,不要在每个请求里 new 一次。
- 为调用设置合理的超时时间,并在日志中记录请求耗时和错误码。
- 密钥只从配置系统读取,不写进日志输出。
完成封装后,再跑一次同样的测试问题,确认输出与之前一致,说明重构没有破坏调用链路。
按以上步骤执行,大模型 C# SDK 的基本使用就能跑通;
后续再根据业务需要调整模型参数和提示词即可。