-
Notifications
You must be signed in to change notification settings - Fork 56
Replay citation annotations on the Responses input path #1101
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
PratikDhanave (PratikDhanave)
wants to merge
1
commit into
microsoft:main
Choose a base branch
from
PratikDhanaveFork:fix/openai-responses-replay-annotations
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+139
−2
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comparing this to the Python parity implementation
_annotations_to_output_text(python/packages/openai/agent_framework_openai/_chat_client.py:460-529), thefile_citationandfile_pathResponses branches there restore the originalindexvalue fromadditional_properties["index"](populated on ingestion at_chat_client.py:3047-3062, and again in the streaming path at_chat_client.py:3744-3770, both storing"index": annotation.index).ResponseOutputTextAnnotationFileCitationParam.IndexandResponseOutputTextAnnotationFilePathParam.Indexareapi:"required"fields on the OpenAI Go SDK (github.com/openai/openai-go/v3@v3.61.0responses/response.go:21196-21208and:21279-21289).annotationsToOutputText'scit.FileID != "" && cit.Title != ""andcit.FileID != ""branches never setIndex, so it always serializes as0.This is tightly coupled to this PR: before this change annotations were always empty, so no incorrect index was ever sent; now that file_citation/file_path annotations are replayed, any assistant turn with more than one file citation (or a non-zero original index) will silently emit the wrong
indexon replay, diverging from the round-trip fidelity Python achieves viaadditional_properties["index"].Root cause is that Go's
message.CitationAnnotation(message/annotation.go:80-90) has no field to carry this "index" value frompopulateAnnotations(which also drops it today), so it cannot be reconstructed here. Suggest adding an index carrier (e.g. viaAdditionalProperties["Index"], consistent with howContainerIdis already threaded throughAdditionalProperties) in bothpopulateAnnotationsandannotationsToOutputTextso this new replay path doesn't regress round-trip fidelity for multi-citation messages.