lionagi 0.2.4__py3-none-any.whl → 0.2.6__py3-none-any.whl

lionagi/core/collections/model.py

@@ -322,6 +322,38 @@ class iModel:
         node.add_field("embedding", embed["data"][0]["embedding"])
         node._meta_insert("embedding_meta", payload)
 
+    async def format_structure(
+        self,
+        data: str | dict,
+        json_schema: dict | str = None,
+        request_fields: dict | list = None,
+        **kwargs,
+    ) -> dict:
+        if json_schema:
+            kwargs["response_format"] = {
+                "type": "json_schema",
+                "json_schema": json_schema,
+            }
+            kwargs["model"] = kwargs.pop("model", "gpt-4o-mini")
+        if not request_fields and not json_schema:
+            raise ValueError("Either request_fields or json_schema must be provided")
+        request_fields = request_fields or json_schema["properties"]
+
+        messages = [
+            {
+                "role": "system",
+                "content": "You are a helpful json formatting assistant.",
+            },
+            {
+                "role": "user",
+                "content": f"can you please format the given data into given json schema?"
+                f"--- data --- {data} |||| ----json fields required --- {request_fields}",
+            },
+        ]
+
+        result = await self.call_chat_completion(messages, **kwargs)
+        return result["choices"][0]["message"]["content"]
+
     def to_dict(self):
         """
         Converts the model instance to a dictionary representation.

lionagi/core/engine/branch_engine.py

@@ -57,7 +57,10 @@ class BranchExecutor(Branch, BaseExecutor):
                     await self._process_condition(mail)
                 elif mail.category == "end":
                     self._process_end(mail)
-            if key in self.mailbox.pending_ins and self.mailbox.pending_ins.get(key, Pile()).size() == 0:
+            if (
+                key in self.mailbox.pending_ins
+                and self.mailbox.pending_ins.get(key, Pile()).size() == 0
+            ):
                 self.mailbox.pending_ins.pop(key)
 
     async def execute(self, refresh_time=1) -> None:

lionagi/core/generic/graph.py

@@ -202,7 +202,9 @@ class Graph(Node):
 
         return g
 
-    def display(self, node_label="class_name", edge_label="label", draw_kwargs={}, **kwargs):
+    def display(
+        self, node_label="class_name", edge_label="label", draw_kwargs={}, **kwargs
+    ):
         """Display the graph using NetworkX and Matplotlib."""
         from lionagi.libs import SysUtil
 
@@ -224,7 +226,7 @@ class Graph(Node):
             node_color="orange",
             alpha=0.9,
             labels=nx.get_node_attributes(g, node_label),
-            **draw_kwargs
+            **draw_kwargs,
         )
 
         labels = nx.get_edge_attributes(g, edge_label)

lionagi/core/generic/node.py

@@ -124,7 +124,7 @@ class Node(Component, Relatable):
         label: str | None = None,
         bundle: bool = False,
         edge_class: Callable = Edge,
-        **kwargs
+        **kwargs,
     ) -> None:
         """
         Establish directed relationship from this node to another.
@@ -150,7 +150,7 @@ class Node(Component, Relatable):
             condition=condition,
             bundle=bundle,
             label=label,
-            **kwargs
+            **kwargs,
         )
 
         self.relations[direction].include(edge)

lionagi/core/session/directive_mixin.py

@@ -51,6 +51,10 @@ class DirectiveMixin:
         return_branch=False,
         images=None,
         image_path=None,
+        template=None,
+        verbose=True,
+        formatter=None,
+        format_kwargs=None,
         **kwargs,
     ):
         """
@@ -114,7 +118,15 @@ class DirectiveMixin:
             >>> print(result)
         """
 
-        directive = Unit(self, imodel=imodel, rulebook=rulebook)
+        directive = Unit(
+            self,
+            imodel=imodel,
+            rulebook=rulebook,
+            template=template,
+            verbose=verbose,
+            formatter=formatter,
+            format_kwargs=format_kwargs,
+        )
         if system:
             self.add_message(system=system)
 
@@ -174,7 +186,10 @@ class DirectiveMixin:
         directive=None,
         images=None,
         image_path=None,
