Skip to content

Python: fix citation issue - #9436

Queued
sophia-ramsey wants to merge 7 commits into
mainfrom
sramsey/python-citation
Queued

sophia-ramsey wants to merge 7 commits into
mainfrom
sramsey/python-citation

Conversation

@sophia-ramsey

Copy link
Copy Markdown
Member

Motivation & Context

An internal bug reported that citations were not correctly being propagated with hosted agents. The citation would include the correct filename or source, but would not link to the annotation properly, instead registering as plain text.

Description & Review Guide

  • What are the major changes? Updated ResponsesHostServer to serialize URL and file citation annotations into Responses payloads for both streaming and non-streaming responses, with regression coverage for supported annotation types and edge cases.
  • What is the impact of these changes? Hosted agents now preserve citation metadata through the Python hosting boundary, allowing Teams and Copilot to render clickable citations instead of displaying unsupported raw citation markers.
  • What do you want reviewers to focus on? Edge cases or potential issues with any other wrappers or downstream agent services.

Related Issue

Fixes #9434

AI Assistance

  • No material AI assistance was used.
  • This is an AI-assisted contribution. I reviewed, understood, and verified all submitted content and accept responsibility for it.

AI assistance details: Used GPT-5.6 Sol for planning, implementation, and testing

Contribution Checklist

  • The code builds clean without any errors or warnings
  • All unit tests pass, and I have added new tests where possible
  • The PR follows the Contribution Guidelines
  • This PR links to an agreed issue with no competing open PR, or the Related Issue section documents a trivial-change or repository-automation exception.
  • This is not a breaking change. If it is a breaking change, add the breaking change label (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Citation offsets can be shifted incorrectly, and ordinary streaming introduces quadratic text copying.

2 open findings
What changed in this PR

Preserves citation metadata across the Python hosting boundary so downstream clients can render clickable citations, addressing #9434.

Changes:

  • Converts framework citations into Responses annotations.
  • Includes annotations in streaming and non-streaming output.
  • Adds conversion and response regression tests.
File Description
python/​packages/​foundry_hosting/​tests/​test_responses.py Tests citation conversion, edge cases, and response consistency.
python/​packages/​foundry_hosting/​agent_framework_foundry_hosting/​_responses.py Converts and propagates citation annotations.

🧠 Review effort: Balanced


💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Comment thread python/packages/foundry_hosting/agent_framework_foundry_hosting/_responses.py Outdated
Comment thread python/packages/foundry_hosting/agent_framework_foundry_hosting/_responses.py Outdated
@github-code-quality

github-code-quality Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Code coverage overview

Languages: Python

Python / code-coverage/python

main 1168c00 sramsey/python-citat... 01261ad +/-
92% 92% 0%
View coverage of the 6 most impacted files.
File main 1168c00 sramsey/python-citat... 01261ad +/-
packages/openai..._chat_client.py 94% 94% 0%
packages/core/a...ework/_types.py 96% 96% 0%
packages/ag-ui/.../_run_common.py 95% 95% 0%
packages/anthro..._chat_client.py 96% 96% 0%
packages/foundr...g/_responses.py 88% 89% +1%
packages/foundr...ow_responses.py 81% 82% +1%

ℹ️ Calculations represent line coverage. Results may change as calculations are updated.


Updated October 27, 2026 02:50 UTC

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MAF Automated Review — Iteration 1

Result: Findings reported
Scope: full PR (1 commit(s)): 0da89b5958e8
Model: gpt-5.6-sol

Overview

The review found 3 verified inline finding(s).

Reviewed the supplied pull-request change set across correctness, security/reliability, architecture, and failure behavior.
3 verified findings remained after source verification (3 medium) across 1 file. Details are attached to the affected lines below.

Affected areas: python/packages/foundry_hosting/agent_framework_foundry_hosting/_responses.py

Comment thread python/packages/foundry_hosting/agent_framework_foundry_hosting/_responses.py Outdated
Comment thread python/packages/foundry_hosting/agent_framework_foundry_hosting/_responses.py Outdated
Comment thread python/packages/anthropic/agent_framework_anthropic/_chat_client.py

@jpalvarezl Jose Alvarez (jpalvarezl) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approve with a small nit

Comment thread python/packages/foundry_hosting/agent_framework_foundry_hosting/_responses.py Outdated
@agent-framework-automation agent-framework-automation Bot added the documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs label Oct 23, 2026
@sophia-ramsey
sophia-ramsey force-pushed the sramsey/python-citation branch from ea1a03c to 63f108a Compare October 24, 2026 00:02

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sophia-ramsey Please take a look at the inline workflow citation-offset finding.

@sophia-ramsey
sophia-ramsey added this pull request to the merge queue Oct 27, 2026
Any commits made after this event will not be merged.

This branch was previously deployed

1 inactive deployment
github-app-auth — 01261ad0 Deployed Oct 27, 2026 by sophia-ramsey via add_label #26248
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs python Usage: [Issues, PRs], Target: Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Python: [Bug]: Annotations not propagated correctly

5 participants