Add OpenAIModelProfile.openai_responses_requires_function_call_status_none flag to satisfy vLLM Responses API (#3246)

Author: DouweM

pydantic_ai_slim/pydantic_ai/models/openai.py

@@ -1431,6 +1431,8 @@ async def _map_messages(  # noqa: C901
                             call_id=call_id,
                             type='function_call',
                         )
+                        if profile.openai_responses_requires_function_call_status_none:
+                            param['status'] = None  # type: ignore[reportGeneralTypeIssues]
                         if id and send_item_ids:  # pragma: no branch
                             param['id'] = id
                         openai_messages.append(param)

pydantic_ai_slim/pydantic_ai/profiles/openai.py

@@ -44,6 +44,13 @@ class OpenAIModelProfile(ModelProfile):
     openai_supports_encrypted_reasoning_content: bool = False
     """Whether the model supports including encrypted reasoning content in the response."""
 
+    openai_responses_requires_function_call_status_none: bool = False
+    """Whether the Responses API requires the `status` field on function tool calls to be `None`.
+
+    This is required by vLLM Responses API versions before https://github.com/vllm-project/vllm/pull/26706.
+    See https://github.com/pydantic/pydantic-ai/issues/3245 for more details.
+    """
+
     def __post_init__(self):  # pragma: no cover
         if not self.openai_supports_sampling_settings:
             warnings.warn(

tests/models/cassettes/test_openai_responses/test_openai_responses_model_simple_response_with_tool_call.yaml

@@ -8,7 +8,7 @@ interactions:
       connection:
       - keep-alive
       content-length:
-      - '338'
+      - '337'
       content-type:
       - application/json
       host:
@@ -18,11 +18,11 @@ interactions:
       input:
       - content: What is the capital of PotatoLand?
         role: user
-      instructions: ''
       model: gpt-4o
+      stream: false
       tool_choice: auto
       tools:
-      - description: ''
+      - description: null
         name: get_capital
         parameters:
           additionalProperties: false
@@ -42,47 +42,57 @@ interactions:
       connection:
       - keep-alive
       content-length:
-      - '1497'
+      - '1720'
       content-type:
       - application/json
       openai-organization:
       - pydantic-28gund
       openai-processing-ms:
-      - '666'
+      - '1811'
+      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
+      billing:
+        payer: developer
+      created_at: 1761323546
       error: null
-      id: resp_67e5392eae34819184408ee7e23f50160aa13be256b050b4
+      id: resp_04907f5d3de791830068fbaa19bb908195a91378279dba0f14
       incomplete_details: null
-      instructions: ''
+      instructions: null
       max_output_tokens: null
+      max_tool_calls: null
       metadata: {}
       model: gpt-4o-2024-08-06
       object: response
       output:
       - arguments: '{"country":"PotatoLand"}'
-        call_id: call_Zmx4ZiPQOvoNEhLgG16TO3nx
-        id: fc_67e5392f33ac8191b215eeff4f9931f80aa13be256b050b4
+        call_id: call_YfwRsW8sUxDKipwyhWTzOXCA
+        id: fc_04907f5d3de791830068fbaa1b310c81958dc9c508e878c632
         name: get_capital
         status: completed
         type: function_call
       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:
       - description: null
@@ -97,16 +107,17 @@ interactions:
           type: object
         strict: true
         type: function
+      top_logprobs: 0
       top_p: 1.0
       truncation: disabled
       usage:
-        input_tokens: 256
+        input_tokens: 40
         input_tokens_details:
           cached_tokens: 0
         output_tokens: 18
         output_tokens_details:
           reasoning_tokens: 0
-        total_tokens: 274
+        total_tokens: 58
       user: null
     status:
       code: 200
@@ -120,33 +131,32 @@ interactions:
       connection:
       - keep-alive
       content-length:
-      - '600'
+      - '579'
       content-type:
       - application/json
       cookie:
-      - __cf_bm=vVsJhB9A9X9_43ZZ4_DPKFw_dO0SSxBWEhx4UiGncwQ-1743075631-1.0.1.1-N3mdrI4LFgBBnd_XI5x81Q5KKuykqiNo8wFt1XpgnPkVX0ISneJo_Yh1B3ZyfLeI5LaMdhMxhGB6wOfgrg4pP9f33KlF4C8grewNF05MpKw;
-        _cfuvid=vB6MpPuauumuSrL6beYNRLXeNQt2_XZpKzom2c97AFI-1743075631374-0.0.1.1-604800000
+      - __cf_bm=g29aPgrRIxmp3X5o6PZW9E8aKljsJ3_YKN58sMhqjnI-1761323547-1.0.1.1-Uj.mPGHnvAjpHojYAfG.QReYxHtLCz0jBoPrirBGA48A.LawB_Afgv0C8s0DC2TIU2y6zbyq4bA1moTVcNApxaq4NaLqfKpLe2hQBB_xM.M;
+        _cfuvid=kiKLNQ6S_H_I6dKfHm0bpQwt35G4FrXx6u4P3LxaXIQ-1761323547535-0.0.1.1-604800000
       host:
       - api.openai.com
     method: POST
     parsed_body:
       input:
       - content: What is the capital of PotatoLand?
         role: user
-      - content: ''
-        role: assistant
       - arguments: '{"country":"PotatoLand"}'
-        call_id: call_Zmx4ZiPQOvoNEhLgG16TO3nx
+        call_id: call_YfwRsW8sUxDKipwyhWTzOXCA
         name: get_capital
+        status: null
         type: function_call
-      - call_id: call_Zmx4ZiPQOvoNEhLgG16TO3nx
+      - call_id: call_YfwRsW8sUxDKipwyhWTzOXCA
         output: Potato City
         type: function_call_output
-      instructions: ''
       model: gpt-4o
+      stream: false
       tool_choice: auto
       tools:
-      - description: ''
+      - description: null
         name: get_capital
         parameters:
           additionalProperties: false
@@ -166,49 +176,60 @@ interactions:
       connection:
       - keep-alive
       content-length:
-      - '1561'
+      - '1810'
       content-type:
       - application/json
       openai-organization:
       - pydantic-28gund
       openai-processing-ms:
-      - '470'
+      - '1028'
+      openai-project:
+      - proj_dKobscVY9YJxeEaDJen54e3d
       openai-version:
       - '2020-10-01'
       strict-transport-security:
       - max-age=31536000; includeSubDomains; preload
       transfer-encoding:
       - chunked
     parsed_body:
-      created_at: 1743075631
+      background: false
+      billing:
+        payer: developer
+      created_at: 1761323547
       error: null
-      id: resp_67e5392f80808191affe6ff7af237dba0b8eafaa14d24d42
+      id: resp_0e9950da9eac6a780068fbaa1bc030819da585a6f85ddad1e6
       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 PotatoLand is Potato City.
           type: output_text
-        id: msg_67e5392fd7b4819190bec4e770968a9d0b8eafaa14d24d42
+        id: msg_0e9950da9eac6a780068fbaa1c738c819d8bddf998e57232c3
         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:
       - description: null
@@ -223,16 +244,17 @@ interactions:
           type: object
         strict: true
         type: function
+      top_logprobs: 0
       top_p: 1.0
       truncation: disabled
       usage:
-        input_tokens: 287
+        input_tokens: 67
         input_tokens_details:
           cached_tokens: 0
         output_tokens: 11
         output_tokens_details:
           reasoning_tokens: 0
-        total_tokens: 298
+        total_tokens: 78
       user: null
     status:
       code: 200