fabricatio 0.2.4.dev1__tar.gz → 0.2.4.dev2__tar.gz

{fabricatio-0.2.4.dev1 → fabricatio-0.2.4.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.2.4.dev1
+Version: 0.2.4.dev2
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3.12

{fabricatio-0.2.4.dev1 → fabricatio-0.2.4.dev2}/examples/llm_usages/llm_usage.py

@@ -11,7 +11,6 @@ from fabricatio.parser import PythonCapture
 class WriteCode(Action):
     """Action that says hello to the world."""
 
-    name: str = "write code"
     output_key: str = "task_output"
 
     async def _execute(self, task_input: Task[str], **_) -> str:
@@ -22,10 +21,8 @@ class WriteCode(Action):
 
 
 class WriteDocumentation(Action):
-    """Action that says hello to the world."""
+    """write documentation for the code in markdown format."""
 
-    name: str = "write documentation"
-    description: str = "write documentation for the code in markdown format"
     output_key: str = "task_output"
 
     async def _execute(self, task_input: Task[str], **_) -> str:
@@ -38,12 +35,8 @@ async def main() -> None:
         name="Coder",
         description="A python coder who can write code and documentation",
         registry={
-            Event.instantiate_from("coding").push_wildcard().push("pending"): WorkFlow(
-                name="write code", steps=(WriteCode,)
-            ),
-            Event.instantiate_from("doc").push_wildcard().push("pending"): WorkFlow(
-                name="write documentation", steps=(WriteDocumentation,)
-            ),
+            Event.quick_instantiate("coding"): WorkFlow(name="write code", steps=(WriteCode,)),
+            Event.quick_instantiate("doc"): WorkFlow(name="write documentation", steps=(WriteDocumentation,)),
         },
     )
 

{fabricatio-0.2.4.dev1 → fabricatio-0.2.4.dev2}/examples/make_a_rating/rating.py

@@ -12,7 +12,6 @@ from fabricatio.models.task import Task
 class Rate(Action):
     """Rate the task."""
 
-    name: str = "rate"
     output_key: str = "task_output"
 
     async def _execute(self, to_rate: List[str], rate_topic: str, criteria: Set[str], **_) -> List[Dict[str, float]]:
@@ -28,8 +27,6 @@ class Rate(Action):
 class WhatToRate(Action):
     """Figure out what to rate."""
 
-    name: str = "figure out what to rate"
-
     output_key: str = "to_rate"
 
     async def _execute(self, task_input: Task, rate_topic: str, **cxt: Unpack) -> List[str]:
@@ -55,7 +52,6 @@ class WhatToRate(Action):
 class MakeCriteria(Action):
     """Make criteria for rating."""
 
-    name: str = "make criteria"
     output_key: str = "criteria"
 
     async def _execute(self, rate_topic: str, to_rate: List[str], **cxt: Unpack) -> Set[str]:
@@ -67,8 +63,6 @@ class MakeCriteria(Action):
 class MakeCompositeScore(Action):
     """Make a composite score."""
 
-    name: str = "make composite score"
-
     output_key: str = "task_output"
 
     async def _execute(self, rate_topic: str, to_rate: List[str], **cxt: Unpack) -> List[float]:
@@ -84,7 +78,7 @@ async def main() -> None:
         name="TaskRater",
         description="A role that can rate tasks.",
         registry={
-            Event.instantiate_from("rate_food").push_wildcard().push("pending"): WorkFlow(
+            Event.quick_instantiate("rate_food"): WorkFlow(
                 name="Rate food",
                 steps=(WhatToRate, Rate),
                 extra_init_context={
@@ -92,14 +86,14 @@ async def main() -> None:
                     "criteria": {"taste", "price", "quality", "safety", "healthiness"},
                 },
             ),
-            Event.instantiate_from("make_criteria_for_food").push_wildcard().push("pending"): WorkFlow(
+            Event.quick_instantiate("make_criteria_for_food"): WorkFlow(
                 name="Make criteria for food",
                 steps=(WhatToRate, MakeCriteria, Rate),
                 extra_init_context={
                     "rate_topic": "if the food is 'good'",
                 },
             ),
-            Event.instantiate_from("make_composite_score").push_wildcard().push("pending"): WorkFlow(
+            Event.quick_instantiate("make_composite_score"): WorkFlow(
                 name="Make composite score",
                 steps=(WhatToRate, MakeCompositeScore),
                 extra_init_context={

{fabricatio-0.2.4.dev1 → fabricatio-0.2.4.dev2}/examples/make_diary/diary.py

@@ -13,8 +13,6 @@ from pydantic import Field
 class WriteDiary(Action):
     """Write a diary according to the given commit messages in json format."""
 
-    name: str = "write diary"
-    description: str = "write a diary according to the given commit messages in json format"
     output_key: str = "dump_text"
 
     async def _execute(self, task_input: Task[str], **_) -> str:
@@ -50,8 +48,6 @@ class WriteDiary(Action):
 class DumpText(Action):
     """Dump the text to a file."""
 
-    name: str = "dump text"
-    description: str = "dump text to a file"
     toolboxes: Set[ToolBox] = Field(default_factory=lambda: {fs_toolbox})
     output_key: str = "task_output"
 
@@ -77,9 +73,7 @@ async def main() -> None:
         name="Coder",
         description="A python coder who can ",
         registry={
-            Event.instantiate_from("doc").push_wildcard().push("pending"): WorkFlow(
-                name="write documentation", steps=(WriteDiary, DumpText)
-            ),
+            Event.quick_instantiate("doc"): WorkFlow(name="write documentation", steps=(WriteDiary, DumpText)),
         },
     )
 

{fabricatio-0.2.4.dev1 → fabricatio-0.2.4.dev2}/examples/minor/hello_fabricatio.py

@@ -11,7 +11,6 @@ task = Task(name="say hello", goals=["say hello"], description="say hello to the
 class Hello(Action):
     """Action that says hello."""
 
-    name: str = "hello"
     output_key: str = "task_output"
 
     async def _execute(self, task_input: Task[str], **_) -> Any:

{fabricatio-0.2.4.dev1 → fabricatio-0.2.4.dev2}/examples/propose_task/propose.py

@@ -9,7 +9,6 @@ from fabricatio import Action, Event, Role, Task, WorkFlow, logger
 class Talk(Action):
     """Action that says hello to the world."""
 
-    name: str = "talk"
     output_key: str = "task_output"
 
     async def _execute(self, **_) -> Any:

{fabricatio-0.2.4.dev1 → fabricatio-0.2.4.dev2}/examples/simple_chat/chat.py

@@ -10,7 +10,6 @@ from questionary import text
 class Talk(Action):
     """Action that says hello to the world."""
 
-    name: str = "talk"
     output_key: str = "task_output"
 
     async def _execute(self, task_input: Task[str], **_) -> int:

{fabricatio-0.2.4.dev1 → fabricatio-0.2.4.dev2}/examples/simple_rag/simple_rag.py

@@ -10,7 +10,6 @@ from questionary import text
 class Talk(Action, RAG):
     """Action that says hello to the world."""
 
-    name: str = "talk"
     output_key: str = "task_output"
 
     async def _execute(self, task_input: Task[str], **_) -> int:

{fabricatio-0.2.4.dev1 → fabricatio-0.2.4.dev2}/examples/task_handle/handle_task.py

@@ -10,7 +10,6 @@ from pydantic import Field
 class WriteCode(Action):
     """Action that says hello to the world."""
 
-    name: str = "write code"
     output_key: str = "dump_text"
 
     async def _execute(self, task_input: Task[str], **_) -> str:
@@ -24,8 +23,6 @@ class WriteCode(Action):
 class DumpText(Action):
     """Dump the text to a file."""
 
-    name: str = "dump text"
-    description: str = "dump text to a file"
     toolboxes: Set[ToolBox] = Field(default_factory=lambda: {fs_toolbox})
     output_key: str = "task_output"
 
@@ -48,8 +45,6 @@ class DumpText(Action):
 class WriteDocumentation(Action):
     """Action that says hello to the world."""
 
-    name: str = "write documentation"
-    description: str = "write documentation for the code in markdown format"
     output_key: str = "dump_text"
 
     async def _execute(self, task_input: Task[str], **_) -> str:
@@ -59,8 +54,6 @@ class WriteDocumentation(Action):
 class TestCancel(Action):
     """Action that says hello to the world."""
 
-    name: str = "cancel"
-    description: str = "cancel the task"
     output_key: str = "counter"
 
     async def _execute(self, counter: int, **_) -> int:
@@ -73,7 +66,6 @@ class TestCancel(Action):
 class WriteToOutput(Action):
     """Action that says hello to the world."""
 
-    name: str = "write to output"
     output_key: str = "task_output"
 
     async def _execute(self, **_) -> str:
@@ -86,13 +78,9 @@ async def main() -> None:
         name="Coder",
         description="A python coder who can ",
         registry={
-            Event.instantiate_from("coding").push_wildcard().push("pending"): WorkFlow(
-                name="write code", steps=(WriteCode, DumpText)
-            ),
-            Event.instantiate_from("doc").push_wildcard().push("pending"): WorkFlow(
-                name="write documentation", steps=(WriteDocumentation, DumpText)
-            ),
-            Event.instantiate_from("cancel_test").push_wildcard().push("pending"): WorkFlow(
+            Event.quick_instantiate("coding"): WorkFlow(name="write code", steps=(WriteCode, DumpText)),
+            Event.quick_instantiate("doc"): WorkFlow(name="write documentation", steps=(WriteDocumentation, DumpText)),
+            Event.quick_instantiate("cancel_test"): WorkFlow(
                 name="cancel_test",
                 steps=(TestCancel, TestCancel, TestCancel, TestCancel, TestCancel, TestCancel, WriteToOutput),
                 extra_init_context={"counter": 0},

{fabricatio-0.2.4.dev1 → fabricatio-0.2.4.dev2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fabricatio"
-version = "0.2.4-dev1"
+version = "0.2.4-dev2"
 description = "A LLM multi-agent framework."
 readme = "README.md"
 license = { file = "LICENSE" }

{fabricatio-0.2.4.dev1 → fabricatio-0.2.4.dev2}/python/fabricatio/__init__.py

@@ -3,7 +3,7 @@
 from importlib.util import find_spec
 
 from fabricatio._rust_instances import template_manager
-from fabricatio.actions import ExtractArticleEssence
+from fabricatio.actions.article import ExtractArticleEssence
 from fabricatio.core import env
 from fabricatio.fs import magika
 from fabricatio.journal import logger
@@ -44,6 +44,8 @@ __all__ = [
 
 
 if find_spec("pymilvus"):
+    from fabricatio.actions.rag import InjectToDB
     from fabricatio.capabilities.rag import RAG
+    from fabricatio.workflows.articles import StoreArticle
 
-    __all__ += ["RAG"]
+    __all__ += ["RAG", "InjectToDB", "StoreArticle"]

{fabricatio-0.2.4.dev1 → fabricatio-0.2.4.dev2}/python/fabricatio/actions/article.py

@@ -11,11 +11,16 @@ from fabricatio.models.task import Task
 
 
 class ExtractArticleEssence(Action):
-    """Extract the essence of article(s)."""
+    """Extract the essence of article(s) in text format from the paths specified in the task dependencies.
+
+    Notes:
+        This action is designed to extract vital information from articles with Markdown format, which is pure text, and
+        which is converted from pdf files using `magic-pdf` from the `MinerU` project, see https://github.com/opendatalab/MinerU
+    """
 
     name: str = "extract article essence"
     """The name of the action."""
-    description: str = "Extract the essence of an article. output as json"
+    description: str = "Extract the essence of article(s) from the paths specified in the task dependencies."
     """The description of the action."""
 
     output_key: str = "article_essence"

fabricatio-0.2.4.dev2/python/fabricatio/actions/rag.py

@@ -0,0 +1,25 @@
+"""Inject data into the database."""
+
+from typing import List, Optional, Unpack
+
+from fabricatio.capabilities.rag import RAG
+from fabricatio.models.action import Action
+from fabricatio.models.generic import PrepareVectorization
+
+
+class InjectToDB(Action, RAG):
+    """Inject data into the database."""
+
+    output_key: str = "collection_name"
+
+    async def _execute[T: PrepareVectorization](
+        self, to_inject: T | List[T], collection_name: Optional[str] = "my_collection", **cxt: Unpack
+    ) -> str:
+        if not isinstance(to_inject, list):
+            to_inject = [to_inject]
+
+        await self.view(collection_name, create=True).consume_string(
+            [t.prepare_vectorization(self.embedding_max_sequence_length) for t in to_inject],
+        )
+
+        return collection_name

fabricatio-0.2.4.dev2/python/fabricatio/fs/__init__.py

@@ -0,0 +1,17 @@
+"""FileSystem manipulation module for Fabricatio."""
+
+from fabricatio.fs.curd import copy_file, create_directory, delete_directory, delete_file, dump_text, move_file, tree
+from fabricatio.fs.readers import magika, safe_json_read, safe_text_read
+
+__all__ = [
+    "copy_file",
+    "create_directory",
+    "delete_directory",
+    "delete_file",
+    "dump_text",
+    "magika",
+    "move_file",
+    "safe_json_read",
+    "safe_text_read",
+    "tree",
+]

{fabricatio-0.2.4.dev1 → fabricatio-0.2.4.dev2}/python/fabricatio/models/action.py

@@ -3,7 +3,7 @@
 import traceback
 from abc import abstractmethod
 from asyncio import Queue, create_task
-from typing import Any, Dict, Self, Tuple, Type, Union, Unpack
+from typing import Any, Dict, Self, Tuple, Type, Union, Unpack, final
 
 from fabricatio.capabilities.rating import GiveRating
 from fabricatio.capabilities.task import HandleTask, ProposeTask
@@ -17,11 +17,26 @@ from pydantic import Field, PrivateAttr
 class Action(HandleTask, ProposeTask, GiveRating):
     """Class that represents an action to be executed in a workflow."""
 
+    name: str = Field(default="")
+    """The name of the action."""
+    description: str = Field(default="")
+    """The description of the action."""
     personality: str = Field(default="")
     """The personality of whom the action belongs to."""
     output_key: str = Field(default="")
     """The key of the output data."""
 
+    @final
+    def model_post_init(self, __context: Any) -> None:
+        """Initialize the action by setting the name if not provided.
+
+        Args:
+            __context: The context to be used for initialization.
+        """
+        self.name = self.name or self.__class__.__name__
+
+        self.description = self.description or self.__class__.__doc__ or ""
+
     @abstractmethod
     async def _execute(self, **cxt: Unpack) -> Any:
         """Execute the action with the provided arguments.
@@ -34,6 +49,7 @@ class Action(HandleTask, ProposeTask, GiveRating):
         """
         pass
 
+    @final
     async def act(self, cxt: Dict[str, Any]) -> Dict[str, Any]:
         """Perform the action by executing it and setting the output data.
 

fabricatio-0.2.4.dev2/python/fabricatio/workflows/articles.py

@@ -0,0 +1,11 @@
+"""Store article essence in the database."""
+
+from fabricatio.actions.article import ExtractArticleEssence
+from fabricatio.actions.rag import InjectToDB
+from fabricatio.models.action import WorkFlow
+
+StoreArticle = WorkFlow(
+    name="Extract Article Essence",
+    description="Extract the essence of an article in the given path, and store it in the database.",
+    steps=(ExtractArticleEssence(output_key="to_inject"), InjectToDB(output_key="task_output")),
+)