-        verbose=False,
+        template=None,
+        verbose=True,
+        formatter=None,
+        format_kwargs=None,
         **kwargs,
     ):
         """
@@ -220,7 +235,14 @@ class DirectiveMixin:
 
             images = ImageUtil.read_image_to_base64(image_path)
 
-        _directive = Unit(self, imodel=imodel, rulebook=rulebook, verbose=verbose)
+        _directive = Unit(
+            self,
+            imodel=imodel,
+            rulebook=rulebook,
+            verbose=verbose,
+            formatter=formatter,
+            format_kwargs=format_kwargs,
+        )
 
         idx = len(self.progress)
         if directive and isinstance(directive, str):
@@ -232,6 +254,7 @@ class DirectiveMixin:
                 reason=reason,
                 confidence=confidence,
                 images=images,
+                template=template,
                 **kwargs,
             )
 
@@ -248,7 +271,7 @@ class DirectiveMixin:
                 form.action_response.update(_dict)
 
             return form
-        
+
         form = await _directive.direct(
             instruction=instruction,
             context=context,
@@ -269,6 +292,7 @@ class DirectiveMixin:
             plan_num_step=plan_num_step,
             predict_num_sentences=predict_num_sentences,
             images=images,
+            template=template,
             **kwargs,
         )
 
@@ -283,5 +307,5 @@ class DirectiveMixin:
             if not hasattr(form, "action_response"):
                 form.append_to_request("action_response", {})
             form.action_response.update(_dict)
-        
+
         return form

lionagi/core/unit/unit.py

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 """
 
+from typing import Callable
 from lionagi.libs.ln_convert import strip_lower
 from lionagi.libs.ln_func_call import rcall
 from lionagi.core.collections.abc import Directive
@@ -40,7 +41,14 @@ class Unit(Directive, DirectiveMixin):
     default_template = UnitForm
 
     def __init__(
-        self, branch, imodel: iModel = None, template=None, rulebook=None, verbose=False
+        self,
+        branch,
+        imodel: iModel = None,
+        template=None,
+        rulebook=None,
+        verbose=False,
+        formatter: Callable = None,
+        format_kwargs: dict = {},
     ) -> None:
         self.branch = branch
         if imodel and isinstance(imodel, iModel):
@@ -49,7 +57,11 @@ class Unit(Directive, DirectiveMixin):
         else:
             self.imodel = branch.imodel
         self.form_template = template or self.default_template
-        self.validator = Validator(rulebook=rulebook) if rulebook else Validator()
+        rule_config = {"formatter": formatter, "format_kwargs": format_kwargs}
+        if rulebook:
+            rule_config["rulebook"] = rulebook
+
+        self.validator = Validator(**rule_config)
         self.verbose = verbose
 
     async def chat(
@@ -71,6 +83,8 @@ class Unit(Directive, DirectiveMixin):
         clear_messages=False,
         use_annotation=True,
         return_branch=False,
+        formatter=None,
+        format_kwargs={},
         **kwargs,
     ):
         """
@@ -119,6 +133,8 @@ class Unit(Directive, DirectiveMixin):
             clear_messages=clear_messages,
             use_annotation=use_annotation,
             return_branch=return_branch,
+            formatter=formatter,
+            format_kwargs=format_kwargs,
             **kwargs,
         )
 

lionagi/core/unit/unit_mixin.py

@@ -257,7 +257,6 @@ class DirectiveMixin(ABC):
         form: Form = None,
         return_form: bool = True,
         strict: bool = False,
-        rulebook: Any = None,
         use_annotation: bool = True,
         template_name: str = None,
         costs=None,
@@ -274,7 +273,6 @@ class DirectiveMixin(ABC):
             form: Form data.
             return_form: Flag indicating if form should be returned.
             strict: Flag indicating if strict validation should be applied.
-            rulebook: Rulebook instance for validation.
             use_annotation: Flag indicating if annotations should be used.
             template_name: Template name for form.
 
@@ -295,8 +293,7 @@ class DirectiveMixin(ABC):
         response_ = self._process_model_response(_msg, requested_fields)
 
         if form:
-            validator = Validator(rulebook=rulebook) if rulebook else self.validator
-            form = await validator.validate_response(
+            form = await self.validator.validate_response(
                 form=form,
                 response=response_,
                 strict=strict,
@@ -332,7 +329,6 @@ class DirectiveMixin(ABC):
         invoke_tool: bool = True,
         return_form: bool = True,
         strict: bool = False,
-        rulebook: Any = None,
         imodel: Any = None,
         use_annotation: bool = True,
         branch: Any = None,
@@ -356,7 +352,6 @@ class DirectiveMixin(ABC):
             invoke_tool: Flag indicating if tools should be invoked.
             return_form: Flag indicating if form should be returned.
             strict: Flag indicating if strict validation should be applied.
-            rulebook: Rulebook instance for validation.
             imodel: Model instance.
             use_annotation: Flag indicating if annotations should be used.
             branch: Branch instance.
@@ -400,9 +395,8 @@ class DirectiveMixin(ABC):
             form=form,
             return_form=return_form,
             strict=strict,
-            rulebook=rulebook,
             use_annotation=use_annotation,
-            costs=imodel.costs,
+            costs=imodel.costs or (0, 0),
         )
 
         return out_, branch if return_branch else out_
@@ -421,13 +415,14 @@ class DirectiveMixin(ABC):
         invoke_tool=True,
         return_form=True,
         strict=False,
-        rulebook=None,
         imodel=None,
         images: Optional[str] = None,
         clear_messages=False,
         use_annotation=True,
         timeout: float = None,
         return_branch=False,
+        formatter=None,
+        format_kwargs={},
         **kwargs,
     ):
         """
