Add ContainerFileCitationMessageAnnotation

Author: joseharriaga

api/OpenAI.net8.0.cs

@@ -5040,6 +5040,19 @@ public class ComputerTool : ResponseTool, IJsonModel<ComputerTool>, IPersistable
         public override readonly string ToString();
     }
     [Experimental("OPENAI001")]
+    public class ContainerFileCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<ContainerFileCitationMessageAnnotation>, IPersistableModel<ContainerFileCitationMessageAnnotation> {
+        public ContainerFileCitationMessageAnnotation(string containerId, string fileId, int startIndex, int endIndex, string filename);
+        public string ContainerId { get; set; }
+        public int EndIndex { get; set; }
+        public string FileId { get; set; }
+        public string Filename { get; set; }
+        public int StartIndex { get; set; }
+        protected override ResponseMessageAnnotation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
+        protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
+        protected override ResponseMessageAnnotation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
+        protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
+    }
+    [Experimental("OPENAI001")]
     public class CustomMcpToolCallApprovalPolicy : IJsonModel<CustomMcpToolCallApprovalPolicy>, IPersistableModel<CustomMcpToolCallApprovalPolicy> {
         [EditorBrowsable(EditorBrowsableState.Never)]
         [Experimental("SCME0001")]

api/OpenAI.netstandard2.0.cs

@@ -4403,6 +4403,18 @@ public class ComputerTool : ResponseTool, IJsonModel<ComputerTool>, IPersistable
         public static bool operator !=(ComputerToolEnvironment left, ComputerToolEnvironment right);
         public override readonly string ToString();
     }
