[FEATURE REQ] support `filename` in annotations in `ResponseMessageAnnotation` for `file_citation` and `container_file_citation`

[gaspardpetit]

Describe the feature or improvement you are requesting

Both container_file_citation,file_citation declare a filename attribute, but it is currently (2.2.0) not being deserialized and ends up in the additionalBinaryDataProperties. Would it be possible to add this field to InternalAnnotationFileCitation (and the upcoming InternalAnnotationContainerFileCitation)?

Additional context

No response

[jsquire]

@joseharriaga: Would appreciate thoughts on this one. The filename attribute exists in the docs, unsure if was missing from the REST API spec or we overlooked it.

[jsquire]

@gaspardpetit : As of version 2.6.0, ContainerFileCitationMessageAnnotation is now available as a derived type of ResponseMessageAnnotation. You can see the API listing here:
🔗 https://github.com/openai/openai-dotnet/blob/OpenAI_2.6.0/api/OpenAI.net8.0.cs#L5043

Examples of how to use it, including how to download the file using the ContainerClient:

• https://github.com/openai/openai-dotnet/blob/OpenAI_2.6.0/examples/Responses/Example10_CodeInterpreter.cs
• https://github.com/openai/openai-dotnet/blob/OpenAI_2.6.0/examples/Responses/Example10_CodeInterpreterAsync.cs

There is also a new FileCitationMessageAnnotation available, but this does not contain filename, though it appears in the docs, it does not yet exist in the spec. Once the updated spec is fully ingested, I expect it will be added here. We'll leave this open to track in the meantime.

[gaspardpetit]

Thank you ! I confirm the new code is working. The two outstanding issues I have with annotations are the folloing:

• missing filename field support (this is major)
• StreamingResponseTextAnnotationAddedUpdate.Serialization.cs treats annotation as a BinaryData instead of a ResponseMessageAnnotation:

i.e. this:

                if (prop.NameEquals("annotation"u8))
                {
                    annotation = BinaryData.FromString(prop.Value.GetRawText());
                    continue;
                }

should be this:

                if (prop.NameEquals("annotation"u8))
                {
                    annotation = ResponseMessageAnnotation.DeserializeResponseMessageAnnotation(prop.Value, data, options);
                    continue;
                }

[jsquire]

@gaspardpetit: The filename has been added via #816. The annotation is more involved and needs to wait for the updated REST API spec to be fully ingested, as the form that takes will be impacted by how it is modeled in the TypeSpec. If we guess wrong, there's enough overhead and rework needed that I don't believe the risk is worth.