@@ -470,13 +465,14 @@ class DirectiveMixin(ABC):
             invoke_tool=invoke_tool,
             return_form=return_form,
             strict=strict,
-            rulebook=rulebook,
             imodel=imodel,
             use_annotation=use_annotation,
             timeout=timeout,
             branch=branch,
             clear_messages=clear_messages,
             return_branch=return_branch,
+            formatter=formatter,
+            format_kwargs=format_kwargs,
             **kwargs,
         )
 
@@ -609,7 +605,9 @@ class DirectiveMixin(ABC):
         clear_messages=False,
         return_branch=False,
         images: Optional[str] = None,
-        verbose=None,
+        verbose=True,
+        formatter=None,
+        format_kwargs=None,
         **kwargs,
     ):
         """
@@ -658,7 +656,7 @@ class DirectiveMixin(ABC):
         if allow_action and not tools:
             tools = True
 
-        tool_schema=None
+        tool_schema = None
         if tools:
             tool_schema = branch.tool_manager.get_tool_schema(tools)
 

lionagi/core/validator/validator.py

@@ -14,10 +14,12 @@ See the License for the specific language governing permissions and
 limitations under the License.
 """
 
-from typing import Any, Dict, List, Union
+import asyncio
+from typing import Any, Dict, List, Union, Callable
 from lionagi.libs import SysUtil
 from lionagi.libs.ln_func_call import lcall
 from lionagi.core.collections.abc import FieldError
+from lionagi.core.collections.model import iModel
 from ..rule.base import Rule
 from ..rule._default import DEFAULT_RULES
 from ..rule.rulebook import RuleBook
@@ -56,6 +58,8 @@ class Validator:
         order: List[str] = None,
         init_config: Dict[str, Dict] = None,
         active_rules: Dict[str, Rule] = None,
+        formatter: Callable = None,
+        format_kwargs: dict = {},
     ):
         """
         Initialize the Validator.
@@ -75,6 +79,8 @@ class Validator:
         )
         self.active_rules: Dict[str, Rule] = active_rules or self._initiate_rules()
         self.validation_log = []
+        self.formatter = formatter
+        self.format_kwargs = format_kwargs
 
     def _initiate_rules(self) -> Dict[str, Rule]:
         """
@@ -207,9 +213,16 @@ class Validator:
             if len(form.requested_fields) == 1:
                 response = {form.requested_fields[0]: response}
             else:
-                raise ValueError(
-                    "Response is a string, but form has multiple fields to be filled"
-                )
+                if self.formatter:
+                    if asyncio.iscoroutinefunction(self.formatter):
+                        response = await self.formatter(response, **self.format_kwargs)
+                        print("formatter used")
+                    else:
+                        response = self.formatter(response, **self.format_kwargs)
+                        print("formatter used")
+
+        if not isinstance(response, dict):
+            raise ValueError(f"The form response format is invalid for filling.")
 
         dict_ = {}
         for k, v in response.items():

lionagi/core/work/work_edge.py

@@ -21,19 +21,19 @@ class WorkEdge(Edge, Progressable):
             other than "from_work" and "from_result".
         associated_worker (Worker): The worker to which this WorkEdge belongs.
     """
+
     convert_function: Callable = Field(
         ...,
-        description="Function to transform the result of the previous work into parameters for the next work."
+        description="Function to transform the result of the previous work into parameters for the next work.",
     )
 
     convert_function_kwargs: dict = Field(
         {},
-        description="parameters for the worklink function other than \"from_work\" and \"from_result\""
+        description='parameters for the worklink function other than "from_work" and "from_result"',
     )
 
     associated_worker: Worker = Field(
-        ...,
-        description="The worker to which this WorkEdge belongs."
+        ..., description="The worker to which this WorkEdge belongs."
     )
 
     @field_validator("convert_function", mode="before")
@@ -81,8 +81,10 @@ class WorkEdge(Edge, Progressable):
             StopIteration: If the task has no available steps left to proceed.
         """
         if task.available_steps == 0:
-            task.status_note = ("Task stopped proceeding further as all available steps have been used up, "
-                                "but the task has not yet reached completion.")
+            task.status_note = (
+                "Task stopped proceeding further as all available steps have been used up, "
+                "but the task has not yet reached completion."
+            )
             return
         func_signature = inspect.signature(self.convert_function)
         kwargs = self.convert_function_kwargs.copy()

lionagi/core/work/work_function.py

