Feedback

Author: ShivangiReja

examples/Chat/Example10_AdditionalProperties.cs

@@ -8,20 +8,26 @@ namespace OpenAI.Examples;
 
 public partial class ChatExamples
 {
-    [Test]
     public void Example10_AdditionalProperties()
     {
         ChatClient client = new(model: "gpt-5", apiKey: Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
 
-        // You can use the Patch property to set additional properties in the request
+        // Add extra request fields using Patch.
+        // Patch lets you set fields that aren’t modeled on ChatCompletionOptions in the request payload.
+        // See the API docs https://platform.openai.com/docs/api-reference/chat/create for supported additional fields.
         ChatCompletionOptions options = new();
         options.Patch.Set("$.reasoning_effort"u8, "minimal");
 
-        ChatCompletion completion = client.CompleteChat([new UserChatMessage("Say 'this is a test.'")], options);
+        ChatCompletion completion = client.CompleteChat(
+            [new UserChatMessage("Say 'this is a test.'")],
+            options);
 
         Console.WriteLine($"[ASSISTANT]: {completion.Content[0].Text}");
 
-        // You can also read additional properties back from the response
+        // Read extra fields from the response via Patch.
+        // The service returns a field named `service_tier` that isn’t modeled on ChatCompletion.
+        // You can access its value by using the path with Patch.
+        // See the API docs https://platform.openai.com/docs/api-reference/chat/object for supported additional fields.
         var serviceTier = completion.Patch.GetString("$.service_tier"u8);
         Console.WriteLine($"service_tier={serviceTier}");
     }

examples/Chat/Example10_AdditionalPropertiesAsync.cs

@@ -14,15 +14,20 @@ public async Task Example10_AdditionalPropertiesAsync()
     {
         ChatClient client = new(model: "gpt-5", apiKey: Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
 
-        // You can use the Patch property to set additional properties in the request
+        // Add extra request fields using Patch.
+        // Patch lets you set fields that aren’t modeled on ChatCompletionOptions in the request payload.
+        // See the API docs https://platform.openai.com/docs/api-reference/chat/create for supported additional fields.
         ChatCompletionOptions options = new();
         options.Patch.Set("$.reasoning_effort"u8, "minimal");
 
         ChatCompletion completion = await client.CompleteChatAsync([new UserChatMessage("Say 'this is a test.'")], options);
 
         Console.WriteLine($"[ASSISTANT]: {completion.Content[0].Text}");
 
-        // You can also read additional properties back from the response
+        // Read extra fields from the response via Patch.
+        // The service returns a field named `service_tier` that isn’t modeled on ChatCompletion.
+        // You can access its value by using the path with Patch.
+        // See the API docs https://platform.openai.com/docs/api-reference/chat/object for supported additional fields.
         var serviceTier = completion.Patch.GetString("$.service_tier"u8);
         Console.WriteLine($"service_tier={serviceTier}");
     }

examples/Responses/Example07_InputAdditionalProperties.cs

@@ -16,7 +16,9 @@ public void Example07_InputAdditionalProperties()
     {
         OpenAIResponseClient client = new(model: "gpt-5", apiKey: Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
 
-        // You can use the Patch property to set additional properties in the request
+        // Add extra request fields using Patch.
+        // Patch lets you set fields like `reasoning.effort` and `text.verbosity` that aren’t modeled on ResponseCreationOptions in the request payload.
+        // See the API docs https://platform.openai.com/docs/api-reference/responses/create for supported additional fields.
         ResponseCreationOptions options = new();
         options.Patch.Set("$.reasoning.effort"u8, "high");
         options.Patch.Set("$.text.verbosity"u8, "medium");
@@ -25,7 +27,10 @@ public void Example07_InputAdditionalProperties()
 
         Console.WriteLine($"[ASSISTANT]: {response.GetOutputText()}");
 
-        // You can also read additional properties back from the response
+        // Read extra fields from the response via Patch.
+        // The service returns fields like `reasoning.effort` and `text.verbosity` that aren’t modeled on OpenAIResponse.
+        // You can access their values by using the path with Patch.
+        // See the API docs https://platform.openai.com/docs/api-reference/responses/object for supported additional fields.
         var effort = response.Patch.GetString("$.reasoning.effort"u8);
         var verbosity = response.Patch.GetString("$.text.verbosity"u8);
         Console.WriteLine($"effort={effort}, verbosity={verbosity}");

examples/Responses/Example07_InputAdditionalPropertiesAsync.cs

@@ -17,7 +17,9 @@ public async Task Example07_InputAdditionalPropertiesAsync()
     {
         OpenAIResponseClient client = new(model: "gpt-5", apiKey: Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
 
-        // You can use the Patch property to set additional properties in the request
+        // Add extra request fields using Patch.
+        // Patch lets you set fields like `reasoning.effort` and `text.verbosity` that aren’t modeled on ResponseCreationOptions in the request payload.
+        // See the API docs https://platform.openai.com/docs/api-reference/responses/create for supported additional fields.
         ResponseCreationOptions options = new();
         options.Patch.Set("$.reasoning.effort"u8, "high");
         options.Patch.Set("$.text.verbosity"u8, "medium");
@@ -26,7 +28,10 @@ public async Task Example07_InputAdditionalPropertiesAsync()
 
         Console.WriteLine($"[ASSISTANT]: {response.GetOutputText()}");
 
-        // You can also read additional properties back from the response
+        // Read extra fields from the response via Patch.
+        // The service returns fields like `reasoning.effort` and `text.verbosity` that aren’t modeled on OpenAIResponse.
+        // You can access their values by using the path with Patch.
+        // See the API docs https://platform.openai.com/docs/api-reference/responses/object for supported additional fields.
         var effort = response.Patch.GetString("$.reasoning.effort"u8);
         var verbosity = response.Patch.GetString("$.text.verbosity"u8);
         Console.WriteLine($"effort={effort}, verbosity={verbosity}");

examples/Responses/Example08_OutputAdditionalProperties.cs

@@ -35,7 +35,10 @@ public void Example08_OutputAdditionalProperties()
         using FileStream stream = File.OpenWrite($"{Guid.NewGuid()}.png");
         bytes.ToStream().CopyTo(stream);
 
-        // You can use the Patch property to read additional properties from the response
+        // Read extra fields from the response via Patch.
+        // The service returns fields like `output_format` and `quality` that aren’t modeled on ImageGenerationCallResponseItem.
+        // You can access their values by using the path with Patch.
+        // See the API docs https://platform.openai.com/docs/api-reference/responses/object for supported additional fields.
         var outputFormat = imageGenResponse.Patch.GetString("$.output_format"u8);
         var quality = imageGenResponse.Patch.GetString("$.quality"u8);
         var size = imageGenResponse.Patch.GetString("$.size"u8);

examples/Responses/Example08_OutputAdditionalPropertiesAsync.cs

@@ -36,7 +36,10 @@ public async Task Example08_OutputAdditionalPropertiesAsync()
         using FileStream stream = File.OpenWrite($"{Guid.NewGuid()}.png");
         bytes.ToStream().CopyTo(stream);
 
-        // You can use the Patch property to read additional properties from the response
+        // Read extra fields from the response via Patch.
+        // The service returns fields like `output_format` and `quality` that aren’t modeled on ImageGenerationCallResponseItem.
+        // You can access their values by using the path with Patch.
+        // See the API docs https://platform.openai.com/docs/api-reference/responses/object for supported additional fields.
         var outputFormat = imageGenResponse.Patch.GetString("$.output_format"u8);
         var quality = imageGenResponse.Patch.GetString("$.quality"u8);
         var size = imageGenResponse.Patch.GetString("$.size"u8);