ClientCitation deserialization fails when Copilot Studio citation contains @id: "ClientCitation" object has no field "at_id"
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 70/100
Direzione di ricerca
Il problema si trova nel validatore _SchemaMixin in microsoft_agents.activity.entity._schema_mixin. Esamina la funzione validate_schema_model dove gestisce la proprietà @id. Alla classe ClientCitation in microsoft_agents.activity.entity.ai_entity manca un campo at_id. Verifica se il campo deve essere aggiunto al modello o se il validatore deve saltare l'impostazione di at_id quando il campo non è definito. Esegui gli script di riproduzione dal repository collegato per verificare la correzione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Summary
When using the Microsoft Agents SDK with a signed-in Microsoft user to invoke a Copilot Studio agent, some Copilot Studio responses contain citations with an @id property.
Those responses fail during Activity deserialization with:
entities.citation.0
Value error, "ClientCitation" object has no field "at_id"
The Copilot Studio request itself succeeds and a response is returned. The exception occurs while the Python SDK is deserializing the returned Activity.
The issue can also be reproduced locally without a Microsoft tenant, authentication, Copilot Studio, or any network request.
Environment
Originally observed with:
microsoft-agents-copilotstudio-client==1.5.0
microsoft-agents-activity==1.5.0
pydantic==2.13.4
Python 3.14
I also tested after upgrading to:
microsoft-agents-copilotstudio-client==1.7.0
and the same ClientCitation / at_id exception is still reproduced.
Reproduction repository
A standalone reproduction is available here:
https://github.com/abdurrafay0610/microsoft-agents-activity-sdk-issue-recreation
The repository contains the minimal reproduction, Activity-level reproduction, requirements, and additional diagnostic information.
To reproduce:
git clone https://github.com/abdurrafay0610/microsoft-agents-activity-sdk-issue-recreation.git
cd microsoft-agents-activity-sdk-issue-recreation
pip install -r requirements.txt
python reproduce.py
python reproduce_activity.py
No Microsoft credentials, tenant, or Copilot Studio agent are required for the standalone reproduction.
Input that triggers the failure
The relevant portion of the citation returned by Copilot Studio has this shape:
{
"@type": "Claim",
"@id": "turn16search0",
"position": 1,
"appearance": {
"@type": "DigitalDocument",
"name": "Example citation"
}
}
The important property is:
"@id": "turn16search0"
SDK deserialization path
microsoft-agents-copilotstudio-client receives the Copilot Studio SSE Activity response in:
microsoft_agents.copilotstudio.client.copilot_client.CopilotClient.post_request()
The Activity JSON is then passed to:
Activity.model_validate_json(activity_data)
During Activity validation, the citation is deserialized as:
microsoft_agents.activity.entity.ai_entity.ClientCitation
ClientCitation uses _SchemaMixin.
The relevant validation helper is:
microsoft_agents.activity.entity._schema_mixin.validate_schema_model
When @id is present in the input, the helper attempts:
setattr(model, "at_id", data["@id"])
However, ClientCitation defines:
at_type
position
appearance
and does not define an at_id field.
The assignment therefore results in:
Value error, "ClientCitation" object has no field "at_id"
Documentation / implementation mismatch
The _SchemaMixin validator describes its behavior as handling @type, @context, and @id when those properties are defined in the destination type.
However, for @id, the implementation attempts to assign at_id when the property is present in the input, without first establishing that the destination model defines at_id.
For ClientCitation, the destination model does not define that field.
Expected behavior
A Copilot Studio Activity containing a citation with the returned @id property should be deserialized without the SDK raising an exception.
Actual behavior
Activity deserialization fails with:
entities.citation.0
Value error, "ClientCitation" object has no field "at_id"
This prevents the application from consuming an otherwise successfully returned Copilot Studio response.
Additional details
The full failure path and standalone examples are documented in the reproduction repository:
https://github.com/abdurrafay0610/microsoft-agents-activity-sdk-issue-recreation
One thing I would definitely fix before submitting is the `repro.py` → `reproduce.py` filename mismatch, because otherwise the first thing a Microsoft maintainer sees when following the instructions is an unrelated `No such file` error.
- Lingua principale
- Python
- Stelle
- 211
- Fork
- 90
- Merge medio
- 1g 6h
- PR unite (30g)
- 14
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di microsoft/Agents-for-python
-
microsoft/Agents-for-python#587 · 1 assegnatario ·
-
microsoft/Agents-for-python#572 · 1 assegnatario ·
-
microsoft/Agents-for-python#559 · 1 assegnatario ·
-
microsoft/Agents-for-python#550 · 1 assegnatario ·
-
microsoft/Agents-for-python#537 · 2 commenti · 1 assegnatario ·
Tutte le issue di microsoft/Agents-for-python
Issue simili
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
stephrobert/dsoxlab#238 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
sublimehq/package_control#1780 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
nwg-piotr/nwg-displays#145 ·