Rename Response's Background to BackgroundModeEnabled (#622)

joseharriaga · web-flow · commit f77f26e1b398 · 2025-09-05T02:38:23.000-07:00
diff --git a/api/OpenAI.net8.0.cs b/api/OpenAI.net8.0.cs
@@ -4991,7 +4991,7 @@ public enum MessageStatus {
     }
     [Experimental("OPENAI001")]
     public class OpenAIResponse : IJsonModel<OpenAIResponse>, IPersistableModel<OpenAIResponse> {
-        public bool? Background { get; }
+        public bool? BackgroundModeEnabled { get; }
         public DateTimeOffset CreatedAt { get; }
         public string EndUserId { get; }
         public ResponseError Error { get; }
@@ -5069,7 +5069,7 @@ public class OpenAIResponseClient {
     [Experimental("OPENAI001")]
     public static class OpenAIResponsesModelFactory {
         public static MessageResponseItem MessageResponseItem(string id = null, MessageRole role = MessageRole.Assistant, MessageStatus? status = null);
-        public static OpenAIResponse OpenAIResponse(string id = null, DateTimeOffset createdAt = default, ResponseStatus? status = null, ResponseError error = null, ResponseTokenUsage usage = null, string endUserId = null, ResponseReasoningOptions reasoningOptions = null, int? maxOutputTokenCount = null, ResponseTextOptions textOptions = null, ResponseTruncationMode? truncationMode = null, ResponseIncompleteStatusDetails incompleteStatusDetails = null, IEnumerable<ResponseItem> outputItems = null, bool parallelToolCallsEnabled = false, ResponseToolChoice toolChoice = null, string model = null, IDictionary<string, string> metadata = null, float? temperature = null, float? topP = null, ResponseServiceTier? serviceTier = null, string previousResponseId = null, bool? background = null, string instructions = null, IEnumerable<ResponseTool> tools = null);
+        public static OpenAIResponse OpenAIResponse(string id = null, DateTimeOffset createdAt = default, ResponseStatus? status = null, ResponseError error = null, ResponseTokenUsage usage = null, string endUserId = null, ResponseReasoningOptions reasoningOptions = null, int? maxOutputTokenCount = null, ResponseTextOptions textOptions = null, ResponseTruncationMode? truncationMode = null, ResponseIncompleteStatusDetails incompleteStatusDetails = null, IEnumerable<ResponseItem> outputItems = null, bool parallelToolCallsEnabled = false, ResponseToolChoice toolChoice = null, string model = null, IDictionary<string, string> metadata = null, float? temperature = null, float? topP = null, ResponseServiceTier? serviceTier = null, string previousResponseId = null, bool? backgroundModeEnabled = null, string instructions = null, IEnumerable<ResponseTool> tools = null);
         public static ReasoningResponseItem ReasoningResponseItem(string id = null, string encryptedContent = null, ReasoningStatus? status = null, IEnumerable<ReasoningSummaryPart> summaryParts = null);
         public static ReasoningResponseItem ReasoningResponseItem(string id = null, string encryptedContent = null, ReasoningStatus? status = null, string summaryText = null);
         public static ReferenceResponseItem ReferenceResponseItem(string id = null);
@@ -5154,7 +5154,7 @@ public enum ResponseContentPartKind {
     }
     [Experimental("OPENAI001")]
     public class ResponseCreationOptions : IJsonModel<ResponseCreationOptions>, IPersistableModel<ResponseCreationOptions> {
-        public bool? Background { get; set; }
+        public bool? BackgroundModeEnabled { get; set; }
         public string EndUserId { get; set; }
         public string Instructions { get; set; }
         public int? MaxOutputTokenCount { get; set; }
diff --git a/api/OpenAI.netstandard2.0.cs b/api/OpenAI.netstandard2.0.cs
@@ -4390,7 +4390,7 @@ public enum MessageStatus {
         Incomplete = 2
     }
     public class OpenAIResponse : IJsonModel<OpenAIResponse>, IPersistableModel<OpenAIResponse> {
-        public bool? Background { get; }
+        public bool? BackgroundModeEnabled { get; }
         public DateTimeOffset CreatedAt { get; }
         public string EndUserId { get; }
         public ResponseError Error { get; }
@@ -4465,7 +4465,7 @@ public class OpenAIResponseClient {
     }
     public static class OpenAIResponsesModelFactory {
         public static MessageResponseItem MessageResponseItem(string id = null, MessageRole role = MessageRole.Assistant, MessageStatus? status = null);
-        public static OpenAIResponse OpenAIResponse(string id = null, DateTimeOffset createdAt = default, ResponseStatus? status = null, ResponseError error = null, ResponseTokenUsage usage = null, string endUserId = null, ResponseReasoningOptions reasoningOptions = null, int? maxOutputTokenCount = null, ResponseTextOptions textOptions = null, ResponseTruncationMode? truncationMode = null, ResponseIncompleteStatusDetails incompleteStatusDetails = null, IEnumerable<ResponseItem> outputItems = null, bool parallelToolCallsEnabled = false, ResponseToolChoice toolChoice = null, string model = null, IDictionary<string, string> metadata = null, float? temperature = null, float? topP = null, ResponseServiceTier? serviceTier = null, string previousResponseId = null, bool? background = null, string instructions = null, IEnumerable<ResponseTool> tools = null);
+        public static OpenAIResponse OpenAIResponse(string id = null, DateTimeOffset createdAt = default, ResponseStatus? status = null, ResponseError error = null, ResponseTokenUsage usage = null, string endUserId = null, ResponseReasoningOptions reasoningOptions = null, int? maxOutputTokenCount = null, ResponseTextOptions textOptions = null, ResponseTruncationMode? truncationMode = null, ResponseIncompleteStatusDetails incompleteStatusDetails = null, IEnumerable<ResponseItem> outputItems = null, bool parallelToolCallsEnabled = false, ResponseToolChoice toolChoice = null, string model = null, IDictionary<string, string> metadata = null, float? temperature = null, float? topP = null, ResponseServiceTier? serviceTier = null, string previousResponseId = null, bool? backgroundModeEnabled = null, string instructions = null, IEnumerable<ResponseTool> tools = null);
         public static ReasoningResponseItem ReasoningResponseItem(string id = null, string encryptedContent = null, ReasoningStatus? status = null, IEnumerable<ReasoningSummaryPart> summaryParts = null);
         public static ReasoningResponseItem ReasoningResponseItem(string id = null, string encryptedContent = null, ReasoningStatus? status = null, string summaryText = null);
         public static ReferenceResponseItem ReferenceResponseItem(string id = null);
@@ -4542,7 +4542,7 @@ public enum ResponseContentPartKind {
         Refusal = 5
     }
     public class ResponseCreationOptions : IJsonModel<ResponseCreationOptions>, IPersistableModel<ResponseCreationOptions> {
-        public bool? Background { get; set; }
+        public bool? BackgroundModeEnabled { get; set; }
         public string EndUserId { get; set; }
         public string Instructions { get; set; }
         public int? MaxOutputTokenCount { get; set; }
diff --git a/src/Custom/Responses/OpenAIResponse.cs b/src/Custom/Responses/OpenAIResponse.cs
@@ -14,6 +14,10 @@ namespace OpenAI.Responses;
 [CodeGenSuppress("OutputText")]
 public partial class OpenAIResponse
 {
+    // CUSTOM: Renamed.
+    [CodeGenMember("Background")]
+    public bool? BackgroundModeEnabled { get; }
+
     // CUSTOM: Renamed.
     [CodeGenMember("User")]
     public string EndUserId { get; }
diff --git a/src/Custom/Responses/OpenAIResponsesModelFactory.cs b/src/Custom/Responses/OpenAIResponsesModelFactory.cs
@@ -32,7 +32,7 @@ public static OpenAIResponse OpenAIResponse(
         float? topP = null,
         ResponseServiceTier? serviceTier = null,
         string previousResponseId = null,
-        bool? background = null,
+        bool? backgroundModeEnabled = null,
         string instructions = null,
         IEnumerable<ResponseTool> tools = null)
     {
@@ -46,7 +46,7 @@ public static OpenAIResponse OpenAIResponse(
            topP: topP,
            serviceTier: serviceTier,
            previousResponseId: previousResponseId,
-           background: background,
+           backgroundModeEnabled: backgroundModeEnabled,
            instructions: instructions,
            tools: tools.ToList(),
            id: id,
diff --git a/src/Custom/Responses/ResponseCreationOptions.cs b/src/Custom/Responses/ResponseCreationOptions.cs
@@ -33,6 +33,10 @@ public partial class ResponseCreationOptions
     // CUSTOM: Made internal. This value comes from a parameter on the client method.
     internal bool? Stream { get; set; }
 
+    // CUSTOM: Renamed.
+    [CodeGenMember("Background")]
+    public bool? BackgroundModeEnabled { get; set; }
+
     // CUSTOM: Renamed.
     [CodeGenMember("User")]
     public string EndUserId { get; set; }
diff --git a/src/Generated/Models/Responses/OpenAIResponse.Serialization.cs b/src/Generated/Models/Responses/OpenAIResponse.Serialization.cs
@@ -110,10 +110,10 @@ protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWrit
                 writer.WritePropertyName("reasoning"u8);
                 writer.WriteObjectValue(ReasoningOptions, options);
             }
-            if (Optional.IsDefined(Background) && _additionalBinaryDataProperties?.ContainsKey("background") != true)
+            if (Optional.IsDefined(BackgroundModeEnabled) && _additionalBinaryDataProperties?.ContainsKey("background") != true)
             {
                 writer.WritePropertyName("background"u8);
-                writer.WriteBooleanValue(Background.Value);
+                writer.WriteBooleanValue(BackgroundModeEnabled.Value);
             }
             if (Optional.IsDefined(MaxOutputTokenCount) && _additionalBinaryDataProperties?.ContainsKey("max_output_tokens") != true)
             {
@@ -263,7 +263,7 @@ internal static OpenAIResponse DeserializeOpenAIResponse(JsonElement element, Mo
             string previousResponseId = default;
             string model = default;
             ResponseReasoningOptions reasoningOptions = default;
-            bool? background = default;
+            bool? backgroundModeEnabled = default;
             int? maxOutputTokenCount = default;
             string instructions = default;
             ResponseTextOptions textOptions = default;
@@ -372,10 +372,10 @@ internal static OpenAIResponse DeserializeOpenAIResponse(JsonElement element, Mo
                 {
                     if (prop.Value.ValueKind == JsonValueKind.Null)
                     {
-                        background = null;
+                        backgroundModeEnabled = null;
                         continue;
                     }
-                    background = prop.Value.GetBoolean();
+                    backgroundModeEnabled = prop.Value.GetBoolean();
                     continue;
                 }
                 if (prop.NameEquals("max_output_tokens"u8))
@@ -520,7 +520,7 @@ internal static OpenAIResponse DeserializeOpenAIResponse(JsonElement element, Mo
                 previousResponseId,
                 model,
                 reasoningOptions,
-                background,
+                backgroundModeEnabled,
                 maxOutputTokenCount,
                 instructions,
                 textOptions,
diff --git a/src/Generated/Models/Responses/OpenAIResponse.cs b/src/Generated/Models/Responses/OpenAIResponse.cs
@@ -31,7 +31,7 @@ internal OpenAIResponse(IDictionary<string, string> metadata, float? temperature
             ParallelToolCallsEnabled = parallelToolCallsEnabled;
         }
 
-        internal OpenAIResponse(IDictionary<string, string> metadata, float? temperature, float? topP, string endUserId, ResponseServiceTier? serviceTier, string previousResponseId, string model, ResponseReasoningOptions reasoningOptions, bool? background, int? maxOutputTokenCount, string instructions, ResponseTextOptions textOptions, IList<ResponseTool> tools, ResponseToolChoice toolChoice, ResponseTruncationMode? truncationMode, string id, string @object, ResponseStatus? status, DateTimeOffset createdAt, ResponseError error, ResponseIncompleteStatusDetails incompleteStatusDetails, IList<ResponseItem> outputItems, ResponseTokenUsage usage, bool parallelToolCallsEnabled, IDictionary<string, BinaryData> additionalBinaryDataProperties)
+        internal OpenAIResponse(IDictionary<string, string> metadata, float? temperature, float? topP, string endUserId, ResponseServiceTier? serviceTier, string previousResponseId, string model, ResponseReasoningOptions reasoningOptions, bool? backgroundModeEnabled, int? maxOutputTokenCount, string instructions, ResponseTextOptions textOptions, IList<ResponseTool> tools, ResponseToolChoice toolChoice, ResponseTruncationMode? truncationMode, string id, string @object, ResponseStatus? status, DateTimeOffset createdAt, ResponseError error, ResponseIncompleteStatusDetails incompleteStatusDetails, IList<ResponseItem> outputItems, ResponseTokenUsage usage, bool parallelToolCallsEnabled, IDictionary<string, BinaryData> additionalBinaryDataProperties)
         {
             // Plugin customization: ensure initialization of collections
             Metadata = metadata ?? new ChangeTrackingDictionary<string, string>();
@@ -42,7 +42,7 @@ internal OpenAIResponse(IDictionary<string, string> metadata, float? temperature
             PreviousResponseId = previousResponseId;
             Model = model;
             ReasoningOptions = reasoningOptions;
-            Background = background;
+            BackgroundModeEnabled = backgroundModeEnabled;
             MaxOutputTokenCount = maxOutputTokenCount;
             Instructions = instructions;
             TextOptions = textOptions;
@@ -71,8 +71,6 @@ internal OpenAIResponse(IDictionary<string, string> metadata, float? temperature
 
         public string PreviousResponseId { get; }
 
-        public bool? Background { get; }
-
         public string Instructions { get; }
 
         public IList<ResponseTool> Tools { get; }
diff --git a/src/Generated/Models/Responses/ResponseCreationOptions.Serialization.cs b/src/Generated/Models/Responses/ResponseCreationOptions.Serialization.cs
@@ -81,10 +81,10 @@ protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWrit
                 writer.WritePropertyName("reasoning"u8);
                 writer.WriteObjectValue(ReasoningOptions, options);
             }
-            if (Optional.IsDefined(Background) && _additionalBinaryDataProperties?.ContainsKey("background") != true)
+            if (Optional.IsDefined(BackgroundModeEnabled) && _additionalBinaryDataProperties?.ContainsKey("background") != true)
             {
                 writer.WritePropertyName("background"u8);
-                writer.WriteBooleanValue(Background.Value);
+                writer.WriteBooleanValue(BackgroundModeEnabled.Value);
             }
             if (Optional.IsDefined(MaxOutputTokenCount) && _additionalBinaryDataProperties?.ContainsKey("max_output_tokens") != true)
             {
@@ -205,7 +205,7 @@ internal static ResponseCreationOptions DeserializeResponseCreationOptions(JsonE
             string previousResponseId = default;
             string model = default;
             ResponseReasoningOptions reasoningOptions = default;
-            bool? background = default;
+            bool? backgroundModeEnabled = default;
             int? maxOutputTokenCount = default;
             string instructions = default;
             ResponseTextOptions textOptions = default;
@@ -304,10 +304,10 @@ internal static ResponseCreationOptions DeserializeResponseCreationOptions(JsonE
                 {
                     if (prop.Value.ValueKind == JsonValueKind.Null)
                     {
-                        background = null;
+                        backgroundModeEnabled = null;
                         continue;
                     }
-                    background = prop.Value.GetBoolean();
+                    backgroundModeEnabled = prop.Value.GetBoolean();
                     continue;
                 }
                 if (prop.NameEquals("max_output_tokens"u8))
@@ -438,7 +438,7 @@ internal static ResponseCreationOptions DeserializeResponseCreationOptions(JsonE
                 previousResponseId,
                 model,
                 reasoningOptions,
-                background,
+                backgroundModeEnabled,
                 maxOutputTokenCount,
                 instructions,
                 textOptions,
diff --git a/src/Generated/Models/Responses/ResponseCreationOptions.cs b/src/Generated/Models/Responses/ResponseCreationOptions.cs
@@ -14,7 +14,7 @@ public partial class ResponseCreationOptions
     {
         private protected IDictionary<string, BinaryData> _additionalBinaryDataProperties;
 
-        internal ResponseCreationOptions(IDictionary<string, string> metadata, float? temperature, float? topP, string endUserId, ResponseServiceTier? serviceTier, string previousResponseId, string model, ResponseReasoningOptions reasoningOptions, bool? background, int? maxOutputTokenCount, string instructions, ResponseTextOptions textOptions, IList<ResponseTool> tools, ResponseToolChoice toolChoice, ResponseTruncationMode? truncationMode, IList<ResponseItem> input, IList<InternalIncludable> include, bool? parallelToolCallsEnabled, bool? storedOutputEnabled, bool? stream, IDictionary<string, BinaryData> additionalBinaryDataProperties)
+        internal ResponseCreationOptions(IDictionary<string, string> metadata, float? temperature, float? topP, string endUserId, ResponseServiceTier? serviceTier, string previousResponseId, string model, ResponseReasoningOptions reasoningOptions, bool? backgroundModeEnabled, int? maxOutputTokenCount, string instructions, ResponseTextOptions textOptions, IList<ResponseTool> tools, ResponseToolChoice toolChoice, ResponseTruncationMode? truncationMode, IList<ResponseItem> input, IList<InternalIncludable> include, bool? parallelToolCallsEnabled, bool? storedOutputEnabled, bool? stream, IDictionary<string, BinaryData> additionalBinaryDataProperties)
         {
             // Plugin customization: ensure initialization of collections
             Metadata = metadata ?? new ChangeTrackingDictionary<string, string>();
@@ -25,7 +25,7 @@ internal ResponseCreationOptions(IDictionary<string, string> metadata, float? te
             PreviousResponseId = previousResponseId;
             Model = model;
             ReasoningOptions = reasoningOptions;
-            Background = background;
+            BackgroundModeEnabled = backgroundModeEnabled;
             MaxOutputTokenCount = maxOutputTokenCount;
             Instructions = instructions;
             TextOptions = textOptions;
@@ -50,8 +50,6 @@ internal ResponseCreationOptions(IDictionary<string, string> metadata, float? te
 
         public string PreviousResponseId { get; set; }
 
-        public bool? Background { get; set; }
-
         public string Instructions { get; set; }
 
         internal IDictionary<string, BinaryData> SerializedAdditionalRawData
diff --git a/src/Generated/OpenAIModelFactory.cs b/src/Generated/OpenAIModelFactory.cs
diff --git a/tests/Responses/ResponsesTests.cs b/tests/Responses/ResponsesTests.cs

Original file line number	Diff line number	Diff line change
`@@ -110,10 +110,10 @@ protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWrit`
`110`	`110`	`writer.WritePropertyName("reasoning"u8);`
`111`	`111`	`writer.WriteObjectValue(ReasoningOptions, options);`
`112`	`112`	`}`
`113`		`- if (Optional.IsDefined(Background) && _additionalBinaryDataProperties?.ContainsKey("background") != true)`
	`113`	`+ if (Optional.IsDefined(BackgroundModeEnabled) && _additionalBinaryDataProperties?.ContainsKey("background") != true)`
`114`	`114`	`{`
`115`	`115`	`writer.WritePropertyName("background"u8);`
`116`		`- writer.WriteBooleanValue(Background.Value);`
	`116`	`+ writer.WriteBooleanValue(BackgroundModeEnabled.Value);`
`117`	`117`	`}`
`118`	`118`	`if (Optional.IsDefined(MaxOutputTokenCount) && _additionalBinaryDataProperties?.ContainsKey("max_output_tokens") != true)`
`119`	`119`	`{`
`@@ -263,7 +263,7 @@ internal static OpenAIResponse DeserializeOpenAIResponse(JsonElement element, Mo`
`263`	`263`	`string previousResponseId = default;`
`264`	`264`	`string model = default;`
`265`	`265`	`ResponseReasoningOptions reasoningOptions = default;`
`266`		`- bool? background = default;`
	`266`	`+ bool? backgroundModeEnabled = default;`
`267`	`267`	`int? maxOutputTokenCount = default;`
`268`	`268`	`string instructions = default;`
`269`	`269`	`ResponseTextOptions textOptions = default;`
`@@ -372,10 +372,10 @@ internal static OpenAIResponse DeserializeOpenAIResponse(JsonElement element, Mo`
`372`	`372`	`{`
`373`	`373`	`if (prop.Value.ValueKind == JsonValueKind.Null)`
`374`	`374`	`{`
`375`		`- background = null;`
	`375`	`+ backgroundModeEnabled = null;`
`376`	`376`	`continue;`
`377`	`377`	`}`
`378`		`- background = prop.Value.GetBoolean();`
	`378`	`+ backgroundModeEnabled = prop.Value.GetBoolean();`
`379`	`379`	`continue;`
`380`	`380`	`}`
`381`	`381`	`if (prop.NameEquals("max_output_tokens"u8))`
`@@ -520,7 +520,7 @@ internal static OpenAIResponse DeserializeOpenAIResponse(JsonElement element, Mo`
`520`	`520`	`previousResponseId,`
`521`	`521`	`model,`
`522`	`522`	`reasoningOptions,`
`523`		`- background,`
	`523`	`+ backgroundModeEnabled,`
`524`	`524`	`maxOutputTokenCount,`
`525`	`525`	`instructions,`
`526`	`526`	`textOptions,`
Original file line number	Diff line number	Diff line change
`@@ -81,10 +81,10 @@ protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWrit`
`81`	`81`	`writer.WritePropertyName("reasoning"u8);`
`82`	`82`	`writer.WriteObjectValue(ReasoningOptions, options);`
`83`	`83`	`}`
`84`		`- if (Optional.IsDefined(Background) && _additionalBinaryDataProperties?.ContainsKey("background") != true)`
	`84`	`+ if (Optional.IsDefined(BackgroundModeEnabled) && _additionalBinaryDataProperties?.ContainsKey("background") != true)`
`85`	`85`	`{`
`86`	`86`	`writer.WritePropertyName("background"u8);`
`87`		`- writer.WriteBooleanValue(Background.Value);`
	`87`	`+ writer.WriteBooleanValue(BackgroundModeEnabled.Value);`
`88`	`88`	`}`
`89`	`89`	`if (Optional.IsDefined(MaxOutputTokenCount) && _additionalBinaryDataProperties?.ContainsKey("max_output_tokens") != true)`
`90`	`90`	`{`
`@@ -205,7 +205,7 @@ internal static ResponseCreationOptions DeserializeResponseCreationOptions(JsonE`
`205`	`205`	`string previousResponseId = default;`
`206`	`206`	`string model = default;`
`207`	`207`	`ResponseReasoningOptions reasoningOptions = default;`
`208`		`- bool? background = default;`
	`208`	`+ bool? backgroundModeEnabled = default;`
`209`	`209`	`int? maxOutputTokenCount = default;`
`210`	`210`	`string instructions = default;`
`211`	`211`	`ResponseTextOptions textOptions = default;`
`@@ -304,10 +304,10 @@ internal static ResponseCreationOptions DeserializeResponseCreationOptions(JsonE`
`304`	`304`	`{`
`305`	`305`	`if (prop.Value.ValueKind == JsonValueKind.Null)`
`306`	`306`	`{`
`307`		`- background = null;`
	`307`	`+ backgroundModeEnabled = null;`
`308`	`308`	`continue;`
`309`	`309`	`}`
`310`		`- background = prop.Value.GetBoolean();`
	`310`	`+ backgroundModeEnabled = prop.Value.GetBoolean();`
`311`	`311`	`continue;`
`312`	`312`	`}`
`313`	`313`	`if (prop.NameEquals("max_output_tokens"u8))`
`@@ -438,7 +438,7 @@ internal static ResponseCreationOptions DeserializeResponseCreationOptions(JsonE`
`438`	`438`	`previousResponseId,`
`439`	`439`	`model,`
`440`	`440`	`reasoningOptions,`
`441`		`- background,`
	`441`	`+ backgroundModeEnabled,`
`442`	`442`	`maxOutputTokenCount,`
`443`	`443`	`instructions,`
`444`	`444`	`textOptions,`