Add FileName in FileCitationMessageAnnotation (#816)

ShivangiReja · web-flow · commit ba45b1f4a01b · 2025-11-06T16:12:58.000-08:00
diff --git a/api/OpenAI.net8.0.cs b/api/OpenAI.net8.0.cs
@@ -5066,8 +5066,9 @@ public class CustomMcpToolCallApprovalPolicy : IJsonModel<CustomMcpToolCallAppro
     }
     [Experimental("OPENAI001")]
     public class FileCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<FileCitationMessageAnnotation>, IPersistableModel<FileCitationMessageAnnotation> {
-        public FileCitationMessageAnnotation(string fileId, int index);
+        public FileCitationMessageAnnotation(string fileId, int index, string filename);
         public string FileId { get; set; }
+        public string Filename { get; set; }
         public int Index { get; set; }
         protected override ResponseMessageAnnotation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
         protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
diff --git a/api/OpenAI.netstandard2.0.cs b/api/OpenAI.netstandard2.0.cs
@@ -4425,8 +4425,9 @@ public class CustomMcpToolCallApprovalPolicy : IJsonModel<CustomMcpToolCallAppro
         protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
     }
     public class FileCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<FileCitationMessageAnnotation>, IPersistableModel<FileCitationMessageAnnotation> {
-        public FileCitationMessageAnnotation(string fileId, int index);
+        public FileCitationMessageAnnotation(string fileId, int index, string filename);
         public string FileId { get; set; }
+        public string Filename { get; set; }
         public int Index { get; set; }
         protected override ResponseMessageAnnotation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
         protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
diff --git a/specification/base/typespec/responses/models.tsp b/specification/base/typespec/responses/models.tsp
@@ -1064,6 +1064,9 @@ model AnnotationFileCitation extends Annotation {
 
   /** The index of the file in the list of files. */
   index: int32;
+
+  /** The filename of the file cited. */
+  filename: string;
 }
 
 // Tool customization (apply_discriminator): Apply discriminated base type, rename for consistency and clarity
diff --git a/src/Generated/Models/Responses/FileCitationMessageAnnotation.Serialization.cs b/src/Generated/Models/Responses/FileCitationMessageAnnotation.Serialization.cs
@@ -12,7 +12,7 @@ namespace OpenAI.Responses
 {
     public partial class FileCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<FileCitationMessageAnnotation>
     {
-        internal FileCitationMessageAnnotation() : this(ResponseMessageAnnotationKind.FileCitation, default, null, default)
+        internal FileCitationMessageAnnotation() : this(ResponseMessageAnnotationKind.FileCitation, default, null, default, null)
         {
         }
 
@@ -50,6 +50,11 @@ protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWri
                 writer.WritePropertyName("index"u8);
                 writer.WriteNumberValue(Index);
             }
+            if (!Patch.Contains("$.filename"u8))
+            {
+                writer.WritePropertyName("filename"u8);
+                writer.WriteStringValue(Filename);
+            }
 
             Patch.WriteTo(writer);
 #pragma warning restore SCME0001 // Type is for evaluation purposes only and is subject to change or removal in future updates.
@@ -80,6 +85,7 @@ internal static FileCitationMessageAnnotation DeserializeFileCitationMessageAnno
 #pragma warning restore SCME0001 // Type is for evaluation purposes only and is subject to change or removal in future updates.
             string fileId = default;
             int index = default;
+            string filename = default;
             foreach (var prop in element.EnumerateObject())
             {
                 if (prop.NameEquals("type"u8))
@@ -97,9 +103,14 @@ internal static FileCitationMessageAnnotation DeserializeFileCitationMessageAnno
                     index = prop.Value.GetInt32();
                     continue;
                 }
+                if (prop.NameEquals("filename"u8))
+                {
+                    filename = prop.Value.GetString();
+                    continue;
+                }
                 patch.Set([.. "$."u8, .. Encoding.UTF8.GetBytes(prop.Name)], prop.Value.GetUtf8Bytes());
             }
-            return new FileCitationMessageAnnotation(kind, patch, fileId, index);
+            return new FileCitationMessageAnnotation(kind, patch, fileId, index, filename);
         }
 
         BinaryData IPersistableModel<FileCitationMessageAnnotation>.Write(ModelReaderWriterOptions options) => PersistableModelWriteCore(options);
