OpenAI-API-dotnet

GitHub
1.9k 422 简单 1 次阅读 2天前NOASSERTION开发框架语言模型
AI 解读 由 AI 自动生成,仅供参考

OpenAI-API-dotnet 是一款专为 C# 和 .NET 开发者设计的开源库,旨在简化对 OpenAI 各类 API 的调用。它让开发者能够轻松在 .NET 应用中集成 GPT-3.5、GPT-4(含 Turbo 版本)、DALL-E 图像生成、语音识别与合成、文本嵌入及内容审核等强大功能。

过去,.NET 开发者调用 OpenAI 接口往往需要手动处理复杂的 HTTP 请求和 JSON 解析,过程繁琐且易错。OpenAI-API-dotnet 通过提供类型安全、简洁易懂的封装方法,将这一过程变得像调用本地函数一样简单,显著降低了开发门槛并提升了编码效率。值得一提的是,该项目的原始版本(v1.11 及之前)由社区维护,因其稳定性至今仍被广泛使用;而从 v2.0 开始,微软已正式接手并将其升级为官方支持的 .NET 库,确保了功能的持续更新与全面覆盖。

这款工具非常适合熟悉 C# 语言的软件工程师、全栈开发者以及希望在 Windows、Linux 或 macOS 平台上构建 AI 应用的技术团队。无论是开发聊天机器人、智能客服,还是进行多模态内容创作,OpenAI-API-dotnet 都能提供流畅的开发体验。其基于 .NET Standard 2.0 构建,兼容性极强,可无缝运行于从传统 .NET Framework 到最新 .NET Core 的各类环境中,是 .NET 生态接入大模型能力的理想桥梁。

使用场景

一家电商企业的 .NET 开发团队需要在后台系统中集成智能客服功能,以自动回复用户关于订单状态和退货政策的咨询。

没有 OpenAI-API-dotnet 时

  • 开发人员必须手动编写复杂的 HTTP 请求代码来处理 REST API 调用,包括设置 Header、序列化 JSON 负载以及处理网络异常,代码冗余且容易出错。
  • 缺乏原生的流式传输(Streaming)支持,用户只能等待模型生成完整回复后才能看到结果,导致交互体验延迟高、不流畅。
  • 管理多轮对话上下文极其繁琐,开发者需自行切割和计算 Token 长度以防止超出限制,极易引发运行时错误或截断关键信息。
  • 集成语音转文字或图片识别(GPT Vision)等多模态功能时,需要额外寻找第三方库或重复造轮子,大幅拉长开发周期。

使用 OpenAI-API-dotnet 后

  • 通过简单的 api.Chat.CreateChatCompletionAsync 方法即可发起请求,底层网络通信与数据序列化完全自动化,代码量减少 70% 以上。
  • 原生支持流式结果输出,利用 C# 的异步枚举轻松实现打字机效果,显著提升了终端用户的实时交互体验。
  • 内置对话历史管理与上下文长度自动优化机制,开发者只需关注业务逻辑,无需担忧 Token 超限导致的程序崩溃。
  • 统一封装了文本、音频、图像及嵌入向量等全量 API 接口,团队能在一天内快速完成从纯文本到多模态智能客服的功能迭代。

OpenAI-API-dotnet 将复杂的 API 交互转化为直观的 C# 对象操作,让 .NET 开发者能专注于业务创新而非底层通信细节。

运行环境要求

操作系统
  • Windows
  • Linux
  • macOS
GPU

未说明

内存

未说明

依赖
notes这是一个 C#/.NET SDK 库,用于调用 OpenAI API,本身不运行本地 AI 模型,因此无需 GPU、大内存或 Python 环境。它作为客户端库运行,支持所有符合 .NET Standard 2.0 的平台(包括控制台应用、WinForms、WPF、ASP.NET、Unity、Xamarin 等)。使用时需要配置 OpenAI API Key。
python不适用 (基于 .NET)
.NET Standard 2.0
.NET Framework >= 4.7.2
.NET Core >= 3.0
OpenAI-API-dotnet hero image

快速开始

微软联系了我,希望将这个库迁移到新的官方 C# OpenAI 库中,现在它已经准备就绪!从 v2.0.0-beta.3 开始,官方库现已实现全面覆盖,并将持续保持更新。更多详情请参见此博客文章:https://devblogs.microsoft.com/dotnet/openai-dotnet-library

