Adding metadata

Author: adtyavrdhn

pydantic_ai_slim/pydantic_ai/messages.py

@@ -951,6 +951,9 @@ class ModelRequest:
     run_id: str | None = None
     """The unique identifier of the agent run in which this message originated."""
 
+    metadata: dict[str, Any] | None = None
+    """Additional data tagged on the message but is not sent to the model"""
+
     @classmethod
     def user_text_prompt(cls, user_prompt: str, *, instructions: str | None = None) -> ModelRequest:
         """Create a `ModelRequest` with a single user prompt as text."""
@@ -1195,6 +1198,9 @@ class ModelResponse:
     run_id: str | None = None
     """The unique identifier of the agent run in which this message originated."""
 
+    metadata: dict[str, Any] | None = None
+    """Additional data tagged on the message but is not sent to the model"""
+
     @property
     def text(self) -> str | None:
         """Get the text in the response."""

tests/test_messages.py

@@ -463,6 +463,7 @@ def test_file_part_serialization_roundtrip():
                 'provider_response_id': None,
                 'finish_reason': None,
                 'run_id': None,
+                'metadata': None,
             }
         ]
     )
@@ -475,11 +476,9 @@ def test_model_messages_type_adapter_preserves_run_id():
         ModelRequest(
             parts=[UserPromptPart(content='Hi there', timestamp=datetime.now(tz=timezone.utc))],
             run_id='run-123',
+            metadata={'key': 'value'},
         ),
-        ModelResponse(
-            parts=[TextPart(content='Hello!')],
-            run_id='run-123',
-        ),
+        ModelResponse(parts=[TextPart(content='Hello!')], run_id='run-123', metadata={'key': 'value'}),
     ]
 
     serialized = ModelMessagesTypeAdapter.dump_python(messages, mode='python')