fabricatio 0.2.2__tar.gz → 0.2.3__tar.gz

{fabricatio-0.2.2 → fabricatio-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.2.2
+Version: 0.2.3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3.12
@@ -98,32 +98,32 @@ from fabricatio import Action, Role, Task, logger
 
 
 class Hello(Action):
-    """Action that says hello."""
+   """Action that says hello."""
 
-    name: str = "hello"
-    output_key: str = "task_output"
+   name: str = "hello"
+   output_key: str = "task_output"
 
-    async def _execute(self, task_input: Task[str], **_) -> Any:
-        ret = "Hello fabricatio!"
-        logger.info("executing talk action")
-        return ret
+   async def _execute(self, task_input: Task[str], **_) -> Any:
+      ret = "Hello fabricatio!"
+      logger.info("executing talk action")
+      return ret
 
 
 async def main() -> None:
-    """Main function."""
-    role = Role(
-        name="talker", 
-        description="talker role", 
-        registry={Task.pending_label: WorkFlow(name="talk", steps=(Hello,))}
-    )
+   """Main function."""
+   role = Role(
+      name="talker",
+      description="talker role",
+      registry={Task.pending_label: WorkFlow(name="talk", steps=(Hello,))}
+   )
 
-    task = Task(name="say hello", goal="say hello", description="say hello to the world")
-    result = await task.delegate()
-    logger.success(f"Result: {result}")
+   task = Task(name="say hello", goals="say hello", description="say hello to the world")
+   result = await task.delegate()
+   logger.success(f"Result: {result}")
 
 
 if __name__ == "__main__":
-    asyncio.run(main())
+   asyncio.run(main())
 ```
 
 #### Writing and Dumping Code
@@ -311,17 +311,18 @@ from fabricatio.models.task import Task
 
 toolbox_usage = ToolBoxUsage()
 
+
 async def handle_security_vulnerabilities():
-    task = Task(
-        name="Security Check",
-        goal=["Identify security vulnerabilities"],
-        description="Perform a thorough security review on the project.",
-        dependencies=["./src/main.py"]
-    )
-    
-    vulnerabilities = await toolbox_usage.gather_tools_fine_grind(task)
-    for vulnerability in vulnerabilities:
-        print(f"Found vulnerability: {vulnerability.name}")
+   task = Task(
+      name="Security Check",
+      goals=["Identify security vulnerabilities"],
+      description="Perform a thorough security review on the project.",
+      dependencies=["./src/main.py"]
+   )
+
+   vulnerabilities = await toolbox_usage.gather_tools_fine_grind(task)
+   for vulnerability in vulnerabilities:
+      print(f"Found vulnerability: {vulnerability.name}")
 ```
 
 #### Managing CTF Challenges
@@ -334,19 +335,22 @@ from fabricatio.models.task import Task
 
 toolbox_usage = ToolBoxUsage()
 
+
 async def solve_ctf_challenge(challenge_name: str, challenge_description: str, files: list[str]):
-    task = Task(
-        name=challenge_name,
-        goal=[f"Solve {challenge_name} challenge"],
-        description=challenge_description,
-        dependencies=files
-    )
-    
-    solution = await toolbox_usage.gather_tools_fine_grind(task)
-    print(f"Challenge Solved: {solution}")
+   task = Task(
+      name=challenge_name,
+      goals=[f"Solve {challenge_name} challenge"],
+      description=challenge_description,
+      dependencies=files
+   )
+
+   solution = await toolbox_usage.gather_tools_fine_grind(task)
+   print(f"Challenge Solved: {solution}")
+
 
 if __name__ == "__main__":
-    asyncio.run(solve_ctf_challenge("Binary Exploitation", "CTF Binary Exploitation Challenge", ["./challenges/binary_exploit"]))
+   asyncio.run(
+      solve_ctf_challenge("Binary Exploitation", "CTF Binary Exploitation Challenge", ["./challenges/binary_exploit"]))
 ```
 
 ### Configuration

{fabricatio-0.2.2 → fabricatio-0.2.3}/README.md

@@ -59,32 +59,32 @@ from fabricatio import Action, Role, Task, logger
 
 
 class Hello(Action):
-    """Action that says hello."""
+   """Action that says hello."""
 
-    name: str = "hello"
-    output_key: str = "task_output"
+   name: str = "hello"
+   output_key: str = "task_output"
 
-    async def _execute(self, task_input: Task[str], **_) -> Any:
-        ret = "Hello fabricatio!"
-        logger.info("executing talk action")
-        return ret
+   async def _execute(self, task_input: Task[str], **_) -> Any:
+      ret = "Hello fabricatio!"
+      logger.info("executing talk action")
+      return ret
 
 
 async def main() -> None:
-    """Main function."""
-    role = Role(
-        name="talker", 
-        description="talker role", 
-        registry={Task.pending_label: WorkFlow(name="talk", steps=(Hello,))}
-    )
+   """Main function."""
+   role = Role(
+      name="talker",
+      description="talker role",
+      registry={Task.pending_label: WorkFlow(name="talk", steps=(Hello,))}
+   )
 
-    task = Task(name="say hello", goal="say hello", description="say hello to the world")
-    result = await task.delegate()
-    logger.success(f"Result: {result}")
+   task = Task(name="say hello", goals="say hello", description="say hello to the world")
+   result = await task.delegate()
+   logger.success(f"Result: {result}")
 
 
 if __name__ == "__main__":
-    asyncio.run(main())
+   asyncio.run(main())
 ```
 
 #### Writing and Dumping Code
@@ -272,17 +272,18 @@ from fabricatio.models.task import Task
 
 toolbox_usage = ToolBoxUsage()
 
+
 async def handle_security_vulnerabilities():
-    task = Task(
-        name="Security Check",
-        goal=["Identify security vulnerabilities"],
-        description="Perform a thorough security review on the project.",
-        dependencies=["./src/main.py"]
-    )
-    
-    vulnerabilities = await toolbox_usage.gather_tools_fine_grind(task)
-    for vulnerability in vulnerabilities:
-        print(f"Found vulnerability: {vulnerability.name}")
+   task = Task(
+      name="Security Check",
+      goals=["Identify security vulnerabilities"],
+      description="Perform a thorough security review on the project.",
+      dependencies=["./src/main.py"]
+   )
+
+   vulnerabilities = await toolbox_usage.gather_tools_fine_grind(task)
+   for vulnerability in vulnerabilities:
+      print(f"Found vulnerability: {vulnerability.name}")
 ```
 
 #### Managing CTF Challenges
@@ -295,19 +296,22 @@ from fabricatio.models.task import Task
 
 toolbox_usage = ToolBoxUsage()
 
+
 async def solve_ctf_challenge(challenge_name: str, challenge_description: str, files: list[str]):
-    task = Task(
-        name=challenge_name,
-        goal=[f"Solve {challenge_name} challenge"],
-        description=challenge_description,
-        dependencies=files
-    )
-    
-    solution = await toolbox_usage.gather_tools_fine_grind(task)
-    print(f"Challenge Solved: {solution}")
+   task = Task(
+      name=challenge_name,
+      goals=[f"Solve {challenge_name} challenge"],
+      description=challenge_description,
+      dependencies=files
+   )
+
+   solution = await toolbox_usage.gather_tools_fine_grind(task)
+   print(f"Challenge Solved: {solution}")
+
 
 if __name__ == "__main__":
-    asyncio.run(solve_ctf_challenge("Binary Exploitation", "CTF Binary Exploitation Challenge", ["./challenges/binary_exploit"]))
+   asyncio.run(
+      solve_ctf_challenge("Binary Exploitation", "CTF Binary Exploitation Challenge", ["./challenges/binary_exploit"]))
 ```
 
 ### Configuration

{fabricatio-0.2.2 → fabricatio-0.2.3}/examples/make_diary/diary.py

@@ -18,8 +18,8 @@ class WriteDiary(Action):
     output_key: str = "dump_text"
 
     async def _execute(self, task_input: Task[str], **_) -> str:
-        task_input.goal.clear()
-        task_input.goal.extend(
+        task_input.goals.clear()
+        task_input.goals.extend(
             [
                 "write a Internship Diary according to the given commit messages",
                 "the diary should include the main dev target of the day, and the exact content"

{fabricatio-0.2.2 → fabricatio-0.2.3}/examples/minor/hello_fabricatio.py

@@ -5,7 +5,7 @@ from typing import Any
 
 from fabricatio import Action, Role, Task, WorkFlow, logger
 
-task = Task(name="say hello", goal=["say hello"], description="say hello to the world")
+task = Task(name="say hello", goals=["say hello"], description="say hello to the world")
 
 
 class Hello(Action):

{fabricatio-0.2.2 → fabricatio-0.2.3}/examples/propose_task/propose.py

@@ -5,7 +5,7 @@ from typing import Any
 
 from fabricatio import Action, Role, Task, WorkFlow, logger
 
-task = Task(name="say hello", goal=["say hello"], description="say hello to the world")
+task = Task(name="say hello", goals=["say hello"], description="say hello to the world")
 
 
 class Talk(Action):

fabricatio-0.2.3/examples/simple_chat/chat.py

@@ -0,0 +1,47 @@
+"""Simple chat example."""
+
+import asyncio
+
+from fabricatio import Action, Role, Task, WorkFlow, logger
+from fabricatio.models.events import Event
+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:
+        counter = 0
+        try:
+            while True:
+                user_say = await text("User: ").ask_async()
+                gpt_say = await self.aask(
+                    user_say,
+                    system_message=f"You have to answer to user obeying task assigned to you:\n{task_input.briefing}",
+                )
+                print(f"GPT: {gpt_say}")  # noqa: T201
+                counter += 1
+        except KeyboardInterrupt:
+            logger.info(f"executed talk action {counter} times")
+        return counter
+
+
+async def main() -> None:
+    """Main function."""
+    role = Role(
+        name="talker",
+        description="talker role",
+        registry={Event.instantiate_from("talk").push_wildcard().push("pending"): WorkFlow(name="talk", steps=(Talk,))},
+    )
+
+    task = await role.propose(
+        "you have to act as a helpful assistant, answer to all user questions properly and patiently"
+    )
+    _ = await task.delegate("talk")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

fabricatio-0.2.3/examples/simple_rag/simple_rag.py

@@ -0,0 +1,66 @@
+"""Simple chat example."""
+
+import asyncio
+
+from fabricatio import RAG, Action, Role, Task, WorkFlow, logger
+from fabricatio.models.events import Event
+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:
+        counter = 0
+
+        self.init_client().view("test_collection", create=True)
+        await self.consume_string(
+            [
+                "Company policy clearly stipulates that all employees must arrive at the headquarters building located at 88 Jianguo Road, Chaoyang District, Beijing before 9 AM daily.",
+                "According to the latest revised health and safety guidelines, employees must wear company-provided athletic gear when using the company gym facilities.",
+                "Section 3.2.1 of the employee handbook states that pets are not allowed in the office area under any circumstances.",
+                "To promote work efficiency, the company has quiet workspaces at 100 Century Avenue, Pudong New District, Shanghai, for employees who need high concentration for their work.",
+                "According to the company's remote work policy, employees can apply for a maximum of 5 days of working from home per month, but must submit the application one week in advance.",
+                "The company has strict regulations on overtime. Unless approved by direct supervisors, no form of work is allowed after 9 PM.",
+                "Regarding the new regulations for business travel reimbursement, all traveling personnel must submit detailed expense reports within five working days after returning.",
+                "Company address: 123 East Sports Road, Tianhe District, Guangzhou, Postal Code: 510620.",
+                "Annual team building activities will be held in the second quarter of each year, usually at a resort within a two-hour drive from the Guangzhou headquarters.",
+                "Employees who are late more than three times will receive a formal warning, which may affect their year-end performance evaluation.",
+            ]
+        )
+        try:
+            while True:
+                user_say = await text("User: ").ask_async()
+                if user_say is None:
+                    break
+                gpt_say = await self.aask_retrieved(
+                    user_say,
+                    user_say,
+                    extra_system_message=f"You have to answer to user obeying task assigned to you:\n{task_input.briefing}",
+                )
+                print(f"GPT: {gpt_say}")  # noqa: T201
+                counter += 1
+        except KeyboardInterrupt:
+            logger.info(f"executed talk action {counter} times")
+        return counter
+
+
+async def main() -> None:
+    """Main function."""
+    role = Role(
+        name="talker",
+        description="talker role but with rag",
+        registry={Event.instantiate_from("talk").push_wildcard().push("pending"): WorkFlow(name="talk", steps=(Talk,))},
+    )
+
+    task = await role.propose(
+        "you have to act as a helpful assistant, answer to all user questions properly and patiently"
+    )
+    _ = await task.delegate("talk")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

{fabricatio-0.2.2 → fabricatio-0.2.3}/examples/task_handle/handle_task.py

@@ -56,6 +56,30 @@ class WriteDocumentation(Action):
         return await self.aask(task_input.briefing, system_message=task_input.dependencies_prompt)
 
 
+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:
+        logger.info(f"Counter: {counter}")
+        await asyncio.sleep(5)
+        counter += 1
+        return counter
+
+
+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:
+        return "hi, this is the output"
+
+
 async def main() -> None:
     """Main function."""
     role = Role(
@@ -68,20 +92,32 @@ async def main() -> None:
             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(
+                name="cancel_test",
+                steps=(TestCancel, TestCancel, TestCancel, TestCancel, TestCancel, TestCancel, WriteToOutput),
+                extra_init_context={"counter": 0},
+            ),
         },
     )
 
-    prompt = "i want you to write a cli app implemented with python , which can calculate the sum to a given n, all write to a single file names `cli.py`, put it in `output` folder."
-
-    proposed_task = await role.propose(prompt)
-    path = await proposed_task.move_to("coding").delegate()
+    proposed_task = await role.propose(
+        "i want you to write a cli app implemented with python , which can calculate the sum to a given n, all write to a single file names `cli.py`, put it in `output` folder."
+    )
+    path = await proposed_task.delegate("coding")
     logger.success(f"Code Path: {path}")
 
-    proposed_task = await role.propose(f"write Readme.md file for the code, source file {path},save it in `README.md`")
-    proposed_task.override_dependencies([path])
-    doc = await proposed_task.move_to("doc").delegate()
+    proposed_task = await role.propose(
+        f"write Readme.md file for the code, source file {path},save it in `README.md`,which is in the `output` folder, too."
+    )
+    proposed_task.override_dependencies(path)
+    doc = await proposed_task.delegate("doc")
     logger.success(f"Documentation: \n{doc}")
 
+    proposed_task.publish("cancel_test")
+    await proposed_task.cancel()
+    out = await proposed_task.get_output()
+    logger.info(f"Canceled Task Output: {out}")
+
 
 if __name__ == "__main__":
     asyncio.run(main())

{fabricatio-0.2.2 → fabricatio-0.2.3}/pyproject.toml

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

{fabricatio-0.2.2 → fabricatio-0.2.3}/python/fabricatio/__init__.py

@@ -1,5 +1,7 @@
 """Fabricatio is a Python library for building llm app using event-based agent structure."""
 
+from importlib.util import find_spec
+
 from fabricatio._rust_instances import template_manager
 from fabricatio.core import env
 from fabricatio.fs import magika
@@ -35,3 +37,9 @@ __all__ = [
     "task_toolbox",
     "template_manager",
 ]
+
+
+if find_spec("pymilvus"):
+    from fabricatio.capabilities.rag import RAG
+
+    __all__ += ["RAG"]