Add extra_body to ModelSettings (#1538)

Author: Kludex

pydantic_ai_slim/pydantic_ai/models/anthropic.py

@@ -239,6 +239,7 @@ async def _messages_create(
                 timeout=model_settings.get('timeout', NOT_GIVEN),
                 metadata=model_settings.get('anthropic_metadata', NOT_GIVEN),
                 extra_headers={'User-Agent': get_user_agent()},
+                extra_body=model_settings.get('extra_body'),
             )
         except APIStatusError as e:
             if (status_code := e.status_code) >= 400:

pydantic_ai_slim/pydantic_ai/models/groq.py

@@ -218,6 +218,7 @@ async def _completions_create(
                 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()},
+                extra_body=model_settings.get('extra_body'),
             )
         except APIStatusError as e:
             if (status_code := e.status_code) >= 400:

pydantic_ai_slim/pydantic_ai/models/openai.py

@@ -284,6 +284,7 @@ async def _completions_create(
                 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()},
+                extra_body=model_settings.get('extra_body'),
             )
         except APIStatusError as e:
             if (status_code := e.status_code) >= 400:
@@ -623,6 +624,7 @@ async def _responses_create(
                 reasoning=reasoning,
                 user=model_settings.get('openai_user', NOT_GIVEN),
                 extra_headers={'User-Agent': get_user_agent()},
+                extra_body=model_settings.get('extra_body'),
             )
         except APIStatusError as e:
             if (status_code := e.status_code) >= 400:

pydantic_ai_slim/pydantic_ai/settings.py

@@ -141,6 +141,16 @@ class ModelSettings(TypedDict, total=False):
     * Cohere
     """
 
+    extra_body: object
+    """Extra body to send to the model.
+
+    Supported by:
+
+    * OpenAI
+    * Anthropic
+    * Groq
+    """
+
 
 def merge_model_settings(base: ModelSettings | None, overrides: ModelSettings | None) -> ModelSettings | None:
     """Merge two sets of model settings, preferring the overrides.

tests/models/test_openai.py

@@ -176,6 +176,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\/.*')},
+            'extra_body': None,
         },
         {
             'messages': [
@@ -186,6 +187,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\/.*')},
+            'extra_body': None,
         },
     ]
 
@@ -559,6 +561,7 @@ async def test_system_prompt_role(
             'model': 'gpt-4o',
             'n': 1,
             'extra_headers': {'User-Agent': IsStr(regex=r'pydantic-ai\/.*')},
+            'extra_body': None,
         }
     ]
 
@@ -635,6 +638,7 @@ async def test_image_url_input(allow_model_requests: None):
                 ],
                 'n': 1,
                 'extra_headers': {'User-Agent': IsStr(regex=r'pydantic-ai\/.*')},
+                'extra_body': None,
             }
         ]
     )