small enhancement based on review comment

camel/schemas/base.py

@@ -15,8 +15,6 @@
 from abc import ABC, abstractmethod
 from typing import Any, Dict
 
-from pydantic import BaseModel
-
 
 class BaseConverter(ABC):
     r"""A base class for schema outputs that includes functionality
@@ -30,7 +28,7 @@ class BaseConverter(ABC):
     @abstractmethod
     def convert(
         self, content: str, *args: Any, **kwargs: Dict[str, Any]
-    ) -> BaseModel:
+    ) -> Any:
         r"""Structures the input text into the expected response format.
 
         Args:
@@ -40,6 +38,6 @@ def convert(
             prompt (Optional[str], optional): The prompt to be used.
 
         Returns:
-            Optional[BaseModel]: The structured response.
+           Any: The converted response.
         """
         pass

camel/schemas/outlines_converter.py

@@ -14,7 +14,6 @@
 
 from typing import Any, Callable, List, Literal, Type, Union
 
-import outlines
 from pydantic import BaseModel
 
 from .base import BaseConverter
@@ -65,7 +64,7 @@ def __init__(
             case _:
                 raise ValueError(f"Unsupported platform: {platform}")
 
-    def convert_regex(self, content: str, regex_pattern: str):
+    def convert_regex(self, content: str, regex_pattern: str) -> str:
         r"""Convert the content to the specified regex pattern.
 
         Args:
@@ -75,6 +74,8 @@ def convert_regex(self, content: str, regex_pattern: str):
         Returns:
             str: The converted content.
         """
+        import outlines
+
         regex_generator = outlines.generate.regex(
             self._outlines_model, regex_pattern
         )
@@ -96,6 +97,8 @@ def convert_json(
         Returns:
             dict: The converted content in JSON format.
         """
+        import outlines
+
         json_generator = outlines.generate.json(
             self._outlines_model, output_schema
         )
@@ -116,12 +119,14 @@ def convert_pydantic(
         Returns:
             BaseModel: The converted content in pydantic model format.
         """
+        import outlines
+
         json_generator = outlines.generate.json(
             self._outlines_model, output_schema
         )
         return json_generator(content)
 
-    def convert_type(self, content: str, type_name: type):
+    def convert_type(self, content: str, type_name: type) -> str:
         r"""Convert the content to the specified type.
 
         The following types are currently available:
@@ -140,12 +145,14 @@ def convert_type(self, content: str, type_name: type):
         Returns:
             str: The converted content.
         """
+        import outlines
+
         type_generator = outlines.generate.format(
             self._outlines_model, type_name
         )
         return type_generator(content)
 
-    def convert_choice(self, content: str, choices: List[str]):
+    def convert_choice(self, content: str, choices: List[str]) -> str:
         r"""Convert the content to the specified choice.
 
         Args:
@@ -155,12 +162,14 @@ def convert_choice(self, content: str, choices: List[str]):
         Returns:
             str: The converted content.
         """
+        import outlines
+
         choices_generator = outlines.generate.choice(
             self._outlines_model, choices
         )
         return choices_generator(content)
 
-    def convert_grammar(self, content: str, grammar: str):
+    def convert_grammar(self, content: str, grammar: str) -> str:
         r"""Convert the content to the specified grammar.
 
         Args:
@@ -170,17 +179,19 @@ def convert_grammar(self, content: str, grammar: str):
         Returns:
             str: The converted content.
         """
+        import outlines
+
         grammar_generator = outlines.generate.cfg(
             self._outlines_model, grammar
         )
         return grammar_generator(content)
 
     def convert(  # type: ignore[override]
         self,
-        type: Literal["regex", "json", "type", "choice", "grammar"],
         content: str,
+        type: Literal["regex", "json", "type", "choice", "grammar"],
         **kwargs,
-    ):
+    ) -> Any:
         r"""Formats the input content into the expected BaseModel.
 
         Args:

examples/schema_outputs/outlines-converter-example.py → examples/schema_outputs/outlines_converter_example.py

@@ -29,11 +29,11 @@
 )
 
 print(output)
-'''
+"""
 ===============================================================================
 6:00 pm
 ===============================================================================
-'''
+"""
 
 
 ######## Pydantic conversion #########
@@ -52,17 +52,17 @@ class Temperature(BaseModel):
 )
 
 print(type(output))
-'''
+"""
 ===============================================================================
 <class '__main__.Temperature'>
 ===============================================================================
-'''
+"""
 print(output)
-'''
+"""
 ===============================================================================
 location='Beijing' date='2023-09-01' temperature=30.0
 ===============================================================================
-'''
+"""
 
 
 ######## JSON conversion #########
@@ -87,17 +87,17 @@ class Temperature(BaseModel):
     output_schema=schema,
 )
 print(type(output))
-'''
+"""
 ===============================================================================
 <class 'dict'>
 ===============================================================================
-'''
+"""
 print(output)
-'''
+"""
 ===============================================================================
 {'name': 'John', 'last_name': 'Doe', 'id': 123456}
 ===============================================================================
-'''
+"""
 
 # 2. Using a function (Callable)
 
@@ -112,17 +112,17 @@ def get_temperature(location: str, date: str, temperature: float):
 )
 
 print(type(output))
-'''
+"""
 ===============================================================================
 <class 'dict'>
 ===============================================================================
-'''
+"""
 print(output)
-'''
+"""
 ===============================================================================
 {'location': 'Beijing', 'date': '2023-09-01', 'temperature': 30}
 ===============================================================================
-'''
+"""
 
 
 ######## Type constraints #########
@@ -133,11 +133,11 @@ def get_temperature(location: str, date: str, temperature: float):
 )
 
 print(output)
-'''
+"""
 ===============================================================================
 35
 ===============================================================================
-'''
+"""
 
 
 ######## Mutliple choices #########
@@ -148,11 +148,11 @@ def get_temperature(location: str, date: str, temperature: float):
 )
 
 print(output)
-'''
+"""
 ===============================================================================
 Madrid
 ===============================================================================
-'''
+"""
 
 
 ######## Grammer #########
@@ -178,8 +178,8 @@ def get_temperature(location: str, date: str, temperature: float):
 )
 
 print(output)
-'''
+"""
 ===============================================================================
 (8-2)
 ===============================================================================
-'''
+"""