diff --git a/src/Generated/Models/Responses/FileCitationMessageAnnotation.cs b/src/Generated/Models/Responses/FileCitationMessageAnnotation.cs
@@ -11,24 +11,29 @@ namespace OpenAI.Responses
     [Experimental("OPENAI001")]
     public partial class FileCitationMessageAnnotation : ResponseMessageAnnotation
     {
-        public FileCitationMessageAnnotation(string fileId, int index) : base(ResponseMessageAnnotationKind.FileCitation)
+        public FileCitationMessageAnnotation(string fileId, int index, string filename) : base(ResponseMessageAnnotationKind.FileCitation)
         {
             Argument.AssertNotNull(fileId, nameof(fileId));
+            Argument.AssertNotNull(filename, nameof(filename));
 
             FileId = fileId;
             Index = index;
+            Filename = filename;
         }
 
 #pragma warning disable SCME0001 // Type is for evaluation purposes only and is subject to change or removal in future updates.
-        internal FileCitationMessageAnnotation(ResponseMessageAnnotationKind kind, in JsonPatch patch, string fileId, int index) : base(kind, patch)
+        internal FileCitationMessageAnnotation(ResponseMessageAnnotationKind kind, in JsonPatch patch, string fileId, int index, string filename) : base(kind, patch)
         {
             FileId = fileId;
             Index = index;
+            Filename = filename;
         }
 #pragma warning restore SCME0001 // Type is for evaluation purposes only and is subject to change or removal in future updates.
 
         public string FileId { get; set; }
 
         public int Index { get; set; }
+
+        public string Filename { get; set; }
     }
 }
diff --git a/src/Generated/OpenAIModelFactory.cs b/src/Generated/OpenAIModelFactory.cs
@@ -584,9 +584,9 @@ public static ResponseMessageAnnotation ResponseMessageAnnotation(string kind =
             return new InternalUnknownAnnotation(kind.ToResponseMessageAnnotationKind(), default);
         }
 
-        public static FileCitationMessageAnnotation FileCitationMessageAnnotation(string fileId = default, int index = default)
+        public static FileCitationMessageAnnotation FileCitationMessageAnnotation(string fileId = default, int index = default, string filename = default)
         {
-            return new FileCitationMessageAnnotation(ResponseMessageAnnotationKind.FileCitation, default, fileId, index);
+            return new FileCitationMessageAnnotation(ResponseMessageAnnotationKind.FileCitation, default, fileId, index, filename);
         }
 
         public static UriCitationMessageAnnotation UriCitationMessageAnnotation(Uri uri = default, int startIndex = default, int endIndex = default, string title = default)
diff --git a/tests/Responses/ResponsesToolTests.cs b/tests/Responses/ResponsesToolTests.cs
@@ -394,6 +394,7 @@ public async Task FileSearch()
         Assert.That(messageContentPart.OutputTextAnnotations, Is.Not.Null.And.Not.Empty);
         FileCitationMessageAnnotation annotation = messageContentPart.OutputTextAnnotations[0] as FileCitationMessageAnnotation;
         Assert.That(annotation.FileId, Is.EqualTo(testFile.Id));
+        Assert.That(annotation.Filename, Is.EqualTo(testFile.Filename));
         Assert.That(annotation.Index, Is.GreaterThan(0));
 
         await foreach (ResponseItem inputItem in client.GetResponseInputItemsAsync(response.Id))
diff --git a/tests/SessionRecords/ResponsesToolTests/FileSearch.json b/tests/SessionRecords/ResponsesToolTests/FileSearch.json
diff --git a/tests/SessionRecords/ResponsesToolTests/FileSearchAsync.json b/tests/SessionRecords/ResponsesToolTests/FileSearchAsync.json
diff --git a/tspCodeModel.json b/tspCodeModel.json

Original file line number	Diff line number	Diff line change
`@@ -1064,6 +1064,9 @@ model AnnotationFileCitation extends Annotation {`
`1064`	`1064`
`1065`	`1065`	`/** The index of the file in the list of files. */`
`1066`	`1066`	`index: int32;`
	`1067`	`+`
	`1068`	`+ /** The filename of the file cited. */`
	`1069`	`+ filename: string;`
