Prepare 2.0.0 release (Part 2) (#234)

joseharriaga · web-flow · commit e4af16915b12 · 2024-09-30T15:44:59.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,18 +1,35 @@
 # Release History
 
-## 2.0.0-beta.14 (Unreleased)
+## 2.0.0 (2024-09-30)
+
+> [!NOTE]
+> First stable version of the official OpenAI library for .NET.
+
+### Features Added
+
+- Support for OpenAI's latest flagship models, including GPT-4o, GPT-4o mini, o1-preview, and o1-mini
+- Support for the entire OpenAI REST API, including:
+  - Structured outputs
+  - Reasoning tokens
+  - Experimental support for Assistants beta v2
+- Support for sync and async APIs
+- Convenient APIs to facilitate working with streaming chat completions and assistants
+- Tons of other quality-of-life features for ease of use and productivity
 
 ### Breaking Changes
 
-- Implemented `ChatMessageContent` to encapsulate the representation of content parts in `ChatMessage`, `ChatCompletion`, and `StreamingChatCompletionUpdate`. (commit_hash)
-- Changed the representation of function arguments to `BinaryData` in `ChatToolCall`, `StreamingChatToolCallUpdate`, `ChatFunctionCall`, and `StreamingChatFunctionCallUpdate`. (commit_hash)
-- Renamed `OpenAIClientOptions`'s `ApplicationId` to `UserAgentApplicationId` (commit_hash)
-- Renamed `StreamingChatToolCallUpdate`'s `Id` to `ToolCallId` (commit_hash)
-- Renamed `StreamingChatCompletionUpdate`'s `Id` to `CompletionId` (commit_hash)
-- Replaced `Auto` and `None` in the deprecated `ChatFunctionChoice` with `CreateAutoChoice()` and `CreateNoneChoice()` (commit_hash)
-- Replaced the deprecated `ChatFunctionChoice(ChatFunction)` constructor with `CreateNamedChoice(string functionName)` (commit_hash)
-- Renamed `FileClient` to `OpenAIFileClient` and the corresponding `GetFileClient()` method in `OpenAIClient` to `GetOpenAIFileClient()`. (commit_hash)
-- Renamed `ModelClient` to `OpenAIModelClient` and the corresponding `GetModelClient()` method in `OpenAIClient` to `GetOpenAIModelClient()`. (commit_hash)
+> [!NOTE]
+> The following breaking changes only apply when upgrading from the previous 2.0.0-beta.* versions.
+
+- Implemented `ChatMessageContent` to encapsulate the representation of content parts in `ChatMessage`, `ChatCompletion`, and `StreamingChatCompletionUpdate`. ([31c2ba6](https://github.com/openai/openai-dotnet/commit/31c2ba63c625b1b4fc2640ddf378a97e89b89167))
+- Changed the representation of function arguments to `BinaryData` in `ChatToolCall`, `StreamingChatToolCallUpdate`, `ChatFunctionCall`, and `StreamingChatFunctionCallUpdate`. ([31c2ba6](https://github.com/openai/openai-dotnet/commit/31c2ba63c625b1b4fc2640ddf378a97e89b89167))
+- Renamed `OpenAIClientOptions`'s `ApplicationId` to `UserAgentApplicationId`. ([31c2ba6](https://github.com/openai/openai-dotnet/commit/31c2ba63c625b1b4fc2640ddf378a97e89b89167))
+- Renamed `StreamingChatToolCallUpdate`'s `Id` to `ToolCallId`. ([31c2ba6](https://github.com/openai/openai-dotnet/commit/31c2ba63c625b1b4fc2640ddf378a97e89b89167))
+- Renamed `StreamingChatCompletionUpdate`'s `Id` to `CompletionId`. ([31c2ba6](https://github.com/openai/openai-dotnet/commit/31c2ba63c625b1b4fc2640ddf378a97e89b89167))
+- Replaced `Auto` and `None` in the deprecated `ChatFunctionChoice` with `CreateAutoChoice()` and `CreateNoneChoice()`. ([31c2ba6](https://github.com/openai/openai-dotnet/commit/31c2ba63c625b1b4fc2640ddf378a97e89b89167))
+- Replaced the deprecated `ChatFunctionChoice(ChatFunction)` constructor with `CreateNamedChoice(string functionName)`. ([31c2ba6](https://github.com/openai/openai-dotnet/commit/31c2ba63c625b1b4fc2640ddf378a97e89b89167))
+- Renamed `FileClient` to `OpenAIFileClient` and the corresponding `GetFileClient()` method in `OpenAIClient` to `GetOpenAIFileClient()`. ([31c2ba6](https://github.com/openai/openai-dotnet/commit/31c2ba63c625b1b4fc2640ddf378a97e89b89167))
+- Renamed `ModelClient` to `OpenAIModelClient` and the corresponding `GetModelClient()` method in `OpenAIClient` to `GetOpenAIModelClient()`. ([31c2ba6](https://github.com/openai/openai-dotnet/commit/31c2ba63c625b1b4fc2640ddf378a97e89b89167))
 
 ## 2.0.0-beta.13 (2024-09-27)
 
diff --git a/README.md b/README.md
diff --git a/examples/Assets/images_apple.png b/examples/Assets/images_apple.png
diff --git a/examples/Assets/images_orange.png b/examples/Assets/images_orange.png
diff --git a/examples/Assistants/Example01_RetrievalAugmentedGeneration.cs b/examples/Assistants/Example01_RetrievalAugmentedGeneration.cs
@@ -20,7 +20,7 @@ public void Example01_RetrievalAugmentedGeneration()
         AssistantClient assistantClient = openAIClient.GetAssistantClient();
 
         // First, let's contrive a document we'll use retrieval with and upload it.
-        using Stream document = BinaryData.FromString("""
+        using Stream document = BinaryData.FromBytes("""
             {
                 "description": "This document contains the sale history data for Contoso products.",
                 "sales": [
@@ -47,7 +47,7 @@ public void Example01_RetrievalAugmentedGeneration()
                     }
                 ]
             }
-            """).ToStream();
+            """u8.ToArray()).ToStream();
 
         OpenAIFile salesFile = fileClient.UploadFile(
             document,
diff --git a/examples/Assistants/Example01_RetrievalAugmentedGenerationAsync.cs b/examples/Assistants/Example01_RetrievalAugmentedGenerationAsync.cs
@@ -21,7 +21,7 @@ public async Task Example01_RetrievalAugmentedGenerationAsync()
         AssistantClient assistantClient = openAIClient.GetAssistantClient();
 
         // First, let's contrive a document we'll use retrieval with and upload it.
-        using Stream document = BinaryData.FromString("""
+        using Stream document = BinaryData.FromBytes("""
             {
                 "description": "This document contains the sale history data for Contoso products.",
                 "sales": [
@@ -48,7 +48,7 @@ public async Task Example01_RetrievalAugmentedGenerationAsync()
                     }
                 ]
             }
-            """).ToStream();
+            """u8.ToArray()).ToStream();
 
         OpenAIFile salesFile = await fileClient.UploadFileAsync(
             document,
diff --git a/examples/Assistants/Example05_AssistantsWithVision.cs b/examples/Assistants/Example05_AssistantsWithVision.cs
@@ -19,9 +19,10 @@ public void Example05_AssistantsWithVision()
         AssistantClient assistantClient = openAIClient.GetAssistantClient();
 
         OpenAIFile pictureOfAppleFile = fileClient.UploadFile(
-            Path.Combine("Assets", "picture-of-apple.png"),
+            Path.Combine("Assets", "images_apple.png"),
             FileUploadPurpose.Vision);
-        Uri linkToPictureOfOrange = new("https://raw.githubusercontent.com/openai/openai-dotnet/refs/heads/main/examples/Assets/picture-of-orange.png");
+
+        Uri linkToPictureOfOrange = new("https://raw.githubusercontent.com/openai/openai-dotnet/refs/heads/main/examples/Assets/images_orange.png");
 
         Assistant assistant = assistantClient.CreateAssistant(
             "gpt-4o",
diff --git a/examples/Assistants/Example05_AssistantsWithVisionAsync.cs b/examples/Assistants/Example05_AssistantsWithVisionAsync.cs
@@ -20,9 +20,10 @@ public async Task Example05_AssistantsWithVisionAsync()
         AssistantClient assistantClient = openAIClient.GetAssistantClient();
 
         OpenAIFile pictureOfAppleFile = await fileClient.UploadFileAsync(
-            Path.Combine("Assets", "picture-of-apple.png"),
+            Path.Combine("Assets", "images_apple.png"),
             FileUploadPurpose.Vision);
-        Uri linkToPictureOfOrange = new("https://raw.githubusercontent.com/openai/openai-dotnet/refs/heads/main/examples/Assets/picture-of-orange.png");
+
+        Uri linkToPictureOfOrange = new("https://raw.githubusercontent.com/openai/openai-dotnet/refs/heads/main/examples/Assets/images_orange.png");
 
         Assistant assistant = await assistantClient.CreateAssistantAsync(
             "gpt-4o",
diff --git a/examples/Chat/Example02_SimpleChatStreaming.cs b/examples/Chat/Example02_SimpleChatStreaming.cs
@@ -12,8 +12,7 @@ public void Example02_SimpleChatStreaming()
     {
         ChatClient client = new(model: "gpt-4o", apiKey: Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
 
-        CollectionResult<StreamingChatCompletionUpdate> completionUpdates
-            = client.CompleteChatStreaming("Say 'this is a test.'");
+        CollectionResult<StreamingChatCompletionUpdate> completionUpdates = client.CompleteChatStreaming("Say 'this is a test.'");
 
         Console.Write($"[ASSISTANT]: ");
         foreach (StreamingChatCompletionUpdate completionUpdate in completionUpdates)
diff --git a/examples/Chat/Example02_SimpleChatStreamingAsync.cs b/examples/Chat/Example02_SimpleChatStreamingAsync.cs
@@ -13,8 +13,7 @@ public async Task Example02_SimpleChatStreamingAsync()
     {
         ChatClient client = new(model: "gpt-4o", apiKey: Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
 
-        AsyncCollectionResult<StreamingChatCompletionUpdate> completionUpdates
-            = client.CompleteChatStreamingAsync("Say 'this is a test.'");
+        AsyncCollectionResult<StreamingChatCompletionUpdate> completionUpdates = client.CompleteChatStreamingAsync("Say 'this is a test.'");
 
         Console.Write($"[ASSISTANT]: ");
         await foreach (StreamingChatCompletionUpdate completionUpdate in completionUpdates)
diff --git a/examples/Chat/Example03_FunctionCalling.cs b/examples/Chat/Example03_FunctionCalling.cs
@@ -31,7 +31,7 @@ private static string GetCurrentWeather(string location, string unit = "celsius"
     private static readonly ChatTool getCurrentWeatherTool = ChatTool.CreateFunctionTool(
         functionName: nameof(GetCurrentWeather),
         functionDescription: "Get the current weather in a given location",
-        functionParameters: BinaryData.FromString("""
+        functionParameters: BinaryData.FromBytes("""
             {
                 "type": "object",
                 "properties": {
@@ -47,7 +47,7 @@ private static string GetCurrentWeather(string location, string unit = "celsius"
                 },
                 "required": [ "location" ]
             }
-            """)
+            """u8.ToArray())
     );
     #endregion
 
diff --git a/examples/Chat/Example06_StructuredOutputs.cs b/examples/Chat/Example06_StructuredOutputs.cs
@@ -22,7 +22,7 @@ public void Example06_StructuredOutputs()
         {
             ResponseFormat = ChatResponseFormat.CreateJsonSchemaFormat(
                 jsonSchemaFormatName: "math_reasoning",
-                jsonSchema: BinaryData.FromString("""
+                jsonSchema: BinaryData.FromBytes("""
                     {
                         "type": "object",
                         "properties": {
@@ -43,7 +43,7 @@ public void Example06_StructuredOutputs()
                         "required": ["steps", "final_answer"],
                         "additionalProperties": false
                     }
-                    """),
+                    """u8.ToArray()),
                 jsonSchemaIsStrict: true)
         };
 
diff --git a/examples/Chat/Example06_StructuredOutputsAsync.cs b/examples/Chat/Example06_StructuredOutputsAsync.cs
@@ -23,7 +23,7 @@ public async Task Example06_StructuredOutputsAsync()
         {
             ResponseFormat = ChatResponseFormat.CreateJsonSchemaFormat(
                 jsonSchemaFormatName: "math_reasoning",
-                jsonSchema: BinaryData.FromString("""
+                jsonSchema: BinaryData.FromBytes("""
                     {
                         "type": "object",
                         "properties": {
@@ -44,7 +44,7 @@ public async Task Example06_StructuredOutputsAsync()
                         "required": ["steps", "final_answer"],
                         "additionalProperties": false
                     }
-                    """),
+                    """u8.ToArray()),
                 jsonSchemaIsStrict: true)
         };
 
diff --git a/src/OpenAI.csproj b/src/OpenAI.csproj
@@ -7,7 +7,7 @@
     <PackageTags>OpenAI;openai-dotnet;ChatGPT;Dall-E</PackageTags>
 
     <VersionPrefix>2.0.0</VersionPrefix>
-    <VersionSuffix>beta.13</VersionSuffix>
+    <VersionSuffix></VersionSuffix>
 
     <TargetFrameworks>netstandard2.0;net6.0</TargetFrameworks>
     <LangVersion>latest</LangVersion>

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public void Example01_RetrievalAugmentedGeneration()`
`20`	`20`	`AssistantClient assistantClient = openAIClient.GetAssistantClient();`
`21`	`21`
`22`	`22`	`// First, let's contrive a document we'll use retrieval with and upload it.`
`23`		`- using Stream document = BinaryData.FromString("""`
	`23`	`+ using Stream document = BinaryData.FromBytes("""`
`24`	`24`	`{`
`25`	`25`	`"description": "This document contains the sale history data for Contoso products.",`
`26`	`26`	`"sales": [`
`@@ -47,7 +47,7 @@ public void Example01_RetrievalAugmentedGeneration()`
`47`	`47`	`}`
`48`	`48`	`]`
`49`	`49`	`}`
`50`		`- """).ToStream();`
	`50`	`+ """u8.ToArray()).ToStream();`
`51`	`51`
`52`	`52`	`OpenAIFile salesFile = fileClient.UploadFile(`
`53`	`53`	`document,`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public async Task Example01_RetrievalAugmentedGenerationAsync()`
`21`	`21`	`AssistantClient assistantClient = openAIClient.GetAssistantClient();`
`22`	`22`
`23`	`23`	`// First, let's contrive a document we'll use retrieval with and upload it.`
`24`		`- using Stream document = BinaryData.FromString("""`
	`24`	`+ using Stream document = BinaryData.FromBytes("""`
`25`	`25`	`{`
`26`	`26`	`"description": "This document contains the sale history data for Contoso products.",`
`27`	`27`	`"sales": [`
`@@ -48,7 +48,7 @@ public async Task Example01_RetrievalAugmentedGenerationAsync()`
`48`	`48`	`}`
`49`	`49`	`]`
`50`	`50`	`}`
`51`		`- """).ToStream();`
	`51`	`+ """u8.ToArray()).ToStream();`
`52`	`52`
`53`	`53`	`OpenAIFile salesFile = await fileClient.UploadFileAsync(`
`54`	`54`	`document,`
Original file line number	Diff line number	Diff line change
`@@ -12,8 +12,7 @@ public void Example02_SimpleChatStreaming()`
`12`	`12`	`{`
`13`	`13`	`ChatClient client = new(model: "gpt-4o", apiKey: Environment.GetEnvironmentVariable("OPENAI_API_KEY"));`
`14`	`14`
`15`		`- CollectionResult<StreamingChatCompletionUpdate> completionUpdates`
`16`		`- = client.CompleteChatStreaming("Say 'this is a test.'");`
	`15`	`+ CollectionResult<StreamingChatCompletionUpdate> completionUpdates = client.CompleteChatStreaming("Say 'this is a test.'");`
`17`	`16`
`18`	`17`	`Console.Write($"[ASSISTANT]: ");`
`19`	`18`	`foreach (StreamingChatCompletionUpdate completionUpdate in completionUpdates)`
Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,7 @@ public async Task Example02_SimpleChatStreamingAsync()`
`13`	`13`	`{`
`14`	`14`	`ChatClient client = new(model: "gpt-4o", apiKey: Environment.GetEnvironmentVariable("OPENAI_API_KEY"));`
`15`	`15`
`16`		`- AsyncCollectionResult<StreamingChatCompletionUpdate> completionUpdates`
`17`		`- = client.CompleteChatStreamingAsync("Say 'this is a test.'");`
	`16`	`+ AsyncCollectionResult<StreamingChatCompletionUpdate> completionUpdates = client.CompleteChatStreamingAsync("Say 'this is a test.'");`
`18`	`17`
`19`	`18`	`Console.Write($"[ASSISTANT]: ");`
`20`	`19`	`await foreach (StreamingChatCompletionUpdate completionUpdate in completionUpdates)`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ public void Example06_StructuredOutputs()`
`22`	`22`	`{`
`23`	`23`	`ResponseFormat = ChatResponseFormat.CreateJsonSchemaFormat(`
`24`	`24`	`jsonSchemaFormatName: "math_reasoning",`
`25`		`- jsonSchema: BinaryData.FromString("""`
	`25`	`+ jsonSchema: BinaryData.FromBytes("""`
`26`	`26`	`{`
`27`	`27`	`"type": "object",`
`28`	`28`	`"properties": {`
`@@ -43,7 +43,7 @@ public void Example06_StructuredOutputs()`
`43`	`43`	`"required": ["steps", "final_answer"],`
`44`	`44`	`"additionalProperties": false`
`45`	`45`	`}`
`46`		`- """),`
	`46`	`+ """u8.ToArray()),`
`47`	`47`	`jsonSchemaIsStrict: true)`
`48`	`48`	`};`
`49`	`49`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public async Task Example06_StructuredOutputsAsync()`
`23`	`23`	`{`
`24`	`24`	`ResponseFormat = ChatResponseFormat.CreateJsonSchemaFormat(`
`25`	`25`	`jsonSchemaFormatName: "math_reasoning",`
`26`		`- jsonSchema: BinaryData.FromString("""`
	`26`	`+ jsonSchema: BinaryData.FromBytes("""`
`27`	`27`	`{`
`28`	`28`	`"type": "object",`
`29`	`29`	`"properties": {`
`@@ -44,7 +44,7 @@ public async Task Example06_StructuredOutputsAsync()`
`44`	`44`	`"required": ["steps", "final_answer"],`
`45`	`45`	`"additionalProperties": false`
`46`	`46`	`}`
`47`		`- """),`
	`47`	`+ """u8.ToArray()),`
`48`	`48`	`jsonSchemaIsStrict: true)`
`49`	`49`	`};`
`50`	`50`