enhance: gemini stream mode support (#3443)

Author: Wendong-Fan

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -26,7 +26,7 @@ body:
     attributes:
       label: What version of camel are you using?
       description: Run command `python3 -c 'print(__import__("camel").__version__)'` in your shell and paste the output here.
-      placeholder: E.g., 0.2.80a2
+      placeholder: E.g., 0.2.80a3
     validations:
       required: true
 

camel/__init__.py

@@ -14,7 +14,7 @@
 
 from camel.logger import disable_logging, enable_logging, set_log_level
 
-__version__ = '0.2.80a2'
+__version__ = '0.2.80a3'
 
 __all__ = [
     '__version__',

camel/agents/_types.py

@@ -27,6 +27,7 @@ class ToolCallRequest(BaseModel):
     tool_name: str
     args: Dict[str, Any]
     tool_call_id: str
+    extra_content: Optional[Dict[str, Any]] = None
 
 
 class ModelResponse(BaseModel):

camel/agents/chat_agent.py

@@ -3692,8 +3692,13 @@ def _handle_batch_response(
                 tool_name = tool_call.function.name  # type: ignore[union-attr]
                 tool_call_id = tool_call.id
                 args = json.loads(tool_call.function.arguments)  # type: ignore[union-attr]
+                extra_content = getattr(tool_call, 'extra_content', None)
+
                 tool_call_request = ToolCallRequest(
-                    tool_name=tool_name, args=args, tool_call_id=tool_call_id
+                    tool_name=tool_name,
+                    args=args,
+                    tool_call_id=tool_call_id,
+                    extra_content=extra_content,
                 )
                 tool_call_requests.append(tool_call_request)
 
@@ -3786,7 +3791,12 @@ def _execute_tool(
             logger.warning(f"{error_msg} with result: {result}")
 
         return self._record_tool_calling(
-            func_name, args, result, tool_call_id, mask_output=mask_flag
+            func_name,
+            args,
+            result,
+            tool_call_id,
+            mask_output=mask_flag,
+            extra_content=tool_call_request.extra_content,
         )
 
     async def _aexecute_tool(
@@ -3828,7 +3838,13 @@ async def _aexecute_tool(
             error_msg = f"Error executing async tool '{func_name}': {e!s}"
             result = f"Tool execution failed: {error_msg}"
             logger.warning(error_msg)
-        return self._record_tool_calling(func_name, args, result, tool_call_id)
+        return self._record_tool_calling(
+            func_name,
+            args,
+            result,
+            tool_call_id,
+            extra_content=tool_call_request.extra_content,
+        )
 
     def _record_tool_calling(
         self,
@@ -3837,6 +3853,7 @@ def _record_tool_calling(
         result: Any,
         tool_call_id: str,
         mask_output: bool = False,
+        extra_content: Optional[Dict[str, Any]] = None,
     ):
         r"""Record the tool calling information in the memory, and return the
         tool calling record.
@@ -3849,6 +3866,9 @@ def _record_tool_calling(
             mask_output (bool, optional): Whether to return a sanitized
                 placeholder instead of the raw tool output.
                 (default: :obj:`False`)
+            extra_content (Optional[Dict[str, Any]], optional): Additional
+                content associated with the tool call.
+                (default: :obj:`None`)
 
         Returns:
             ToolCallingRecord: A struct containing information about
@@ -3862,6 +3882,7 @@ def _record_tool_calling(
             func_name=func_name,
             args=args,
             tool_call_id=tool_call_id,
+            extra_content=extra_content,
         )
         func_msg = FunctionCallingMessage(
             role_name=self.role_name,
@@ -3872,6 +3893,7 @@ def _record_tool_calling(
             result=result,
             tool_call_id=tool_call_id,
             mask_output=mask_output,
+            extra_content=extra_content,
         )
 
         # Use precise timestamps to ensure correct ordering
@@ -4006,7 +4028,7 @@ def _stream_response(
                 return
 
             # Handle streaming response
-            if isinstance(response, Stream):
+            if isinstance(response, Stream) or inspect.isgenerator(response):
                 (
                     stream_completed,
                     tool_calls_complete,
@@ -4346,6 +4368,7 @@ def _accumulate_tool_calls(
                     'id': '',
                     'type': 'function',
                     'function': {'name': '', 'arguments': ''},
+                    'extra_content': None,
                     'complete': False,
                 }
 
@@ -4369,6 +4392,14 @@ def _accumulate_tool_calls(
                     tool_call_entry['function']['arguments'] += (
                         delta_tool_call.function.arguments
                     )
+            # Handle extra_content if present
+            if (
+                hasattr(delta_tool_call, 'extra_content')
+                and delta_tool_call.extra_content
+            ):
+                tool_call_entry['extra_content'] = (
+                    delta_tool_call.extra_content
+                )
 
         # Check if any tool calls are complete
         any_complete = False
@@ -4473,6 +4504,7 @@ def _execute_tool_from_stream_data(
             function_name = tool_call_data['function']['name']
             args = json.loads(tool_call_data['function']['arguments'])
             tool_call_id = tool_call_data['id']
+            extra_content = tool_call_data.get('extra_content')
 
             if function_name in self._internal_tools:
                 tool = self._internal_tools[function_name]
@@ -4488,6 +4520,7 @@ def _execute_tool_from_stream_data(
                         func_name=function_name,
                         args=args,
                         tool_call_id=tool_call_id,
+                        extra_content=extra_content,
                     )
 
                     # Then create the tool response message
@@ -4499,6 +4532,7 @@ def _execute_tool_from_stream_data(
                         func_name=function_name,
                         result=result,
                         tool_call_id=tool_call_id,
+                        extra_content=extra_content,
                     )
 
                     # Record both messages with precise timestamps to ensure
@@ -4544,6 +4578,7 @@ def _execute_tool_from_stream_data(
                         func_name=function_name,
                         result=result,
                         tool_call_id=tool_call_id,
+                        extra_content=extra_content,
                     )
 
                     self.update_memory(func_msg, OpenAIBackendRole.FUNCTION)
@@ -4575,6 +4610,7 @@ async def _aexecute_tool_from_stream_data(
             function_name = tool_call_data['function']['name']
             args = json.loads(tool_call_data['function']['arguments'])
             tool_call_id = tool_call_data['id']
+            extra_content = tool_call_data.get('extra_content')
 
             if function_name in self._internal_tools:
                 # Create the tool call message
@@ -4586,6 +4622,7 @@ async def _aexecute_tool_from_stream_data(
                     func_name=function_name,
                     args=args,
                     tool_call_id=tool_call_id,
+                    extra_content=extra_content,
                 )
                 assist_ts = time.time_ns() / 1_000_000_000
                 self.update_memory(
@@ -4632,6 +4669,7 @@ async def _aexecute_tool_from_stream_data(
                         func_name=function_name,
                         result=result,
                         tool_call_id=tool_call_id,
+                        extra_content=extra_content,
                     )
                     func_ts = time.time_ns() / 1_000_000_000
                     self.update_memory(
@@ -4665,6 +4703,7 @@ async def _aexecute_tool_from_stream_data(
                         func_name=function_name,
                         result=result,
                         tool_call_id=tool_call_id,
+                        extra_content=extra_content,
                     )
                     func_ts = time.time_ns() / 1_000_000_000
                     self.update_memory(
@@ -4979,6 +5018,11 @@ def _record_assistant_tool_calls_message(
                         "arguments": tool_call_data["function"]["arguments"],
                     },
                 }
+                # Include extra_content if present
+                if tool_call_data.get('extra_content'):
+                    tool_call_dict["extra_content"] = tool_call_data[
+                        "extra_content"
+                    ]
                 tool_calls_list.append(tool_call_dict)
 
         # Create an assistant message with tool calls

camel/messages/func_message.py

@@ -50,13 +50,17 @@ class FunctionCallingMessage(BaseMessage):
         mask_output (Optional[bool]): Whether to return a sanitized placeholder
             instead of the raw tool output.
             (default: :obj:`False`)
+        extra_content (Optional[Dict[str, Any]]): Additional content
+            associated with the tool call.
+            (default: :obj:`None`)
     """
 
     func_name: Optional[str] = None
     args: Optional[Dict] = None
     result: Optional[Any] = None
     tool_call_id: Optional[str] = None
     mask_output: Optional[bool] = False
+    extra_content: Optional[Dict[str, Any]] = None
 
     def to_openai_message(
         self,
@@ -131,19 +135,23 @@ def to_openai_assistant_message(self) -> OpenAIAssistantMessage:
                 " due to missing function name or arguments."
             )
 
+        tool_call = {
+            "id": self.tool_call_id or "null",
+            "type": "function",
+            "function": {
+                "name": self.func_name,
+                "arguments": json.dumps(self.args, ensure_ascii=False),
+            },
+        }
+
+        # Include extra_content if available
+        if self.extra_content is not None:
+            tool_call["extra_content"] = self.extra_content
+
         return {
             "role": "assistant",
             "content": self.content or "",
-            "tool_calls": [
-                {
-                    "id": self.tool_call_id or "null",
-                    "type": "function",
-                    "function": {
-                        "name": self.func_name,
-                        "arguments": json.dumps(self.args, ensure_ascii=False),
-                    },
-                }
-            ],
+            "tool_calls": [tool_call],  # type: ignore[list-item]
         }
 
     def to_openai_tool_message(self) -> OpenAIToolMessageParam:
@@ -187,4 +195,6 @@ def to_dict(self) -> Dict:
         if self.tool_call_id is not None:
             base["tool_call_id"] = self.tool_call_id
         base["mask_output"] = self.mask_output
+        if self.extra_content is not None:
+            base["extra_content"] = self.extra_content
         return base