Move ThinkingPart to preceed TextPart in OpenAIResponsesModel (#2043)

Author: Kludex

pydantic_ai_slim/pydantic_ai/models/openai.py

@@ -644,13 +644,16 @@ def _process_response(self, response: responses.Response) -> ModelResponse:
         """Process a non-streamed response, and prepare a message to return."""
         timestamp = number_to_datetime(response.created_at)
         items: list[ModelResponsePart] = []
-        items.append(TextPart(response.output_text))
         for item in response.output:
             if item.type == 'reasoning':
                 for summary in item.summary:
                     # NOTE: We use the same id for all summaries because we can merge them on the round trip.
                     # The providers don't force the signature to be unique.
                     items.append(ThinkingPart(content=summary.text, id=item.id))
+            elif item.type == 'message':
+                for content in item.content:
+                    if content.type == 'output_text':  # pragma: no branch
+                        items.append(TextPart(content.text))
             elif item.type == 'function_call':
                 items.append(ToolCallPart(item.name, item.arguments, tool_call_id=item.call_id))
         return ModelResponse(

tests/models/test_cohere.py

@@ -441,11 +441,11 @@ async def test_cohere_model_thinking_part(allow_model_requests: None, co_api_key
             ModelRequest(parts=[UserPromptPart(content='How do I cross the street?', timestamp=IsDatetime())]),
             ModelResponse(
                 parts=[
-                    IsInstance(TextPart),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
+                    IsInstance(TextPart),
                 ],
                 usage=Usage(
                     request_tokens=13,
@@ -470,11 +470,11 @@ async def test_cohere_model_thinking_part(allow_model_requests: None, co_api_key
             ModelRequest(parts=[UserPromptPart(content='How do I cross the street?', timestamp=IsDatetime())]),
             ModelResponse(
                 parts=[
-                    IsInstance(TextPart),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
+                    IsInstance(TextPart),
                 ],
                 usage=Usage(
                     request_tokens=13,
@@ -495,43 +495,7 @@ async def test_cohere_model_thinking_part(allow_model_requests: None, co_api_key
                 ]
             ),
             ModelResponse(
-                parts=[
-                    TextPart(
-                        content="""\
-Crossing a river can be a different challenge compared to crossing a street, and the approach to safety and navigation will vary. Here are some considerations and steps to help you cross a river safely:
-
-1. **Determine the River's Characteristics:**
-   - **Width and Depth:** Measure or estimate the width of the river. Very wide rivers may require a boat or bridge for safe crossing. Also, assess the depth; shallow areas might be safe to wade through, while deeper sections may require a different method.
-   - **Current and Flow:** Understand the river's current. Strong currents can make swimming dangerous and may carry debris. Always check the flow rate and direction before attempting to cross.
-   - **Hazards:** Look for potential hazards like rocks, logs, or underwater obstacles that could cause injury or damage to equipment.
-
-2. **Choose a Safe Crossing Method:**
-   - **Fording:** If the river is shallow and the current is gentle, you might be able to ford the river. This involves walking through the water, often with the help of a sturdy stick or pole for balance and support. Always test the depth and current before attempting to ford.
-   - **Swimming:** Swimming across a river is a challenging and potentially dangerous option. It requires strong swimming skills, endurance, and knowledge of river currents. Always swim with a buddy and be aware of your surroundings.
-   - **Boat or Raft:** Using a boat, raft, or even an inflatable tube can be a safe and efficient way to cross. Ensure the boat is sturdy, properly equipped, and that you have the necessary safety gear, such as life jackets and a first-aid kit.
-   - **Bridge or Ferry:** If available, use a bridge or a ferry service. These are typically the safest and most reliable methods for crossing a river.
-
-3. **Prepare and Pack Essential Items:**
-   - **Life Jacket/Personal Flotation Device (PFD):** Always wear a life jacket or PFD when crossing a river, especially if swimming or using a boat.
-   - **First-Aid Kit:** Carry a basic first-aid kit to handle any minor injuries that might occur during the crossing.
-   - **Map and Compass:** Navigate the river and its surroundings with the help of a map and compass, especially if you're in an unfamiliar area.
-   - **Communication Device:** Have a means of communication, such as a satellite phone or a personal locator beacon, especially in remote areas.
-   - **Dry Clothing and Shelter:** Pack extra dry clothing and a waterproof shelter (like a tarp or tent) in case you get wet or need to wait out bad weather.
-
-4. **Follow River Safety Guidelines:**
-   - **Stay on Marked Paths:** If there are designated river paths or trails, use them. These routes are often designed to be safer and less prone to hazards.
-   - **Avoid Hazards:** Be cautious of slippery rocks, strong currents, and hidden underwater obstacles. Never swim or ford in areas with known dangers.
-   - **Group Safety:** If crossing with others, stay together. It's easier to keep an eye on each other and provide assistance if needed.
-
-5. **Be Prepared for Emergencies:**
-   - **Know Emergency Procedures:** Familiarize yourself with river rescue techniques and procedures. Learn how to signal for help and basic survival skills.
-   - **Carry Emergency Supplies:** Pack emergency supplies, including a whistle, a bright-colored cloth to signal, and a signal mirror (if available).
-   - **Leave a Plan:** Inform someone on the riverbank about your crossing plans, including your expected time of return. This person can raise the alarm if you don't return as scheduled.
-
-Remember, crossing a river can be a challenging and potentially dangerous endeavor. Always prioritize safety, and if in doubt, seek professional guidance or assistance from experienced river guides or local authorities. It's better to be over-prepared than caught off guard in a river crossing situation.\
-"""
-                    )
-                ],
+                parts=[IsInstance(TextPart)],
                 usage=Usage(
                     requests=1,
                     request_tokens=1457,

tests/models/test_gemini.py

@@ -1393,10 +1393,36 @@ async def test_gemini_model_thinking_part(allow_model_requests: None, gemini_api
             ModelRequest(parts=[UserPromptPart(content='How do I cross the street?', timestamp=IsDatetime())]),
             ModelResponse(
                 parts=[
-                    IsInstance(TextPart),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
+                    TextPart(
+                        content="""\
+Here are guidelines for safely crossing a street. Remember that these tips are general and may need to be adjusted depending on your local traffic laws and the specific situation. They are not a substitute for professional safety advice.
+
+1. Before you approach the street:
+ • Use the sidewalk if available and get to the curb or edge of the road.
+ • If you're a child or feel unsure, try to have an adult accompany you.
+
+2. When you're ready to cross:
+ • Look carefully in all directions—start by looking left, then right, and left again. In countries where you drive on the left you'll want to adjust accordingly.
+ • Listen for vehicles and be aware of turning cars, which might not be immediately in your line of sight.
+ • Make eye contact with drivers if possible so that you know they see you.
+
+3. Use designated crossing areas whenever possible:
+ • If there's a pedestrian crosswalk, use it. Crosswalks and traffic signals are there to help manage the flow of both vehicles and pedestrians.
+ • If there's a "Walk" signal, wait until it's on before crossing. Even if the signal turns green for pedestrians, always take an extra moment to ensure that approaching drivers are stopping.
+
+4. While crossing:
+ • Continue to remain alert and avoid distractions like cell phones or headphones that could prevent you from noticing approaching traffic.
+ • Walk at a steady pace and stay in the crosswalk until you have completely reached the other side.
+
+5. After crossing:
+ • Once you've safely reached the other side, continue to be aware of any vehicles that might be turning or reversing.
+
+Always be cautious—even if you have the right-of-way—and understand that it's better to wait a moment longer than risk being caught off guard. Stay safe!\
+"""
+                    ),
                 ],
                 usage=Usage(
                     request_tokens=13,
@@ -1424,10 +1450,10 @@ async def test_gemini_model_thinking_part(allow_model_requests: None, gemini_api
             ModelRequest(parts=[UserPromptPart(content='How do I cross the street?', timestamp=IsDatetime())]),
             ModelResponse(
                 parts=[
-                    IsInstance(TextPart),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
+                    IsInstance(TextPart),
                 ],
                 usage=Usage(
                     request_tokens=13,

tests/models/test_mistral.py

@@ -1982,11 +1982,11 @@ async def test_mistral_model_thinking_part(allow_model_requests: None, openai_ap
             ModelRequest(parts=[UserPromptPart(content='How do I cross the street?', timestamp=IsDatetime())]),
             ModelResponse(
                 parts=[
-                    TextPart(content=IsStr()),
                     ThinkingPart(content=IsStr(), id='rs_68079ad7f0588191af64f067e7314d840493b22e4095129c'),
                     ThinkingPart(content=IsStr(), id='rs_68079ad7f0588191af64f067e7314d840493b22e4095129c'),
                     ThinkingPart(content=IsStr(), id='rs_68079ad7f0588191af64f067e7314d840493b22e4095129c'),
                     ThinkingPart(content=IsStr(), id='rs_68079ad7f0588191af64f067e7314d840493b22e4095129c'),
+                    TextPart(content=IsStr()),
                 ],
                 usage=Usage(
                     request_tokens=13,
@@ -2012,11 +2012,44 @@ async def test_mistral_model_thinking_part(allow_model_requests: None, openai_ap
             ModelRequest(parts=[UserPromptPart(content='How do I cross the street?', timestamp=IsDatetime())]),
             ModelResponse(
                 parts=[
-                    TextPart(content=IsStr()),
                     ThinkingPart(content=IsStr(), id='rs_68079ad7f0588191af64f067e7314d840493b22e4095129c'),
                     ThinkingPart(content=IsStr(), id='rs_68079ad7f0588191af64f067e7314d840493b22e4095129c'),
                     ThinkingPart(content=IsStr(), id='rs_68079ad7f0588191af64f067e7314d840493b22e4095129c'),
                     ThinkingPart(content=IsStr(), id='rs_68079ad7f0588191af64f067e7314d840493b22e4095129c'),
+                    TextPart(
+                        content="""\
+I'm not a traffic safety expert, but here are some general guidelines that many people follow when crossing a street safely. Remember that local rules and conditions might vary, so always follow local traffic laws and pay close attention to your surroundings.
+
+1. Find a Designated Crossing Point
+ • Look for crosswalks, pedestrian signals, or marked intersections. These areas are designed for safe crossing.
+ • If no crosswalk is available, choose a spot where you have clear visibility of oncoming traffic in all directions.
+
+2. Stop at the Curb or Edge of the Road
+ • Before stepping off the curb, pause to assess the situation.
+ • Resist the urge to step into the street immediately—this helps you avoid unpredictable traffic behavior.
+
+3. Look and Listen
+ • Look left, then right, and left again. In some places, you might need to check right a second time depending on the flow of traffic.
+ • Pay attention to the sound of approaching vehicles or any signals that indicate vehicles may be turning into your path.
+ • Remove or lower distractions like headphones so you can be fully aware of your environment.
+
+4. Follow Pedestrian Signals (if available)
+ • If you're at an intersection with traffic signals, wait for the "Walk" signal.
+ • Even when the signal is in your favor, ensure that any turning vehicles (cars or bikes) see you and are stopping.
+
+5. Make Eye Contact
+ • If possible, make eye contact with drivers who might be turning. This can help ensure that they see you and are taking appropriate action.
+
+6. Cross Quickly and Carefully
+ • Once you've determined that it's safe, proceed at a steady pace.
+ • Continue to be alert while you cross, watching for any unexpected vehicle movements.
+
+7. Stay on the Sidewalk Once You've Crossed
+ • After reaching the other side, stick to areas designated for pedestrians rather than walking immediately back into the roadway.
+
+These suggestions are meant to help you think through pedestrian safety. Different regions may have additional rules or different signals, so if you're unsure, it might help to check local guidelines or ask someone familiar with the area. Stay safe!\
+"""
+                    ),
                 ],
                 usage=Usage(
                     request_tokens=13,

tests/models/test_openai.py

@@ -1618,11 +1618,11 @@ async def test_openai_responses_model_thinking_part(allow_model_requests: None,
             ModelRequest(parts=[UserPromptPart(content='How do I cross the street?', timestamp=IsDatetime())]),
             ModelResponse(
                 parts=[
-                    TextPart(content=IsStr()),
                     ThinkingPart(content=IsStr(), id='rs_68034841ab2881918a8c210e3d988b9208c845d2be9bcdd8'),
                     ThinkingPart(content=IsStr(), id='rs_68034841ab2881918a8c210e3d988b9208c845d2be9bcdd8'),
                     ThinkingPart(content=IsStr(), id='rs_68034841ab2881918a8c210e3d988b9208c845d2be9bcdd8'),
                     ThinkingPart(content=IsStr(), id='rs_68034841ab2881918a8c210e3d988b9208c845d2be9bcdd8'),
+                    IsInstance(TextPart),
                 ],
                 usage=Usage(
                     request_tokens=13,
@@ -1646,11 +1646,11 @@ async def test_openai_responses_model_thinking_part(allow_model_requests: None,
             ModelRequest(parts=[UserPromptPart(content='How do I cross the street?', timestamp=IsDatetime())]),
             ModelResponse(
                 parts=[
-                    TextPart(content=IsStr()),
                     ThinkingPart(content=IsStr(), id='rs_68034841ab2881918a8c210e3d988b9208c845d2be9bcdd8'),
                     ThinkingPart(content=IsStr(), id='rs_68034841ab2881918a8c210e3d988b9208c845d2be9bcdd8'),
                     ThinkingPart(content=IsStr(), id='rs_68034841ab2881918a8c210e3d988b9208c845d2be9bcdd8'),
                     ThinkingPart(content=IsStr(), id='rs_68034841ab2881918a8c210e3d988b9208c845d2be9bcdd8'),
+                    IsInstance(TextPart),
                 ],
                 usage=Usage(
                     request_tokens=13,
@@ -1672,10 +1672,10 @@ async def test_openai_responses_model_thinking_part(allow_model_requests: None,
             ),
             ModelResponse(
                 parts=[
-                    TextPart(content=IsStr()),
                     ThinkingPart(content=IsStr(), id='rs_68034858dc588191bc3a6801c23e728f08c845d2be9bcdd8'),
                     ThinkingPart(content=IsStr(), id='rs_68034858dc588191bc3a6801c23e728f08c845d2be9bcdd8'),
                     ThinkingPart(content=IsStr(), id='rs_68034858dc588191bc3a6801c23e728f08c845d2be9bcdd8'),
+                    IsInstance(TextPart),
                 ],
                 usage=Usage(
                     request_tokens=424,
@@ -1704,11 +1704,11 @@ async def test_openai_model_thinking_part(allow_model_requests: None, openai_api
             ModelRequest(parts=[UserPromptPart(content='How do I cross the street?', timestamp=IsDatetime())]),
             ModelResponse(
                 parts=[
-                    TextPart(content=IsStr()),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
+                    IsInstance(TextPart),
                 ],
                 usage=Usage(
                     request_tokens=13,
@@ -1733,11 +1733,11 @@ async def test_openai_model_thinking_part(allow_model_requests: None, openai_api
             ModelRequest(parts=[UserPromptPart(content='How do I cross the street?', timestamp=IsDatetime())]),
             ModelResponse(
                 parts=[
-                    TextPart(content=IsStr()),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
                     IsInstance(ThinkingPart),
+                    IsInstance(TextPart),
                 ],
                 usage=Usage(
                     request_tokens=13,