+    public class ContainerFileCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<ContainerFileCitationMessageAnnotation>, IPersistableModel<ContainerFileCitationMessageAnnotation> {
+        public ContainerFileCitationMessageAnnotation(string containerId, string fileId, int startIndex, int endIndex, string filename);
+        public string ContainerId { get; set; }
+        public int EndIndex { get; set; }
+        public string FileId { get; set; }
+        public string Filename { get; set; }
+        public int StartIndex { get; set; }
+        protected override ResponseMessageAnnotation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
+        protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
+        protected override ResponseMessageAnnotation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
+        protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
+    }
     public class CustomMcpToolCallApprovalPolicy : IJsonModel<CustomMcpToolCallApprovalPolicy>, IPersistableModel<CustomMcpToolCallApprovalPolicy> {
         [EditorBrowsable(EditorBrowsableState.Never)]
         public ref JsonPatch Patch { get; }

examples/Responses/Example10_CodeInterpreter.cs

@@ -0,0 +1,56 @@
+using NUnit.Framework;
+using OpenAI.Containers;
+using OpenAI.Responses;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+
+namespace OpenAI.Examples;
+
+// This example uses experimental APIs which are subject to change. To use experimental APIs,
+// please acknowledge their experimental status by suppressing the corresponding warning.
+#pragma warning disable OPENAI001
+
+public partial class ResponseExamples
+{
+    [Test]
+    public void Example10_CodeInterpreter()
+    {
+        OpenAIResponseClient client = new(model: "gpt-5", apiKey: Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
+
+        CodeInterpreterToolContainer container = new(CodeInterpreterToolContainerConfiguration.CreateAutomaticContainerConfiguration());
+        CodeInterpreterTool codeInterpreterTool = new(container);
+
+        ResponseCreationOptions options = new()
+        {
+            Tools = { codeInterpreterTool }
+        };
+
+        List<ResponseItem> inputItems =
+        [
+            ResponseItem.CreateUserMessageItem("Create a Excel spreadsheet that contains the mathematical times tables from 1-12."),
+        ];
+
+        OpenAIResponse response = client.CreateResponse(inputItems, options);
+
+        MessageResponseItem message = response.OutputItems
+            .OfType<MessageResponseItem>()
+            .FirstOrDefault();
+
+        ResponseContentPart contentPart = message.Content
+            .Where(part => part.Kind == ResponseContentPartKind.OutputText)
+            .FirstOrDefault();
+
+        ContainerFileCitationMessageAnnotation containerFileCitation = contentPart.OutputTextAnnotations
+            .OfType<ContainerFileCitationMessageAnnotation>()
+            .FirstOrDefault();
+
+        ContainerClient containerClient = new(apiKey: Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
+        BinaryData fileBytes = containerClient.DownloadContainerFile(containerFileCitation.ContainerId, containerFileCitation.FileId);
+        using FileStream stream = File.OpenWrite($"{Guid.NewGuid()}.xlsx");
+        fileBytes.ToStream().CopyTo(stream);
+    }
+}
+
+#pragma warning restore OPENAI001

examples/Responses/Example10_CodeInterpreterAsync.cs

@@ -0,0 +1,57 @@
+using NUnit.Framework;
+using OpenAI.Containers;
+using OpenAI.Responses;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace OpenAI.Examples;
+
+// This example uses experimental APIs which are subject to change. To use experimental APIs,
+// please acknowledge their experimental status by suppressing the corresponding warning.
+#pragma warning disable OPENAI001
+
+public partial class ResponseExamples
+{
+    [Test]
+    public async Task Example10_CodeInterpreterAsync()
+    {
+        OpenAIResponseClient client = new(model: "gpt-5", apiKey: Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
+
+        CodeInterpreterToolContainer container = new(CodeInterpreterToolContainerConfiguration.CreateAutomaticContainerConfiguration());
+        CodeInterpreterTool codeInterpreterTool = new(container);
+
+        ResponseCreationOptions options = new()
+        {
+            Tools = { codeInterpreterTool }
+        };
+
+        List<ResponseItem> inputItems =
+        [
+            ResponseItem.CreateUserMessageItem("Create a Excel spreadsheet that contains the mathematical times tables from 1-12."),
+        ];
+
+        OpenAIResponse response = await client.CreateResponseAsync(inputItems, options);
+
+        MessageResponseItem message = response.OutputItems
+            .OfType<MessageResponseItem>()
+            .FirstOrDefault();
+
+        ResponseContentPart contentPart = message.Content
+            .Where(part => part.Kind == ResponseContentPartKind.OutputText)
+            .FirstOrDefault();
+
+        ContainerFileCitationMessageAnnotation containerFileCitation = contentPart.OutputTextAnnotations
+            .OfType<ContainerFileCitationMessageAnnotation>()
+            .FirstOrDefault();
+
+        ContainerClient containerClient = new(apiKey: Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
+        BinaryData fileBytes = await containerClient.DownloadContainerFileAsync(containerFileCitation.ContainerId, containerFileCitation.FileId);
+        using FileStream stream = File.OpenWrite($"{Guid.NewGuid()}.xlsx");
+        fileBytes.ToStream().CopyTo(stream);
+    }
+}
+
+#pragma warning restore OPENAI001

specification/base/typespec/responses/models.tsp

@@ -1089,11 +1089,11 @@ model AnnotationUrlCitation extends Annotation {
 }
 
 /** A citation for a container file used to generate a model response. */
-model ContainerFileCitationBody {
+model ContainerFileCitationBody extends Annotation {
   @doc("""
     The type of the container file citation. Always `container_file_citation`.
     """)
-  type: "container_file_citation" = "container_file_citation";
+  type: AnnotationType.container_file_citation;
 
   /** The ID of the container file. */
   container_id: string;
@@ -1106,6 +1106,9 @@ model ContainerFileCitationBody {
 
   /** The index of the last character of the container file citation in the message. */
   end_index: int32;
+
+  /** The filename of the container file cited. */
+  filename: string;
 }
 
 // Tool customization (apply_discriminator): Apply discriminated base type, rename for consistency and clarity

src/Custom/Responses/Annotations/ContainerFileCitationMessageAnnotation.cs

@@ -0,0 +1,7 @@
+namespace OpenAI.Responses;
+
+// CUSTOM: Renamed.
+[CodeGenType("ContainerFileCitationBody")]
+public partial class ContainerFileCitationMessageAnnotation
+{
+}

src/Custom/Responses/Annotations/FileCitationMessageAnnotation.cs

@@ -1,7 +1,6 @@
 namespace OpenAI.Responses;
 
-// CUSTOM:
-// - Renamed.
+// CUSTOM: Renamed.
 [CodeGenType("AnnotationFileCitation")]
 public partial class FileCitationMessageAnnotation
 {

src/Custom/Responses/Annotations/FilePathMessageAnnotation.cs

@@ -1,7 +1,6 @@
 namespace OpenAI.Responses;
 
-// CUSTOM:
-// - Renamed.
+// CUSTOM: Renamed.
 [CodeGenType("AnnotationFilePath")]
 public partial class FilePathMessageAnnotation
 {

src/Custom/Responses/Annotations/ResponseMessageAnnotationKind.cs

@@ -9,12 +9,15 @@ namespace OpenAI.Responses;
 [CodeGenType("AnnotationType")]
 public enum ResponseMessageAnnotationKind
 {
+    [CodeGenMember("FileCitation")]
     FileCitation,
 
     [CodeGenMember("UrlCitation")]
     UriCitation,
 
+    [CodeGenMember("FilePath")]
     FilePath,
 
+    [CodeGenMember("ContainerFileCitation")]
     ContainerFileCitation
 }

src/Custom/Responses/Annotations/UriCitationMessageAnnotation.cs

@@ -2,11 +2,11 @@
 
 namespace OpenAI.Responses;
 
-// CUSTOM:
-// - Renamed.
+// CUSTOM: Renamed.
 [CodeGenType("AnnotationUrlCitation")]
 public partial class UriCitationMessageAnnotation
 {
+    // CUSTOM: Renamed.
     [CodeGenMember("Url")]
     public Uri Uri { get; set; }
 }