Resolve pydantic v1 conflict (camel-ai#434)

Co-authored-by: lig <[email protected]>

Author: ocss884

camel/functions/openai_function.py

@@ -18,9 +18,10 @@
 from jsonschema.exceptions import SchemaError
 from jsonschema.validators import Draft202012Validator as JSONValidator
 from pydantic import ValidationError, create_model
-from pydantic.alias_generators import to_pascal
 from pydantic.fields import FieldInfo
 
+from camel.utils import PYDANTIC_V2, to_pascal
+
 
 def _remove_a_key(d: Dict, remove_key: Any) -> None:
     r"""Remove a key from a dictionary recursively."""
@@ -107,8 +108,13 @@ def _create_mol(name, field):
         return create_model(name, **field)
 
     model = _create_mol(to_pascal(func.__name__), fields)
-    parameters_dict = model.model_json_schema()
-    # The "title" is generated by model.model_json_schema()
+    # NOTE: Method `.schema()` is deprecated in pydantic v2.
+    # the result would be identical to `.model_json_schema()` in v2
+    if PYDANTIC_V2:
+        parameters_dict = model.model_json_schema()  # type: ignore
+    else:
+        parameters_dict = model.schema()  # type: ignore
+    # The `"title"` is generated by `model.model_json_schema()`
     # but is useless for openai json schema
     _remove_a_key(parameters_dict, "title")
 
@@ -190,10 +196,23 @@ def validate_openai_tool_schema(
         # Automatically validates whether the openai_tool_schema passed
         # complies with the specifications of the ToolAssistantToolsFunction.
         from openai.types.beta.threads.run import ToolAssistantToolsFunction
-        try:
-            ToolAssistantToolsFunction.model_validate(openai_tool_schema)
-        except ValidationError as e:
-            raise e
+
+        # NOTE: Pydantic v1 does not have a strict mode to check input types
+        # Below is a compromise solution.
+        # refs: https://docs.pydantic.dev/1.10/blog/pydantic-v2/#strict-mode
+        if PYDANTIC_V2:
+            try:
+                ToolAssistantToolsFunction.model_validate(  # type: ignore
+                    openai_tool_schema)
+            except ValidationError as e:
+                raise e
+        elif ToolAssistantToolsFunction(
+                **openai_tool_schema) != openai_tool_schema:
+            raise ValidationError(  # type: ignore
+                errors="Validation error for `ToolAssistantToolsFunction`."
+                "Please check the input data types.",
+                model=ToolAssistantToolsFunction,
+            )
         # Check the function description
         if not openai_tool_schema["function"]["description"]:
             raise ValueError("miss function description")

camel/utils/__init__.py

@@ -20,6 +20,8 @@
     get_task_list,
     check_server_running,
     get_system_information,
+    to_pascal,
+    PYDANTIC_V2,
 )
 from .token_counting import (
     get_model_encoding,
@@ -37,6 +39,8 @@
     'get_task_list',
     'check_server_running',
     'get_system_information',
+    'to_pascal',
+    'PYDANTIC_V2',
     'get_model_encoding',
     'BaseTokenCounter',
     'OpenAITokenCounter',

camel/utils/commons.py

@@ -21,6 +21,7 @@
 from typing import Any, Callable, List, Optional, Set, TypeVar, cast
 from urllib.parse import urlparse
 
+import pydantic
 import requests
 
 from camel.types import TaskType
@@ -198,3 +199,30 @@ def get_system_information():
     }
 
     return sys_info
+
+
+def to_pascal(snake: str) -> str:
+    """Convert a snake_case string to PascalCase.
+
+    Args:
+        snake (str): The snake_case string to be converted.
+
+    Returns:
+        str: The converted PascalCase string.
+    """
+    # Check if the string is already in PascalCase
+    if re.match(r'^[A-Z][a-zA-Z0-9]*([A-Z][a-zA-Z0-9]*)*$', snake):
+        return snake
+    # Remove leading and trailing underscores
+    snake = snake.strip('_')
+    # Replace multiple underscores with a single one
+    snake = re.sub('_+', '_', snake)
+    # Convert to PascalCase
+    return re.sub(
+        '_([0-9A-Za-z])',
+        lambda m: m.group(1).upper(),
+        snake.title(),
+    )
+
+
+PYDANTIC_V2 = pydantic.VERSION.startswith("2.")