enhance: PR3123 DingTalk toolkit integration (#3182)

Wendong-Fan · web-flow · commit 106602465f26 · 2025-09-23T11:51:10.000+08:00
diff --git a/camel/toolkits/dingtalk.py b/camel/toolkits/dingtalk.py
@@ -420,7 +420,8 @@ def dingtalk_send_webhook_message(
             msgtype (Literal): Message type (text, markdown, link, actionCard).
             title (Optional[str]): Message title (required for markdown).
             webhook_url (Optional[str]): Webhook URL. If None, uses env var.
-            webhook_secret (Optional[str]): Webhook secret. If None, uses env var.
+            webhook_secret (Optional[str]): Webhook secret. If None, uses env
+                var.
 
         Returns:
             str: Success or error message.
@@ -430,7 +431,9 @@ def dingtalk_send_webhook_message(
         """
         # Get webhook configuration
         url = webhook_url or os.environ.get("DINGTALK_WEBHOOK_URL", "")
-        secret = webhook_secret or os.environ.get("DINGTALK_WEBHOOK_SECRET", "")
+        secret = webhook_secret or os.environ.get(
+            "DINGTALK_WEBHOOK_SECRET", ""
+        )
 
         if not url:
             return "Error: Webhook URL not provided or set in environment"
@@ -479,7 +482,9 @@ def dingtalk_send_webhook_message(
             if result.get("errcode") == 0:
                 return "Webhook message sent successfully"
             else:
-                return f"Webhook error: {result.get('errmsg', 'Unknown error')}"
+                return (
+                    f"Webhook error: {result.get('errmsg', 'Unknown error')}"
+                )
 
         except Exception as e:
             return f"Failed to send webhook message: {e!s}"
@@ -691,17 +696,19 @@ def dingtalk_get_user_by_mobile(self, mobile: str) -> Dict[str, Any]:
         r"""Gets user information by mobile number.
 
         Args:
-            mobile (str): User's mobile number. Should be a valid Chinese 
+            mobile (str): User's mobile number. Should be a valid Chinese
                 mobile number format (11 digits starting with 1).
 
         Returns:
             Dict[str, Any]: User information or error information.
         """
-        # Validate mobile number format (Chinese mobile number: 11 digits starting with 1)
+        # Validate mobile number format (Chinese mobile number: 11 digits
+        # starting with 1)
         mobile_pattern = r'^1[3-9]\d{9}$'
         if not re.match(mobile_pattern, mobile):
             return {
-                "error": "Invalid mobile number format. Expected 11 digits starting with 1 (e.g., 13800000000)."
+                "error": "Invalid mobile number format. Expected 11 digits "
+                "starting with 1 (e.g., 13800000000)."
             }
 
         payload = {"mobile": mobile}
@@ -727,9 +734,9 @@ def dingtalk_get_user_by_unionid(self, unionid: str) -> Dict[str, Any]:
         r"""Gets user information by unionid.
 
         Args:
-            unionid (str): User's unique identifier across all DingTalk 
-                organizations. This is a global identifier that remains 
-                consistent even if the user belongs to multiple DingTalk 
+            unionid (str): User's unique identifier across all DingTalk
+                organizations. This is a global identifier that remains
+                consistent even if the user belongs to multiple DingTalk
                 organizations, unlike userid which is organization-specific.
 
         Returns:
@@ -891,10 +898,10 @@ def dingtalk_update_group(
             name (Optional[str]): New group name.
             owner (Optional[str]): New group owner userid.
             add_useridlist (Optional[List[str]]): List of user IDs to add.
-                Note: Internally converted to comma-separated string as 
+                Note: Internally converted to comma-separated string as
                 required by the DingTalk API.
             del_useridlist (Optional[List[str]]): List of user IDs to remove.
-                Note: Internally converted to comma-separated string as 
+                Note: Internally converted to comma-separated string as
                 required by the DingTalk API.
 
         Returns:
@@ -909,7 +916,8 @@ def dingtalk_update_group(
             payload["name"] = name
         if owner:
             payload["owner"] = owner
-        # Note: DingTalk update group API requires comma-separated string format
+        # Note: DingTalk update group API requires comma-separated string
+        # format
         # This is different from send_work_notification which uses array format
         if add_useridlist:
             payload["add_useridlist"] = ",".join(add_useridlist)
@@ -991,18 +999,15 @@ def dingtalk_send_work_notification(
             (None, "DINGTALK_APP_SECRET"),
         ]
     )
-    def dingtalk_get_userid_by_phone(
-        self, 
-        phone_number: str
-    ) -> str:
+    def dingtalk_get_userid_by_phone(self, phone_number: str) -> str:
         r"""Gets user ID by phone number for LLM agents.
-        
+
         Args:
             phone_number (str): User's phone number.
-            
+
         Returns:
             str: User ID or error message.
-            
+
         References:
             https://open.dingtalk.com/document/orgapp-server/query-user-details
         """
@@ -1021,27 +1026,25 @@ def dingtalk_get_userid_by_phone(
             (None, "DINGTALK_APP_SECRET"),
         ]
     )
-    def dingtalk_get_userid_by_name(
-        self, 
-        user_name: str
-    ) -> str:
+    def dingtalk_get_userid_by_name(self, user_name: str) -> str:
         r"""Gets user ID by user name for LLM agents.
-        
+
         Args:
             user_name (str): User's display name.
-            
+
         Returns:
             str: User ID or error message.
-            
+
         References:
             https://open.dingtalk.com/document/orgapp-server/query-users
         """
         try:
             search_result = self.dingtalk_search_users_by_name(user_name)
-            if 'result' in search_result and search_result['result']:
+            if search_result.get('result'):
                 # Return the first match
-                return search_result['result'][0].get('userid', 
-                    f"No userid found for user: {user_name}")
+                return search_result['result'][0].get(
+                    'userid', f"No userid found for user: {user_name}"
+                )
             else:
                 return f"User not found with name: {user_name}"
         except Exception as e:
@@ -1053,15 +1056,12 @@ def dingtalk_get_userid_by_name(
             (None, "DINGTALK_APP_SECRET"),
         ]
     )
-    def dingtalk_get_department_id_by_name(
-        self, 
-        department_name: str
-    ) -> str:
+    def dingtalk_get_department_id_by_name(self, department_name: str) -> str:
         r"""Gets department ID by department name for LLM agents.
-        
+
         Args:
             department_name (str): Department name to search for.
-            
+
         Returns:
             str: Department ID or error message.
         """
@@ -1073,23 +1073,20 @@ def dingtalk_get_department_id_by_name(
                         return str(dept.get('id', ''))
                 return f"Department not found: {department_name}"
             else:
-                return f"Failed to get department list"
+                return "Failed to get department list"
         except Exception as e:
             return f"Failed to get department ID by name: {e!s}"
 
-    def dingtalk_get_chatid_by_group_name(
-        self, 
-        group_name: str
-    ) -> str:
+    def dingtalk_get_chatid_by_group_name(self, group_name: str) -> str:
         r"""Gets chat ID by group name for LLM agents.
-        
+
         Note: This function provides guidance as Dingtalk API doesn't directly
         support searching groups by name. Users should use the group creation
         response or group management features to obtain chat IDs.
-        
+
         Args:
             group_name (str): Group name to search for.
-            
+
         Returns:
             str: Guidance message for obtaining chat ID.
         """
@@ -1135,4 +1132,4 @@ def get_tools(self) -> List[FunctionTool]:
         ]
 
 
-# many other functionalities, cards etc build on top after initial works
+# many other functionalities, cards etc build on top after initial works
diff --git a/camel/types/__init__.py b/camel/types/__init__.py
@@ -41,8 +41,8 @@
     ChatCompletionAssistantMessageParam,
     ChatCompletionChunk,
     ChatCompletionMessage,
-    ChatCompletionMessageParam,
     ChatCompletionMessageFunctionToolCall,
+    ChatCompletionMessageParam,
     ChatCompletionSystemMessageParam,
     ChatCompletionToolMessageParam,
     ChatCompletionUserMessageParam,
diff --git a/examples/external_tools/use_external_tools.py b/examples/external_tools/use_external_tools.py
@@ -70,5 +70,5 @@ def main():
 Output:
 The video game "Portal" was released in 2007 as part of a bundle called The Orange Box for Windows, Xbox 360, and PlayStation 3.
 
-ChatCompletionMessageToolCall(id='call_U5Xju7vYtAQAEW4D1M8R1kgs', function=Function(arguments='{"a": 2007, "b": 1776}', name='sub'), type='function')
+ChatCompletionMessageFunctionToolCall(id='call_U5Xju7vYtAQAEW4D1M8R1kgs', function=Function(arguments='{"a": 2007, "b": 1776}', name='sub'), type='function')
 """
diff --git a/examples/toolkits/github_toolkit.py b/examples/toolkits/github_toolkit.py
@@ -70,7 +70,7 @@
     Union,
 )
 
-from openai.types.chat import ChatCompletionMessageToolCall
+from openai.types.chat import ChatCompletionMessageFunctionToolCall
 f
 ===============================================================================
 """
diff --git a/test/agents/test_chat_agent.py b/test/agents/test_chat_agent.py
@@ -19,7 +19,7 @@
 from unittest.mock import AsyncMock, MagicMock
 
 import pytest
-from openai.types.chat import ChatCompletionMessageToolCall
+from openai.types.chat import ChatCompletionMessageFunctionToolCall
 from openai.types.chat.chat_completion import Choice
 from openai.types.chat.chat_completion_message import ChatCompletionMessage
 from openai.types.chat.chat_completion_message_function_tool_call import (
@@ -267,7 +267,7 @@ def test_chat_agent_step_with_external_tools(step_call_count=3):
                     audio=None,
                     function_call=None,
                     tool_calls=[
-                        ChatCompletionMessageToolCall(
+                        ChatCompletionMessageFunctionToolCall(
                             id='call_mock_123456',
                             function=Function(
                                 arguments='{ \
@@ -277,7 +277,7 @@ def test_chat_agent_step_with_external_tools(step_call_count=3):
                             ),
                             type='function',
                         ),
-                        ChatCompletionMessageToolCall(
+                        ChatCompletionMessageFunctionToolCall(
                             id='call_mock_123457',
                             function=Function(
                                 arguments='{ \
@@ -314,7 +314,7 @@ def test_chat_agent_step_with_external_tools(step_call_count=3):
                     audio=None,
                     function_call=None,
                     tool_calls=[
-                        ChatCompletionMessageToolCall(
+                        ChatCompletionMessageFunctionToolCall(
                             id='call_mock_123456',
                             function=Function(
                                 arguments='{"a":1776,"b":2007}',
@@ -399,7 +399,7 @@ async def test_chat_agent_astep_with_external_tools(step_call_count=3):
                     audio=None,
                     function_call=None,
                     tool_calls=[
-                        ChatCompletionMessageToolCall(
+                        ChatCompletionMessageFunctionToolCall(
                             id='call_mock_123456',
                             function=Function(
                                 arguments='{ \
@@ -409,7 +409,7 @@ async def test_chat_agent_astep_with_external_tools(step_call_count=3):
                             ),
                             type='function',
                         ),
-                        ChatCompletionMessageToolCall(
+                        ChatCompletionMessageFunctionToolCall(
                             id='call_mock_123457',
                             function=Function(
                                 arguments='{ \
@@ -446,7 +446,7 @@ async def test_chat_agent_astep_with_external_tools(step_call_count=3):
                     audio=None,
                     function_call=None,
                     tool_calls=[
-                        ChatCompletionMessageToolCall(
+                        ChatCompletionMessageFunctionToolCall(
                             id='call_mock_123456',
                             function=Function(
                                 arguments='{"a":1776,"b":2007}',
@@ -906,7 +906,7 @@ def test_tool_calling_sync(step_call_count=3):
                     audio=None,
                     function_call=None,
                     tool_calls=[
-                        ChatCompletionMessageToolCall(
+                        ChatCompletionMessageFunctionToolCall(
                             id='call_mock_123456',
                             function=Function(
                                 arguments='{ \
@@ -918,7 +918,7 @@ def test_tool_calling_sync(step_call_count=3):
                             ),
                             type='function',
                         ),
-                        ChatCompletionMessageToolCall(
+                        ChatCompletionMessageFunctionToolCall(
                             id='call_mock_123457',
                             function=Function(
                                 arguments='{"a": 0, "b": 10}',
@@ -952,7 +952,7 @@ def test_tool_calling_sync(step_call_count=3):
                     audio=None,
                     function_call=None,
                     tool_calls=[
-                        ChatCompletionMessageToolCall(
+                        ChatCompletionMessageFunctionToolCall(
                             id='call_kIJby7Y6As6gAbWoxDqxD6HG',
                             function=Function(
                                 arguments='{"a":16,"b":10}',
@@ -1079,7 +1079,7 @@ async def test_tool_calling_math_async(step_call_count=3):
                     audio=None,
                     function_call=None,
                     tool_calls=[
-                        ChatCompletionMessageToolCall(
+                        ChatCompletionMessageFunctionToolCall(
                             id='call_mock_123456',
                             function=Function(
                                 arguments='{ \
@@ -1186,7 +1186,7 @@ def mock_run_tool_calling_async(*args, **kwargs):
         # Reset tool_calls at the beginning of each new round of step() call
         if model.run.call_count % 2 == 1:
             model_backend_rsp_tool_async.choices[0].message.tool_calls = [
-                ChatCompletionMessageToolCall(
+                ChatCompletionMessageFunctionToolCall(
                     id='call_mock_123456',
                     function=Function(
                         arguments='{"second":1}', name='async_sleep'
diff --git a/test/models/test_sglang_model.py b/test/models/test_sglang_model.py
@@ -99,7 +99,7 @@ def test_sglang_function_call(sglang_model_cleanup):
 
     # Create a mock response object
     from openai.types.chat.chat_completion_message_function_tool_call import (
-        ChatCompletionMessageToolCall,
+        ChatCompletionMessageFunctionToolCall,
     )
 
     from camel.types import (
@@ -122,7 +122,7 @@ def test_sglang_function_call(sglang_model_cleanup):
                     role="assistant",
                     content=None,
                     tool_calls=[
-                        ChatCompletionMessageToolCall(
+                        ChatCompletionMessageFunctionToolCall(
                             id="0",
                             type="function",
                             function={"name": "test_tool", "arguments": "{}"},
diff --git a/test/toolkits/test_dingtalk.py b/test/toolkits/test_dingtalk.py

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@`
`70`	`70`	`Union,`
`71`	`71`	`)`
`72`	`72`
`73`		`-from openai.types.chat import ChatCompletionMessageToolCall`
	`73`	`+from openai.types.chat import ChatCompletionMessageFunctionToolCall`
`74`	`74`	`f`
`75`	`75`	`===============================================================================`
`76`	`76`	`"""`