@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 """
+
 import asyncio
 import logging
 
@@ -33,7 +34,13 @@ class WorkFunction:
     """
 
     def __init__(
-        self, assignment, function, retry_kwargs=None, guidance=None, capacity=10, refresh_time=1
+        self,
+        assignment,
+        function,
+        retry_kwargs=None,
+        guidance=None,
+        capacity=10,
+        refresh_time=1,
     ):
         """
         Initializes a WorkFunction instance.
@@ -69,11 +76,11 @@ class WorkFunction:
     @property
     def execution_mode(self):
         """
-         Gets the execution mode of the work function's queue.
+        Gets the execution mode of the work function's queue.
 
-         Returns:
-             bool: The execution mode of the work function's queue.
-         """
+        Returns:
+            bool: The execution mode of the work function's queue.
+        """
         return self.worklog.queue.execution_mode
 
     def is_progressable(self):
@@ -121,4 +128,4 @@ class WorkFunction:
         """
         Stops the execution of the work function's queue.
         """
-        await self.worklog.stop()
+        await self.worklog.stop()

lionagi/core/work/work_function_node.py

@@ -21,7 +21,16 @@ class WorkFunctionNode(WorkFunction, Node):
         refresh_time (int): The time interval to refresh the work log queue.
     """
 
-    def __init__(self, assignment, function, retry_kwargs=None, guidance=None, capacity=10, refresh_time=1, **kwargs):
+    def __init__(
+        self,
+        assignment,
+        function,
+        retry_kwargs=None,
+        guidance=None,
+        capacity=10,
+        refresh_time=1,
+        **kwargs,
+    ):
         """
         Initializes a WorkFunctionNode instance.
 
@@ -35,10 +44,12 @@ class WorkFunctionNode(WorkFunction, Node):
             **kwargs: Additional keyword arguments for the Node initialization.
         """
         Node.__init__(self, **kwargs)
-        WorkFunction.__init__(self,
-                              assignment=assignment,
-                              function=function,
-                              retry_kwargs=retry_kwargs,
-                              guidance=guidance,
-                              capacity=capacity,
-                              refresh_time=refresh_time)
+        WorkFunction.__init__(
+            self,
+            assignment=assignment,
+            function=function,
+            retry_kwargs=retry_kwargs,
+            guidance=guidance,
+            capacity=capacity,
+            refresh_time=refresh_time,
+        )

lionagi/core/work/work_queue.py

@@ -90,11 +90,11 @@ class WorkQueue:
 
     async def execute(self):
         """
-            Continuously executes the process method at a specified refresh interval.
+        Continuously executes the process method at a specified refresh interval.
 
-            Args:
-                refresh_time (int, optional): The time in seconds to wait between
-                    successive calls to `process`. Defaults to 1.
+        Args:
+            refresh_time (int, optional): The time in seconds to wait between
+                successive calls to `process`. Defaults to 1.
         """
         self.execution_mode = True
         self._stop_event.clear()

lionagi/core/work/work_task.py

@@ -20,39 +20,24 @@ class WorkTask(Component):
         current_work (Work | None): The current work in progress.
         post_processing (Callable | None): The post-processing function to be executed after the entire task is successfully completed.
     """
-    name: str | None = Field(
-        None,
-        description="Name of the task"
-    )
+
+    name: str | None = Field(None, description="Name of the task")
 
     status: WorkStatus = Field(
-        WorkStatus.PENDING,
-        description="The current status of the task"
+        WorkStatus.PENDING, description="The current status of the task"
     )
 
-    status_note: str = Field(
-        None,
-        description="Note for tasks current status"
-    )
+    status_note: str = Field(None, description="Note for tasks current status")
 
-    work_history: list[Work] = Field(
-        [],
-        description="List of works processed"
-    )
+    work_history: list[Work] = Field([], description="List of works processed")
 
-    max_steps: int | None = Field(
-        10,
-        description="Maximum number of works allowed"
-    )
+    max_steps: int | None = Field(10, description="Maximum number of works allowed")
 
-    current_work: Work | None = Field(
-        None,
-        description="The current work in progress"
-    )
+    current_work: Work | None = Field(None, description="The current work in progress")
 
     post_processing: Callable | None = Field(
         None,
-        description="The post-processing function to be executed after the entire task has been successfully completed."
+        description="The post-processing function to be executed after the entire task has been successfully completed.",
     )
 
     @field_validator("max_steps", mode="before")
@@ -108,7 +93,12 @@ class WorkTask(Component):
         Returns:
             WorkTask: A new instance of WorkTask with the same attributes.
         """
-        new_worktask = WorkTask(name=self.name, status=self.status, max_steps=self.max_steps, current_work=self.current_work)
+        new_worktask = WorkTask(
+            name=self.name,
+            status=self.status,
+            max_steps=self.max_steps,
+            current_work=self.current_work,
+        )
         for work in self.work_history:
             new_worktask.work_history.append(work)
         return new_worktask