Wrong return type for tool calls in messages

[mwood23]

Between 0.0.58 and 0.0.61 the returning message for function calls changed. I'm using OpenAI and PersistentContext. I noticed my DB was showing something totally different than expected.

Before (my function returns {success: true} but more advanced ones return much more):

{"role": "tool", "content": "{\"success\": true}", "tool_call_id": "call_VIfF0z41yTSxTfMzcvSPA5EP"}

After upgrading:

{"role": "tool", "content": "IN_PROGRESS", "tool_call_id": "call_Z6vhPBLWKL2dbPcNJkb7jykm"}

Based on the OpenAI docs this needs to return the actual output of the function call so that the assistant's response can include it.

May of missed it in the changelog, but this appears to be a regression to me. If not, would love to more details so I could better understand!

I think this patch gets back to the old functionality:

diff --git a/src/pipecat/services/openai.py b/src/pipecat/services/openai.py
index 7b2ac969..7bc82b1f 100644
--- a/src/pipecat/services/openai.py
+++ b/src/pipecat/services/openai.py
@@ -609,27 +609,41 @@ class OpenAIAssistantContextAggregator(LLMAssistantContextAggregator):
                 ],
             }
         )
-        self._context.add_message(
-            {
-                "role": "tool",
-                "content": "IN_PROGRESS",
-                "tool_call_id": frame.tool_call_id,
-            }
-        )
 
     async def handle_function_call_result(self, frame: FunctionCallResultFrame):
         if frame.result:
             result = json.dumps(frame.result)
             await self._update_function_call_result(frame.function_name, frame.tool_call_id, result)
+            self._context.add_message(
+                {
+                    "role": "tool",
+                    "content": result,
+                    "tool_call_id": frame.tool_call_id,
+                }
+            )
         else:
             await self._update_function_call_result(
                 frame.function_name, frame.tool_call_id, "COMPLETED"
             )
+            self._context.add_message(
+                {
+                    "role": "tool",
+                    "content": "COMPLETED",
+                    "tool_call_id": frame.tool_call_id,
+                }
+            )
 
     async def handle_function_call_cancel(self, frame: FunctionCallCancelFrame):
         await self._update_function_call_result(
             frame.function_name, frame.tool_call_id, "CANCELLED"
         )
+        self._context.add_message(
+            {
+                "role": "tool",
+                "content": "CANCELLED",
+                "tool_call_id": frame.tool_call_id,
+            }
+        )
 
     async def _update_function_call_result(
         self, function_name: str, tool_call_id: str, result: Any

[bnussey]

Also getting same error and downgraded back to 0.0.58

[{'function_call': {'name': 'get_available_slots', 'args': {'startTime': '2025-04-01T08:00:00+11:00', 'endTime': '2025-04-01T12:00:00+11:00'}, 'id': 'ccc6d629-34ad-4248-9909-70d197226697'}}], 'role': 'model'}, {'parts': [{'function_response': {'name': 'get_available_slots', 'response': {'response': 'IN_PROGRESS'}, 'id': 'ccc6d629-34ad-4248-9909-70d197226697'}}], 'role': 'user'}, {'parts': [{'function_call': {'name': 'get_available_slots', 'args': {'startTime': '2025-04-01T08:00:00+11:00', 'endTime': '2025-04-01T12:00:00+11:00'}, 'id': 'd7b0df6b-49eb-4d5a-b7d0-4fc003adf076'}}], 'role': 'model'}, {'parts': [{'function_response': {'name': 'get_available_slots', 'response': {'response': 'IN_PROGRESS'}, 'id': 'd7b0df6b-49eb-4d5a-b7d0-4fc003adf076'}}], 'role': 'user'}]]