Add PydanticAI User-Agent header (#1425)

Author: Kludex

pydantic_ai_slim/pydantic_ai/models/anthropic.py

@@ -31,7 +31,14 @@
 from ..providers import Provider, infer_provider
 from ..settings import ModelSettings
 from ..tools import ToolDefinition
-from . import Model, ModelRequestParameters, StreamedResponse, cached_async_http_client, check_allow_model_requests
+from . import (
+    Model,
+    ModelRequestParameters,
+    StreamedResponse,
+    cached_async_http_client,
+    check_allow_model_requests,
+    get_user_agent,
+)
 
 try:
     from anthropic import NOT_GIVEN, APIStatusError, AsyncAnthropic, AsyncStream
@@ -231,6 +238,7 @@ async def _messages_create(
                 top_p=model_settings.get('top_p', NOT_GIVEN),
                 timeout=model_settings.get('timeout', NOT_GIVEN),
                 metadata=model_settings.get('anthropic_metadata', NOT_GIVEN),
+                extra_headers={'User-Agent': get_user_agent()},
             )
         except APIStatusError as e:
             if (status_code := e.status_code) >= 400:

pydantic_ai_slim/pydantic_ai/models/groq.py

@@ -31,7 +31,7 @@
 from ..providers import Provider, infer_provider
 from ..settings import ModelSettings
 from ..tools import ToolDefinition
-from . import Model, ModelRequestParameters, StreamedResponse, check_allow_model_requests
+from . import Model, ModelRequestParameters, StreamedResponse, check_allow_model_requests, get_user_agent
 
 try:
     from groq import NOT_GIVEN, APIStatusError, AsyncGroq, AsyncStream
@@ -218,6 +218,7 @@ async def _completions_create(
                 presence_penalty=model_settings.get('presence_penalty', NOT_GIVEN),
                 frequency_penalty=model_settings.get('frequency_penalty', NOT_GIVEN),
                 logit_bias=model_settings.get('logit_bias', NOT_GIVEN),
+                extra_headers={'User-Agent': get_user_agent()},
             )
         except APIStatusError as e:
             if (status_code := e.status_code) >= 400:

pydantic_ai_slim/pydantic_ai/models/mistral.py

@@ -39,6 +39,7 @@
     ModelRequestParameters,
     StreamedResponse,
     check_allow_model_requests,
+    get_user_agent,
 )
 
 try:
@@ -200,6 +201,7 @@ async def _completions_create(
                 timeout_ms=self._get_timeout_ms(model_settings.get('timeout')),
                 random_seed=model_settings.get('seed', UNSET),
                 stop=model_settings.get('stop_sequences', None),
+                http_headers={'User-Agent': get_user_agent()},
             )
         except SDKError as e:
             if (status_code := e.status_code) >= 400:
@@ -238,6 +240,7 @@ async def _stream_completions_create(
                 presence_penalty=model_settings.get('presence_penalty'),
                 frequency_penalty=model_settings.get('frequency_penalty'),
                 stop=model_settings.get('stop_sequences', None),
+                http_headers={'User-Agent': get_user_agent()},
             )
 
         elif model_request_parameters.result_tools:
@@ -251,6 +254,7 @@ async def _stream_completions_create(
                 messages=mistral_messages,
                 response_format={'type': 'json_object'},
                 stream=True,
+                http_headers={'User-Agent': get_user_agent()},
             )
 
         else:
@@ -259,6 +263,7 @@ async def _stream_completions_create(
                 model=str(self._model_name),
                 messages=mistral_messages,
                 stream=True,
+                http_headers={'User-Agent': get_user_agent()},
             )
         assert response, 'A unexpected empty response from Mistral.'
         return response

pydantic_ai_slim/pydantic_ai/models/openai.py

@@ -39,6 +39,7 @@
     StreamedResponse,
     cached_async_http_client,
     check_allow_model_requests,
+    get_user_agent,
 )
 
 try:
@@ -282,6 +283,7 @@ async def _completions_create(
                 logit_bias=model_settings.get('logit_bias', NOT_GIVEN),
                 reasoning_effort=model_settings.get('openai_reasoning_effort', NOT_GIVEN),
                 user=model_settings.get('openai_user', NOT_GIVEN),
+                extra_headers={'User-Agent': get_user_agent()},
             )
         except APIStatusError as e:
             if (status_code := e.status_code) >= 400:
@@ -613,6 +615,7 @@ async def _responses_create(
                 timeout=model_settings.get('timeout', NOT_GIVEN),
                 reasoning=reasoning,
                 user=model_settings.get('openai_user', NOT_GIVEN),
+                extra_headers={'User-Agent': get_user_agent()},
             )
         except APIStatusError as e:
             if (status_code := e.status_code) >= 400:

tests/models/test_openai.py

@@ -170,7 +170,12 @@ async def test_request_simple_success(allow_model_requests: None):
         ]
     )
     assert get_mock_chat_completion_kwargs(mock_client) == [
-        {'messages': [{'content': 'hello', 'role': 'user'}], 'model': 'gpt-4o', 'n': 1},
+        {
+            'messages': [{'content': 'hello', 'role': 'user'}],
+            'model': 'gpt-4o',
+            'n': 1,
+            'extra_headers': {'User-Agent': IsStr(regex=r'pydantic-ai\/.*')},
+        },
         {
             'messages': [
                 {'content': 'hello', 'role': 'user'},
@@ -179,6 +184,7 @@ async def test_request_simple_success(allow_model_requests: None):
             ],
             'model': 'gpt-4o',
             'n': 1,
+            'extra_headers': {'User-Agent': IsStr(regex=r'pydantic-ai\/.*')},
         },
     ]
 
@@ -551,6 +557,7 @@ async def test_system_prompt_role(
             ],
             'model': 'gpt-4o',
             'n': 1,
+            'extra_headers': {'User-Agent': IsStr(regex=r'pydantic-ai\/.*')},
         }
     ]
 
@@ -626,6 +633,7 @@ async def test_image_url_input(allow_model_requests: None):
                     }
                 ],
                 'n': 1,
+                'extra_headers': {'User-Agent': IsStr(regex=r'pydantic-ai\/.*')},
             }
         ]
     )