此 GitHub 仓库将继续保留,用于记录我最初的库版本,直至 1.11 版本,该版本目前仍可在 NuGet 上获取。 🎉

用于访问 OpenAI API 的 C#/.NET SDK,包括 GPT-3.5/4、GPT-3.5/4-Turbo 以及 DALL-E 2/3

一个简单的 C# .NET 封装库,用于与 OpenAI 的 API 配合使用。更多背景信息请参阅我的博客:https://rogerpincombe.com/openai-dotnet-api这是我最初开发的非官方 OpenAI API 封装库。

快速示例

var api = new OpenAI_API.OpenAIAPI("YOUR_API_KEY");
var result = await api.Chat.CreateChatCompletionAsync("Hello!");
Console.WriteLine(result);
// 应该打印出类似“Hi! How can I help you?”的内容

自述文件

状态

OpenAI

v2.0.0-beta 起,该库已被微软采纳。新官方版本的库将实现全面覆盖,并始终保持最新状态。更多详细信息请参阅此博客文章:https://devblogs.microsoft.com/dotnet/openai-dotnet-library/。此 GitHub 仓库将继续保留,以记录我最初的库版本,直至 1.11 版本,该版本目前仍可在 NuGet 上获取

要求

该库基于 .NET Standard 2.0,因此应在所有 .NET 版本上运行,从传统的 .NET Framework >=4.7.2 到 .NET (Core) >= 3.0。它适用于控制台应用程序、WinForms、WPF、ASP.NET、Unity、Xamarin 等多种平台。此外,它还应能在 Windows、Linux 和 Mac 系统上运行,甚至可能支持移动设备。该库依赖项极少,并采用公共领域许可。

入门指南

从 NuGet 安装

安装 NuGet 包 OpenAI v1.11。通过命令行安装方法如下:

Install-Package OpenAI -Version 1.11.0

身份验证

