Don't ask for OpenAI Responses API to include encrypted reasoning content for models that don't support it (pydantic#2867)

Author: DouweM

pydantic_ai_slim/pydantic_ai/models/openai.py

@@ -980,10 +980,15 @@ async def _responses_create(
             text = text or {}
             text['verbosity'] = verbosity
 
-        unsupported_model_settings = OpenAIModelProfile.from_profile(self.profile).openai_unsupported_model_settings
+        profile = OpenAIModelProfile.from_profile(self.profile)
+        unsupported_model_settings = profile.openai_unsupported_model_settings
         for setting in unsupported_model_settings:
             model_settings.pop(setting, None)
 
+        include: list[responses.ResponseIncludable] | None = None
+        if profile.openai_supports_encrypted_reasoning_content:
+            include = ['reasoning.encrypted_content']
+
         try:
             extra_headers = model_settings.get('extra_headers', {})
             extra_headers.setdefault('User-Agent', get_user_agent())
@@ -1004,7 +1009,7 @@ async def _responses_create(
                 reasoning=reasoning,
                 user=model_settings.get('openai_user', NOT_GIVEN),
                 text=text or NOT_GIVEN,
-                include=['reasoning.encrypted_content'],
+                include=include or NOT_GIVEN,
                 extra_headers=extra_headers,
                 extra_body=model_settings.get('extra_body'),
             )

pydantic_ai_slim/pydantic_ai/profiles/openai.py

@@ -41,6 +41,9 @@ class OpenAIModelProfile(ModelProfile):
     openai_chat_supports_web_search: bool = False
     """Whether the model supports web search in Chat Completions API."""
 
+    openai_supports_encrypted_reasoning_content: bool = False
+    """Whether the model supports including encrypted reasoning content in the response."""
+
     def __post_init__(self):  # pragma: no cover
         if not self.openai_supports_sampling_settings:
             warnings.warn(
@@ -84,6 +87,7 @@ def openai_model_profile(model_name: str) -> ModelProfile:
         openai_unsupported_model_settings=openai_unsupported_model_settings,
         openai_system_prompt_role=openai_system_prompt_role,
         openai_chat_supports_web_search=supports_web_search,
+        openai_supports_encrypted_reasoning_content=is_reasoning_model,
     )
 
 

tests/models/cassettes/test_openai_responses/test_openai_responses_model_simple_response.yaml

@@ -8,7 +8,7 @@ interactions:
       connection:
       - keep-alive
       content-length:
-      - '105'
+      - '102'
       content-type:
       - application/json
       host:
@@ -18,8 +18,8 @@ interactions:
       input:
       - content: What is the capital of France?
         role: user
-      instructions: ''
       model: gpt-4o
+      stream: false
     uri: https://api.openai.com/v1/responses
   response:
     headers:
@@ -28,61 +28,71 @@ interactions:
       connection:
       - keep-alive
       content-length:
-      - '1183'
+      - '1385'
       content-type:
       - application/json
       openai-organization:
       - pydantic-28gund
       openai-processing-ms:
-      - '323'
+      - '1304'
+      openai-project:
+      - proj_dKobscVY9YJxeEaDJen54e3d
       openai-version:
       - '2020-10-01'
       strict-transport-security:
       - max-age=31536000; includeSubDomains; preload
       transfer-encoding:
       - chunked
     parsed_body:
-      created_at: 1743075630
+      background: false
+      created_at: 1757604033
       error: null
-      id: resp_67e5392e0fa48191b4c2e1ec82b33e7a006bc99764149f64
+      id: resp_68c2e8c147ac819491bcd667055eadbc02e845978fbbb592
       incomplete_details: null
-      instructions: ''
+      instructions: null
       max_output_tokens: null
+      max_tool_calls: null
       metadata: {}
       model: gpt-4o-2024-08-06
       object: response
       output:
       - content:
         - annotations: []
+          logprobs: []
           text: The capital of France is Paris.
           type: output_text
-        id: msg_67e5392e466c8191ad4ef0744bded009006bc99764149f64
+        id: msg_68c2e8c26114819489dae5b59fceb7bf02e845978fbbb592
         role: assistant
         status: completed
         type: message
       parallel_tool_calls: true
       previous_response_id: null
+      prompt_cache_key: null
       reasoning:
         effort: null
-        generate_summary: null
+        summary: null
+      safety_identifier: null
+      service_tier: default
       status: completed
       store: true
       temperature: 1.0
       text:
         format:
           type: text
+        verbosity: medium
       tool_choice: auto
       tools: []
+      top_logprobs: 0
       top_p: 1.0
       truncation: disabled
       usage:
-        input_tokens: 32
+        input_tokens: 14
         input_tokens_details:
           cached_tokens: 0
         output_tokens: 8
         output_tokens_details:
           reasoning_tokens: 0
-        total_tokens: 40
+        total_tokens: 22
       user: null
     status:
       code: 200