`1067`	`1070`	`}`
`1068`	`1071`
`1069`	`1072`	`// Tool customization (apply_discriminator): Apply discriminated base type, rename for consistency and clarity`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ namespace OpenAI.Responses`
`12`	`12`	`{`
`13`	`13`	`public partial class FileCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<FileCitationMessageAnnotation>`
`14`	`14`	`{`
`15`		`- internal FileCitationMessageAnnotation() : this(ResponseMessageAnnotationKind.FileCitation, default, null, default)`
	`15`	`+ internal FileCitationMessageAnnotation() : this(ResponseMessageAnnotationKind.FileCitation, default, null, default, null)`
`16`	`16`	`{`
`17`	`17`	`}`
`18`	`18`
`@@ -50,6 +50,11 @@ protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWri`
`50`	`50`	`writer.WritePropertyName("index"u8);`
`51`	`51`	`writer.WriteNumberValue(Index);`
`52`	`52`	`}`
	`53`	`+ if (!Patch.Contains("$.filename"u8))`
	`54`	`+ {`
	`55`	`+ writer.WritePropertyName("filename"u8);`
	`56`	`+ writer.WriteStringValue(Filename);`
	`57`	`+ }`
`53`	`58`
`54`	`59`	`Patch.WriteTo(writer);`
`55`	`60`	`#pragma warning restore SCME0001 // Type is for evaluation purposes only and is subject to change or removal in future updates.`
`@@ -80,6 +85,7 @@ internal static FileCitationMessageAnnotation DeserializeFileCitationMessageAnno`
`80`	`85`	`#pragma warning restore SCME0001 // Type is for evaluation purposes only and is subject to change or removal in future updates.`
`81`	`86`	`string fileId = default;`
`82`	`87`	`int index = default;`
	`88`	`+ string filename = default;`
`83`	`89`	`foreach (var prop in element.EnumerateObject())`
`84`	`90`	`{`
`85`	`91`	`if (prop.NameEquals("type"u8))`
`@@ -97,9 +103,14 @@ internal static FileCitationMessageAnnotation DeserializeFileCitationMessageAnno`
`97`	`103`	`index = prop.Value.GetInt32();`
`98`	`104`	`continue;`
`99`	`105`	`}`
	`106`	`+ if (prop.NameEquals("filename"u8))`
	`107`	`+ {`
	`108`	`+ filename = prop.Value.GetString();`
	`109`	`+ continue;`
	`110`	`+ }`
`100`	`111`	`patch.Set([.. "$."u8, .. Encoding.UTF8.GetBytes(prop.Name)], prop.Value.GetUtf8Bytes());`
`101`	`112`	`}`
`102`		`- return new FileCitationMessageAnnotation(kind, patch, fileId, index);`
	`113`	`+ return new FileCitationMessageAnnotation(kind, patch, fileId, index, filename);`
`103`	`114`	`}`
`104`	`115`
`105`	`116`	`BinaryData IPersistableModel<FileCitationMessageAnnotation>.Write(ModelReaderWriterOptions options) => PersistableModelWriteCore(options);`
Original file line number	Diff line number	Diff line change
`@@ -11,24 +11,29 @@ namespace OpenAI.Responses`
`11`	`11`	`[Experimental("OPENAI001")]`
`12`	`12`	`public partial class FileCitationMessageAnnotation : ResponseMessageAnnotation`
`13`	`13`	`{`
`14`		`- public FileCitationMessageAnnotation(string fileId, int index) : base(ResponseMessageAnnotationKind.FileCitation)`
	`14`	`+ public FileCitationMessageAnnotation(string fileId, int index, string filename) : base(ResponseMessageAnnotationKind.FileCitation)`
`15`	`15`	`{`
`16`	`16`	`Argument.AssertNotNull(fileId, nameof(fileId));`
	`17`	`+ Argument.AssertNotNull(filename, nameof(filename));`
`17`	`18`
`18`	`19`	`FileId = fileId;`
`19`	`20`	`Index = index;`
	`21`	`+ Filename = filename;`
`20`	`22`	`}`
`21`	`23`
`22`	`24`	`#pragma warning disable SCME0001 // Type is for evaluation purposes only and is subject to change or removal in future updates.`
`23`		`- internal FileCitationMessageAnnotation(ResponseMessageAnnotationKind kind, in JsonPatch patch, string fileId, int index) : base(kind, patch)`
	`25`	`+ internal FileCitationMessageAnnotation(ResponseMessageAnnotationKind kind, in JsonPatch patch, string fileId, int index, string filename) : base(kind, patch)`
`24`	`26`	`{`
`25`	`27`	`FileId = fileId;`
`26`	`28`	`Index = index;`
	`29`	`+ Filename = filename;`
`27`	`30`	`}`
`28`	`31`	`#pragma warning restore SCME0001 // Type is for evaluation purposes only and is subject to change or removal in future updates.`
`29`	`32`
`30`	`33`	`public string FileId { get; set; }`
`31`	`34`
`32`	`35`	`public int Index { get; set; }`
	`36`	`+`
	`37`	`+ public string Filename { get; set; }`
`33`	`38`	`}`
`34`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -584,9 +584,9 @@ public static ResponseMessageAnnotation ResponseMessageAnnotation(string kind =`
`584`	`584`	`return new InternalUnknownAnnotation(kind.ToResponseMessageAnnotationKind(), default);`
`585`	`585`	`}`
`586`	`586`
`587`		`- public static FileCitationMessageAnnotation FileCitationMessageAnnotation(string fileId = default, int index = default)`
	`587`	`+ public static FileCitationMessageAnnotation FileCitationMessageAnnotation(string fileId = default, int index = default, string filename = default)`
`588`	`588`	`{`
`589`		`- return new FileCitationMessageAnnotation(ResponseMessageAnnotationKind.FileCitation, default, fileId, index);`
	`589`	`+ return new FileCitationMessageAnnotation(ResponseMessageAnnotationKind.FileCitation, default, fileId, index, filename);`
`590`	`590`	`}`
`591`	`591`
`592`	`592`	`public static UriCitationMessageAnnotation UriCitationMessageAnnotation(Uri uri = default, int startIndex = default, int endIndex = default, string title = default)`