提供 API 密钥的方式有三种,按优先级顺序排列:

  1. 直接将密钥传递给 APIAuthentication(string key) 构造函数
  2. 设置环境变量 OPENAI_API_KEY(或为兼容旧版而设置的 OPENAI_KEY
  3. 在本地目录或用户目录下创建名为 .openai 的配置文件,内容如下:
OPENAI_API_KEY=sk-aaaabbbbbccccddddd

在初始化 API 时,您需要使用 APIAuthentication 类,例如:

// 示例
OpenAIAPI api = new OpenAIAPI("YOUR_API_KEY"); // 简写
// 或
OpenAIAPI api = new OpenAIAPI(new APIAuthentication("YOUR_API_KEY")); // 手动创建对象
// 或
OpenAIAPI api = new OpenAIAPI(APIAuthentication LoadFromEnv()); // 使用环境变量
// 或
OpenAIAPI api = new OpenAIAPI(APIAuthentication LoadFromPath()); // 使用配置文件(可指定查找路径)
// 或
OpenAIAPI api = new OpenAIAPI(); // 使用默认值、环境变量或配置文件

您还可以选择性地指定 openAIOrganization(通过环境变量或配置文件中的 OPENAI_ORGANIZATION),以明确此次 API 请求所属的组织。此类请求的使用量将计入指定组织的订阅配额。组织 ID 可在您的 组织设置页面 中找到。

// 示例
OpenAIAPI api = new OpenAIAPI(new APIAuthentication("YOUR_API_KEY","org-yourOrgHere"));

聊天 API

聊天 API 可通过 OpenAIAPI.Chat 访问。使用聊天端点有两种方式:一种是通过简化的对话模式,另一种则是使用完整的请求/响应方法。

聊天对话

Conversation 类允许您轻松地与 ChatGPT 交互,只需添加消息并让 ChatGPT 回答即可。

var chat = api.Chat.CreateConversation();
chat.Model = Model.GPT4_Turbo;
chat.RequestParameters.Temperature = 0;

/// 作为系统给出指令
chat.AppendSystemMessage("你是一位老师,帮助孩子们判断某物是否为动物。如果用户告诉你某物是动物,你就回答‘是’;如果用户告诉你某物不是动物,你就回答‘否’。你只回答‘是’或‘否’,绝不说其他内容。");

// 添加一些用户和助手的示例
chat.AppendUserInput("这是动物吗?猫");
chat.AppendExampleChatbotOutput("是");
chat.AppendUserInput("这是动物吗?房子");
chat.AppendExampleChatbotOutput("否");

// 现在让我们问一个问题
chat.AppendUserInput("这是动物吗?狗");
// 并获取回复
string response = await chat.GetResponseFromChatbotAsync();
Console.WriteLine(response); // "是"

// 继续对话,再问一个问题
chat.AppendUserInput("这是动物吗?椅子");
// 再次获取回复
response = await chat.GetResponseFromChatbotAsync();
Console.WriteLine(response); // "否"

// 整个聊天记录可在 chat.Messages 中查看
foreach (ChatMessage msg in chat.Messages)
{
	Console.WriteLine($"{msg.Role}: {msg.Content}");
}

聊天流式传输

流式传输允许您在结果生成时实时获取它们,从而使您的应用程序显得更加流畅和响应迅速。

使用新的 C# 8.0 异步迭代器:

var chat = api.Chat.CreateConversation();
chat.AppendUserInput("如何制作汉堡?");

await foreach (var res in chat.StreamResponseEnumerableFromChatbotAsync())
{
	Console.Write(res);
}

或者,如果您使用的是经典的 .NET Framework 或 C# <8.0:

var chat = api.Chat.CreateConversation();
chat.AppendUserInput("如何制作汉堡?");

await chat.StreamResponseFromChatbotAsync(res =>
{
	Console.Write(res);
});

GPT 视觉

您可以向聊天发送图片,以使用新的 GPT-4 视觉模型。此功能仅适用于 Model.GPT4_Vision 模型。有关更多信息和限制,请参阅 https://platform.openai.com/docs/guides/vision。

// 最简单的形式
var result = await api.Chat.CreateChatCompletionAsync("这个 로고의 주요한 비백색 색상은 무엇인가요?", ImageInput.FromFile("path/to/logo.png"));

// 또는 대화에서
var chat = api.Chat.CreateConversation();
chat.Model = Model.GPT4_Vision;
chat.AppendSystemMessage("당신은 색상을 식별하는 데 도움을 주는 그래픽 디자인 어시스턴트입니다.");
chat.AppendUserInput("이 로고의 주요한 비백색 색상은 무엇입니까?", ImageInput.FromFile("path/to/logo.png"));
string response = await chat.GetResponseFromChatbotAsync();
Console.WriteLine(response); // "파란색과 보라색"
chat.AppendUserInput("이 로고의 주요한 비백색 색상은 무엇입니까?", ImageInput.FromImageUrl("https://rogerpincombe.com/templates/rp/center-aligned-no-shadow-small.png"));
response = await chat.GetResponseFromChatbotAsync();
Console.WriteLine(response); // "파란색, 빨간색, 노란색"

// 또는 챗메시지를 수동으로 생성할 때
messageWithImage = new ChatMessage(ChatMessageRole.User, "이 로고들에는 어떤 색상이 공통적으로 있나요?");
messageWithImage.images.Add(ImageInput.FromFile("path/to/logo.png"));
messageWithImage.images.Add(ImageInput.FromImageUrl("https://rogerpincombe.com/templates/rp/center-aligned-no-shadow-small.png"));

// 한 번에 여러 장의 이미지를 지정할 수 있습니다
chat.AppendUserInput("이 로고들에는 어떤 색상이 공통적으로 있나요?", ImageInput.FromFile("path/to/logo.png"), ImageInput.FromImageUrl("https://rogerpincombe.com/templates/rp/center-aligned-no-shadow-small.png"));

대화 기록 컨텍스트 길이 관리

채팅 대화 기록이 너무 길어지면 모델의 컨텍스트 길이에 맞지 않을 수 있습니다。 기본적으로 가장 오래된 시스템 메시지가 아닌 메시지부터 대화 기록에서 제거되고 API 호출이 다시 시도됩니다。 이 기능을 비활성화하려면 chat.AutoTruncateOnContextLengthExceeded = false로 설정하거나 다음과 같이 트렁케이션 알고리즘을 재정의할 수 있습니다:

chat.OnTruncationNeeded += (sender, args) =>
{
	// args는 현재 대화 기록을 포함하는 ChatMessage 리스트입니다. 필요에 따라 제거하거나 수정하세요.
	// 대화 기록 요약 등 사용 사례에 맞는 더 정교한 로직으로 대체하세요
	for (int i = 0; i < args.Count; i++)
	{
		if (args[i].Role != ChatMessageRole.System)
		{
			args.RemoveAt(i);
			return;
		}
	}
};

또한 더 큰 컨텍스트 길이를 가진 새로운 모델을 사용할 수도 있습니다。 이를 위해 chat.Model = Model.GPT4_Turbo 또는 chat.Model = Model.ChatGPTTurbo_16k 등을 설정하면 됩니다。

토큰 사용량은 chat.MostRecentApiResult.Usage.PromptTokens 및 관련 속성을 통해 확인할 수 있습니다。

채팅 엔드포인트 요청

OpenAIAPI.Chat.CreateChatCompletionAsync() 및 관련 메서드를 사용하면 채팅 API를 완전히 제어할 수 있습니다。

async Task<ChatResult> CreateChatCompletionAsync(ChatRequest request);

// 예를 들어
var result = await api.Chat.CreateChatCompletionAsync(new ChatRequest()
	{
		Model = Model.ChatGPTTurbo,
		Temperature = 0.1,
		MaxTokens = 50,
		Messages = new ChatMessage[] {
			new ChatMessage(ChatMessageRole.User, "안녕하세요!")
		}
	})
// 또는
var result = api.Chat.CreateChatCompletionAsync("안녕하세요!");

var reply = results.Choices[0].Message;
Console.WriteLine($"{reply.Role}: {reply.Content.Trim()}");
// 또는
Console.WriteLine(results);

이는 대부분 메타데이터로 구성된 ChatResult를 반환하므로, 단순히 어시스턴트의 응답 텍스트만 원한다면 .ToString() 메서드를 사용하세요.

또한 Completions 엔드포인트 스트리밍 결과와 유사하게 작동하는 비동기 스트리밍 API도 있습니다。

JSON 모드

새로운 Model.GPT4_Turbo 또는 gpt-3.5-turbo-1106 모델을 사용할 경우, ChatRequest.ResponseFormatChatRequest.ResponseFormats.JsonObject로 설정하여 JSON 모드를 활성화할 수 있습니다。JSON 모드가 활성화되면 모델은 유효한 JSON 객체로 파싱될 수 있는 문자열만 생성하도록 제한됩니다。 자세한 내용은 https://platform.openai.com/docs/guides/text-generation/json-mode를 참조하세요。

ChatRequest chatRequest = new ChatRequest()
{
	Model = model,
	Temperature = 0.0,
	MaxTokens = 500,
	ResponseFormat = ChatRequest.ResponseFormats.JsonObject,
	Messages = new ChatMessage[] {
		new ChatMessage(ChatMessageRole.System, "당신은 JSON을 출력하도록 설계된 유용한 어시스턴트입니다."),
		new ChatMessage(ChatMessageRole.User, "2020년 월드 시리즈 우승팀은 누구입니까? 연도를 숫자 키로, 우승팀을 문자열 값으로 하는 'wins' 딕셔너리를 JSON 형식으로 반환해 주세요.")
	}
};

var results = await api.Chat.CreateChatCompletionAsync(chatRequest);
Console.WriteLine(results);
/* 출력:
{
  "wins": {
	2020: "Los Angeles Dodgers"
  }
}
*/

Completions API

Completions은 OpenAI에 의해 레거시로 간주됩니다。Completions API는 OpenAIAPI.Completions을 통해 접근합니다:

async Task<CompletionResult> CreateCompletionAsync(CompletionRequest request);

// 예를 들어
var result = await api.Completions.CreateCompletionAsync(new CompletionRequest("One Two Three One Two", model: Model.CurieText, temperature: 0.1));
// 또는
var result = await api.Completions.CreateCompletionAsync("One Two Three One Two", temperature: 0.1);
// 기타 편의 오버로드

CompletionRequest를 미리 작성하거나 편의를 위해 제공되는 도우미 오버로드를 사용할 수 있습니다。이는 대부분 메타데이터로 구성된 CompletionResult를 반환하므로, 단순히 완료된 텍스트만 원한다면 .ToString() 메서드를 사용하세요。

스트리밍

스트리밍은 결과가 생성되는 즉시 받아볼 수 있게 해주며, 이는 특히 Davinci와 같은 느린 모델에서 애플리케이션이 더 반응성이 있도록 도와줍니다。

새로운 C# 8.0 비동기 이터레이터를 사용하면:

IAsyncEnumerable<CompletionResult> StreamCompletionEnumerableAsync(CompletionRequest request);

// 예를 들어
await foreach (var token in api.Completions.StreamCompletionEnumerableAsync(new CompletionRequest("제 이름은 Roger이고 Salesforce의 수석 소프트웨어 엔지니어입니다. 이것은 제 이력서입니다:", Model.DavinciText, 200, 0.5, 존재 페널티: 0.1, 빈도 페널티: 0.1)))
{
	Console.Write(token);
}

또는 클래식 .NET 프레임워크나 C# <8.0을 사용하는 경우:

async Task StreamCompletionAsync(CompletionRequest request, Action<CompletionResult> resultHandler);

// 예를 들어
await api.Completions.StreamCompletionAsync(
	new CompletionRequest("제 이름은 Roger이고 Salesforce의 수석 소프트웨어 엔지니어입니다. 이것은 제 이력서입니다:", Model.DavinciText, 200, 0.5, 존재 페널티: 0.1, 빈도 페널티: 0.1),
	res => ResumeTextbox.Text += res.ToString());

音频

音频 API 包括文本转语音、转录(语音转文本)以及翻译(非英语语音转英语文本)。

文本转语音 (TTS)

TTS API 可通过 OpenAIAPI.TextToSpeech 访问:

await api.TextToSpeech.SaveSpeechToFileAsync("你好,勇敢的新世界!这是一次测试。", outputPath);
// 你可以用默认的音频播放器打开它,如下所示:
Process.Start(outputPath);

你也可以使用 TextToSpeechRequest 对象来指定所有请求参数:

var request = new TextToSpeechRequest()
{
	Input = "你好,勇敢的新世界!这是一次测试。",
	ResponseFormat = ResponseFormats.AAC,
	Model = Model.TTS_HD,
	Voice = Voices.Nova,
	Speed = 0.9
};
await api.TextToSpeech.SaveSpeechToFileAsync(request, "test.aac");

除了保存到文件,你还可以通过 api.TextToSpeech.GetSpeechAsStreamAsync(request) 获取音频字节流:

using (Stream result = await api.TextToSpeech.GetSpeechAsStreamAsync("你好,勇敢的新世界!", Voices.Fable))
using (StreamReader reader = new StreamReader(result))
{
	// 在这里对音频流进行处理
}

转录(语音转文本)

音频转录 API 允许你从音频中生成文本,支持所有受支持的语言。它可以通过 OpenAIAPI.Transcriptions 访问:

string resultText = await api.Transcriptions.GetTextAsync("path/to/file.mp3");

你可以请求详细结果,这样会提供分段和标记级别的信息,以及标准的 OpenAI 元数据,例如处理时间:

AudioResultVerbose result = await api.Transcriptions.GetWithDetailsAsync("path/to/file.m4a");
Console.WriteLine(result.ProcessingTime.TotalMilliseconds); // 496毫秒
Console.WriteLine(result.text); // “你好,这是转录功能的测试。”
Console.WriteLine(result.language); // “英语”
Console.WriteLine(result.segments[0].no_speech_prob); // 0.03712
// 等等

你还可以请求 SRT 或 VTT 格式的结果,这对于为视频生成字幕非常有用:

string result = await api.Transcriptions.GetAsFormatAsync("path/to/file.m4a", AudioRequest.ResponseFormats.SRT);

额外的参数,如温度、提示、语言等,可以按每次请求指定,也可以设置为默认值:

// 内联指定
result = await api.Transcriptions.GetTextAsync("conversation.mp3", "en", "这是一份医生与其患者之间对话的转录:", 0.3);

// 设置默认值
api.Transcriptions.DefaultTranscriptionRequestArgs.Language = "en";

除了提供磁盘上的本地文件,你还可以提供音频字节流。这对于从麦克风或其他来源直接流式传输音频而无需先写入磁盘非常有用。请注意,你必须指定一个文件名,该文件名不必存在,但必须具有与所发送音频类型相符的准确扩展名。OpenAI 会根据文件扩展名来确定你的音频流格式。

using (var audioStream = File.OpenRead("path-here.mp3"))
{
	return await api.Transcriptions.GetTextAsync(audioStream, "file.mp3");
}

翻译(非英语语音转英语文本)

翻译功能允许你将任何受支持的语言的语音转录成英语。OpenAI 目前仅支持翻译成英语,不支持其他语言。它可以通过 OpenAIAPI.Translations 访问。

它支持与转录功能完全相同的功能:

string result = await api.Translations.GetTextAsync("chinese-example.m4a");

嵌入

嵌入 API 可通过 OpenAIAPI.Embeddings 访问:

async Task<EmbeddingResult> CreateEmbeddingAsync(EmbeddingRequest request);

// 例如
var result = await api.Embeddings.CreateEmbeddingAsync(new EmbeddingRequest("用于嵌入的测试文本", 模型:Model.AdaTextEmbedding));
// 或
var result = await api.Embeddings.CreateEmbeddingAsync("用于嵌入的测试文本");

嵌入结果包含大量元数据,实际的浮点向量位于 result.Data[].Embedding 中。

为了简化操作,你可以直接请求浮点向量并忽略多余的元数据,方法是使用 api.Embeddings.GetEmbeddingsAsync("test text here")

内容审核

内容审核 API 可通过 OpenAIAPI.Moderation 访问:

async Task<ModerationResult> CreateEmbeddingAsync(ModerationRequest request);

// 例如
var result = await api.Moderation.CallModerationAsync(new ModerationRequest("用于审核的测试文本", 模型:TextModerationLatest));
// 或
var result = await api.Moderation.CallModerationAsync("用于审核的测试文本");

Console.WriteLine(result.results[0].MainContentFlag);

结果位于 .results[0] 中,并提供了诸如 FlaggedCategoriesMainContentFlag 等便捷方法。

文件(用于微调)

文件 API 端点可通过 OpenAIAPI.Files 访问:

// 上传
async Task<File> UploadFileAsync(string filePath, string purpose = "fine-tune");

// 例如
var response = await api.Files.UploadFileAsync("fine-tuning-data.jsonl");
Console.Write(response.Id); // 上传文件的 ID

// 列出文件
async Task<List<File>> GetFilesAsync();

// 例如
var response = await api.Files.GetFilesAsync();
foreach (var file in response)
{
	Console.WriteLine(file.Name);
}

此外,还有获取文件内容、删除文件等方法。

用于微调的端点目前尚未实现,但很快就会添加。

图像

DALL-E 图像生成 API 可通过 OpenAIAPI.ImageGenerations 访问:

async Task<ImageResult> CreateImageAsync(ImageGenerationRequest request);

// 例如
var result = await api.ImageGenerations.CreateImageAsync(new ImageGenerationRequest("一台正在写测试的电脑的绘画", 1, ImageSize._512));
// 或
var result = await api.ImageGenerations.CreateImageAsync("一台正在写测试的电脑的绘画");

Console.WriteLine(result.Data[0].Url);

图像结果包含在线图片的 URL 或 Base64 编码的图片,具体取决于 ImageGenerationRequest.ResponseFormat(默认为 URL)。

DALL-E 3

使用 DALL-E 3 的方式如下:

async Task<ImageResult> CreateImageAsync(ImageGenerationRequest request);

// 例如
var result = await api.ImageGenerations.CreateImageAsync(new ImageGenerationRequest("一台正在写测试的电脑的绘画", OpenAI_API.Models.Model.DALLE3, ImageSize._1024x1792, "hd"));
// 或
var result = await api.ImageGenerations.CreateImageAsync("一台正在写测试的电脑的绘画", OpenAI_API.Models.Model.DALLE3);

Console.WriteLine(result.Data[0].Url);

Azure

要使用 Azure OpenAI 服务,您需要指定 Azure OpenAI 资源的名称以及模型部署 ID。

我无法访问 Microsoft Azure 的 OpenAI 服务,因此无法测试此功能。如果您有访问权限并能进行测试,请提交一个问题,描述您的测试结果。同时,也非常欢迎包含集成测试的拉取请求。特别是,目前尚不清楚在 Azure 上指定模型的方式是否与常规用法一致。

有关更多信息,请参阅 Azure OpenAI 文档#64 中的详细截图

对于 Azure 服务,配置应类似于以下示例:

OpenAIAPI api = OpenAIAPI.ForAzure("YourResourceName", "deploymentId", "api-key");
api.ApiVersion = "2023-03-15-preview"; // 需要此版本才能访问 Azure 上的聊天端点

之后您可以像平常一样使用 api 对象。此外,您也可以按照上文 身份验证 部分列出的其他方式来指定 APIAuthentication。目前,该库仅支持 API 密钥流,而不支持 AD 流。

截至 2023 年 4 月 2 日,如需访问 Azure 上的聊天端点,您必须手动选择上述的 API 版本 2023-03-15-preview。待该版本脱离预览后,我会更新默认设置。

IHttpClientFactory

您可以指定一个用于 HTTP 请求的 IHttpClientFactory,以便调整 HTTP 请求属性、连接池设置以及进行模拟测试。详情请参阅 #103

OpenAIAPI api = new OpenAIAPI();
api.HttpClientFactory = myIHttpClientFactoryObject;

文档

每个类、方法和属性都配有详尽的 XML 文档,因此它们应该会自动显示在 IntelliSense 中。结合官方 OpenAI 文档,这些内容足以帮助您快速上手。如果您有任何疑问,欢迎在此处提交问题。未来可能会提供更完善的文档。

许可证

CC-0 公有领域

本库采用 CC-0 许可证,属于公有领域。您可以将其用于任何用途,无论是公开还是私密,无需担心许可或授权等问题。它只是 OpenAI API 的封装层,因此您仍然需要直接从 OpenAI 获取访问权限。我与 OpenAI 没有任何关联,本库也未获得他们的认可。我只是拥有 OpenAI 的测试版访问权限,并希望开发一个 C# 库来更便捷地调用该 API。希望其他人也能从中受益。如果您有任何贡献意愿,欢迎提交拉取请求。

版本历史

v1.112024/06/12
v1.102023/12/14
v1.92023/12/12
v1.82023/12/07
v1.7.22023/04/02
v1.72023/04/02
v1.62023/03/09
v1.52023/02/16
v1.42023/02/03
v1.32023/02/03
v1.22020/12/23
v1.12020/07/28

相似工具推荐

openclaw

OpenClaw 是一款专为个人打造的本地化 AI 助手,旨在让你在自己的设备上拥有完全可控的智能伙伴。它打破了传统 AI 助手局限于特定网页或应用的束缚,能够直接接入你日常使用的各类通讯渠道,包括微信、WhatsApp、Telegram、Discord、iMessage 等数十种平台。无论你在哪个聊天软件中发送消息,OpenClaw 都能即时响应,甚至支持在 macOS、iOS 和 Android 设备上进行语音交互,并提供实时的画布渲染功能供你操控。 这款工具主要解决了用户对数据隐私、响应速度以及“始终在线”体验的需求。通过将 AI 部署在本地,用户无需依赖云端服务即可享受快速、私密的智能辅助,真正实现了“你的数据,你做主”。其独特的技术亮点在于强大的网关架构,将控制平面与核心助手分离,确保跨平台通信的流畅性与扩展性。 OpenClaw 非常适合希望构建个性化工作流的技术爱好者、开发者,以及注重隐私保护且不愿被单一生态绑定的普通用户。只要具备基础的终端操作能力(支持 macOS、Linux 及 Windows WSL2),即可通过简单的命令行引导完成部署。如果你渴望拥有一个懂你

349.3k|★★★☆☆|2天前
Agent开发框架图像

stable-diffusion-webui

stable-diffusion-webui 是一个基于 Gradio 构建的网页版操作界面,旨在让用户能够轻松地在本地运行和使用强大的 Stable Diffusion 图像生成模型。它解决了原始模型依赖命令行、操作门槛高且功能分散的痛点,将复杂的 AI 绘图流程整合进一个直观易用的图形化平台。 无论是希望快速上手的普通创作者、需要精细控制画面细节的设计师,还是想要深入探索模型潜力的开发者与研究人员,都能从中获益。其核心亮点在于极高的功能丰富度:不仅支持文生图、图生图、局部重绘(Inpainting)和外绘(Outpainting)等基础模式,还独创了注意力机制调整、提示词矩阵、负向提示词以及“高清修复”等高级功能。此外,它内置了 GFPGAN 和 CodeFormer 等人脸修复工具,支持多种神经网络放大算法,并允许用户通过插件系统无限扩展能力。即使是显存有限的设备,stable-diffusion-webui 也提供了相应的优化选项,让高质量的 AI 艺术创作变得触手可及。

162.1k|★★★☆☆|3天前
开发框架图像Agent

everything-claude-code

everything-claude-code 是一套专为 AI 编程助手(如 Claude Code、Codex、Cursor 等)打造的高性能优化系统。它不仅仅是一组配置文件,而是一个经过长期实战打磨的完整框架,旨在解决 AI 代理在实际开发中面临的效率低下、记忆丢失、安全隐患及缺乏持续学习能力等核心痛点。 通过引入技能模块化、直觉增强、记忆持久化机制以及内置的安全扫描功能,everything-claude-code 能显著提升 AI 在复杂任务中的表现,帮助开发者构建更稳定、更智能的生产级 AI 代理。其独特的“研究优先”开发理念和针对 Token 消耗的优化策略,使得模型响应更快、成本更低,同时有效防御潜在的攻击向量。 这套工具特别适合软件开发者、AI 研究人员以及希望深度定制 AI 工作流的技术团队使用。无论您是在构建大型代码库,还是需要 AI 协助进行安全审计与自动化测试,everything-claude-code 都能提供强大的底层支持。作为一个曾荣获 Anthropic 黑客大奖的开源项目,它融合了多语言支持与丰富的实战钩子(hooks),让 AI 真正成长为懂上

145.9k|★★☆☆☆|今天
开发框架Agent语言模型

ComfyUI

ComfyUI 是一款功能强大且高度模块化的视觉 AI 引擎,专为设计和执行复杂的 Stable Diffusion 图像生成流程而打造。它摒弃了传统的代码编写模式,采用直观的节点式流程图界面,让用户通过连接不同的功能模块即可构建个性化的生成管线。 这一设计巧妙解决了高级 AI 绘图工作流配置复杂、灵活性不足的痛点。用户无需具备编程背景,也能自由组合模型、调整参数并实时预览效果,轻松实现从基础文生图到多步骤高清修复等各类复杂任务。ComfyUI 拥有极佳的兼容性,不仅支持 Windows、macOS 和 Linux 全平台,还广泛适配 NVIDIA、AMD、Intel 及苹果 Silicon 等多种硬件架构,并率先支持 SDXL、Flux、SD3 等前沿模型。 无论是希望深入探索算法潜力的研究人员和开发者,还是追求极致创作自由度的设计师与资深 AI 绘画爱好者,ComfyUI 都能提供强大的支持。其独特的模块化架构允许社区不断扩展新功能,使其成为当前最灵活、生态最丰富的开源扩散模型工具之一,帮助用户将创意高效转化为现实。

108.1k|★★☆☆☆|今天
开发框架图像Agent

markitdown

MarkItDown 是一款由微软 AutoGen 团队打造的轻量级 Python 工具,专为将各类文件高效转换为 Markdown 格式而设计。它支持 PDF、Word、Excel、PPT、图片(含 OCR)、音频(含语音转录)、HTML 乃至 YouTube 链接等多种格式的解析,能够精准提取文档中的标题、列表、表格和链接等关键结构信息。 在人工智能应用日益普及的今天,大语言模型(LLM)虽擅长处理文本,却难以直接读取复杂的二进制办公文档。MarkItDown 恰好解决了这一痛点,它将非结构化或半结构化的文件转化为模型“原生理解”且 Token 效率极高的 Markdown 格式,成为连接本地文件与 AI 分析 pipeline 的理想桥梁。此外,它还提供了 MCP(模型上下文协议)服务器,可无缝集成到 Claude Desktop 等 LLM 应用中。 这款工具特别适合开发者、数据科学家及 AI 研究人员使用,尤其是那些需要构建文档检索增强生成(RAG)系统、进行批量文本分析或希望让 AI 助手直接“阅读”本地文件的用户。虽然生成的内容也具备一定可读性,但其核心优势在于为机器

93.4k|★★☆☆☆|2天前
插件开发框架

LLMs-from-scratch

LLMs-from-scratch 是一个基于 PyTorch 的开源教育项目,旨在引导用户从零开始一步步构建一个类似 ChatGPT 的大型语言模型(LLM)。它不仅是同名技术著作的官方代码库,更提供了一套完整的实践方案,涵盖模型开发、预训练及微调的全过程。 该项目主要解决了大模型领域“黑盒化”的学习痛点。许多开发者虽能调用现成模型,却难以深入理解其内部架构与训练机制。通过亲手编写每一行核心代码,用户能够透彻掌握 Transformer 架构、注意力机制等关键原理,从而真正理解大模型是如何“思考”的。此外,项目还包含了加载大型预训练权重进行微调的代码,帮助用户将理论知识延伸至实际应用。 LLMs-from-scratch 特别适合希望深入底层原理的 AI 开发者、研究人员以及计算机专业的学生。对于不满足于仅使用 API,而是渴望探究模型构建细节的技术人员而言,这是极佳的学习资源。其独特的技术亮点在于“循序渐进”的教学设计:将复杂的系统工程拆解为清晰的步骤,配合详细的图表与示例,让构建一个虽小但功能完备的大模型变得触手可及。无论你是想夯实理论基础,还是为未来研发更大规模的模型做准备

90.1k|★★★☆☆|2天前
语言模型图像Agent