fabricatio 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl

fabricatio/config.py

@@ -1,4 +1,4 @@
-from typing import Literal
+from typing import List, Literal
 
 from appdirs import user_config_dir
 from pydantic import BaseModel, ConfigDict, Field, FilePath, HttpUrl, NonNegativeFloat, PositiveInt, SecretStr
@@ -29,6 +29,7 @@ class LLMConfig(BaseModel):
         stream (bool): Whether to stream the LLM model's response. Default is False.
         max_tokens (PositiveInt): The maximum number of tokens to generate. Set to 8192 as per request.
     """
+
     model_config = ConfigDict(use_attribute_docstrings=True)
     api_endpoint: HttpUrl = Field(default=HttpUrl("https://api.openai.com"))
     """
@@ -60,7 +61,7 @@ class LLMConfig(BaseModel):
     The temperature of the LLM model. Controls randomness in generation. Set to 1.0 as per request.
     """
 
-    stop_sign: str = Field(default="")
+    stop_sign: str | List[str] = Field(default=("\n\n", "User:"))
     """
     The stop sign of the LLM model. No default stop sign specified.
     """
@@ -94,6 +95,7 @@ class PymitterConfig(BaseModel):
         new_listener_event (bool): If set, a newListener event is emitted when a new listener is added.
         max_listeners (int): The maximum number of listeners per event.
     """
+
     model_config = ConfigDict(use_attribute_docstrings=True)
     delimiter: str = Field(default=".", frozen=True)
     """
@@ -118,6 +120,7 @@ class DebugConfig(BaseModel):
         log_level (Literal["DEBUG", "INFO", "SUCCESS", "WARNING", "ERROR", "CRITICAL"]): The log level of the application.
         log_file (FilePath): The log file of the application.
     """
+
     model_config = ConfigDict(use_attribute_docstrings=True)
 
     log_level: Literal["DEBUG", "INFO", "SUCCESS", "WARNING", "ERROR", "CRITICAL"] = Field(default="INFO")
@@ -139,6 +142,7 @@ class Settings(BaseSettings):
         debug (DebugConfig): Debug Configuration
         pymitter (PymitterConfig): Pymitter Configuration
     """
+
     model_config = SettingsConfigDict(
         env_prefix="FABRIK_",
         env_nested_delimiter="__",

fabricatio/models/generic.py

@@ -1,7 +1,8 @@
 from asyncio import Queue
-from typing import Any, Dict, Iterable, List, Optional, Self
+from typing import Callable, Dict, Iterable, List, Optional, Self
 
 import litellm
+import orjson
 from litellm.types.utils import Choices, ModelResponse, StreamingChoices
 from pydantic import (
     BaseModel,
@@ -190,7 +191,7 @@ class LLMUsage(Base):
     The temperature of the LLM model.
     """
 
-    llm_stop_sign: Optional[str] = None
+    llm_stop_sign: Optional[str | List[str]] = None
     """
     The stop sign of the LLM model.
     """
@@ -215,21 +216,12 @@ class LLMUsage(Base):
     The maximum number of tokens to generate.
     """
 
-    def model_post_init(self, __context: Any) -> None:
-        """Initialize the LLM model with API key and endpoint.
-
-        Args:
-            __context (Any): The context passed during model initialization.
-        """
-        litellm.api_key = self.llm_api_key.get_secret_value() if self.llm_api_key else configs.llm.api_key
-        litellm.api_base = self.llm_api_endpoint.unicode_string() if self.llm_api_endpoint else configs.llm.api_endpoint
-
     async def aquery(
         self,
         messages: List[Dict[str, str]],
         model: str | None = None,
         temperature: NonNegativeFloat | None = None,
-        stop: str | None = None,
+        stop: str | List[str] | None = None,
         top_p: NonNegativeFloat | None = None,
         max_tokens: PositiveInt | None = None,
         n: PositiveInt | None = None,
@@ -266,6 +258,10 @@ class LLMUsage(Base):
             stream=stream or self.llm_stream or configs.llm.stream,
             timeout=timeout or self.llm_timeout or configs.llm.timeout,
             max_retries=max_retries or self.llm_max_retries or configs.llm.max_retries,
+            api_key=self.llm_api_key.get_secret_value() if self.llm_api_key else configs.llm.api_key.get_secret_value(),
+            base_url=self.llm_api_endpoint.unicode_string()
+            if self.llm_api_endpoint
+            else configs.llm.api_endpoint.unicode_string(),
         )
 
     async def ainvoke(
@@ -274,7 +270,7 @@ class LLMUsage(Base):
         system_message: str = "",
         model: str | None = None,
         temperature: NonNegativeFloat | None = None,
-        stop: str | None = None,
+        stop: str | List[str] | None = None,
         top_p: NonNegativeFloat | None = None,
         max_tokens: PositiveInt | None = None,
         n: PositiveInt | None = None,
@@ -321,7 +317,7 @@ class LLMUsage(Base):
         system_message: str = "",
         model: str | None = None,
         temperature: NonNegativeFloat | None = None,
-        stop: str | None = None,
+        stop: str | List[str] | None = None,
         top_p: NonNegativeFloat | None = None,
         max_tokens: PositiveInt | None = None,
         stream: bool | None = None,
@@ -365,6 +361,61 @@ class LLMUsage(Base):
             .message.content
         )
 
+    async def aask_validate[T](
+        self,
+        question: str,
+        validator: Callable[[str], T | None],
+        max_validations: PositiveInt = 2,
+        system_message: str = "",
+        model: str | None = None,
+        temperature: NonNegativeFloat | None = None,
+        stop: str | List[str] | None = None,
+        top_p: NonNegativeFloat | None = None,
+        max_tokens: PositiveInt | None = None,
+        stream: bool | None = None,
+        timeout: PositiveInt | None = None,
+        max_retries: PositiveInt | None = None,
+    ) -> T:
+        """Asynchronously ask a question and validate the response using a given validator.
+
+        Args:
+            question (str): The question to ask.
+            validator (Callable[[str], T | None]): A function to validate the response.
+            max_validations (PositiveInt): Maximum number of validation attempts.
+            system_message (str): System message to include in the request.
+            model (str | None): The model to use for the request.
+            temperature (NonNegativeFloat | None): Temperature setting for the request.
+            stop (str | None): Stop sequence for the request.
+            top_p (NonNegativeFloat | None): Top-p sampling parameter.
+            max_tokens (PositiveInt | None): Maximum number of tokens in the response.
+            stream (bool | None): Whether to stream the response.
+            timeout (PositiveInt | None): Timeout for the request.
+            max_retries (PositiveInt | None): Maximum number of retries for the request.
+
+        Returns:
+            T: The validated response.
+
+        Raises:
+            ValueError: If the response fails to validate after the maximum number of attempts.
+        """
+        for _ in range(max_validations):
+            if (
+                response := await self.aask(
+                    question,
+                    system_message,
+                    model,
+                    temperature,
+                    stop,
+                    top_p,
+                    max_tokens,
+                    stream,
+                    timeout,
+                    max_retries,
+                )
+            ) and (validated := validator(response)):
+                return validated
+        raise ValueError("Failed to validate the response.")
+
     def fallback_to(self, other: "LLMUsage") -> Self:
         """Fallback to another instance's attribute values if the current instance's attributes are None.
 
@@ -397,3 +448,19 @@ class LLMUsage(Base):
 
         # Return the current instance to allow for method chaining
         return self
+
+
+class WithJsonExample(Base):
+    """Class that provides a JSON schema for the model."""
+
+    @classmethod
+    def json_example(cls) -> str:
+        """Return a JSON example for the model.
+
+        Returns:
+            str: A JSON example for the model.
+        """
+        return orjson.dumps(
+            {field_name: field_info.description for field_name, field_info in cls.model_fields.items()},
+            option=orjson.OPT_INDENT_2 | orjson.OPT_SORT_KEYS,
+        ).decode()

fabricatio/models/role.py

@@ -1,6 +1,6 @@
 from typing import Any
 
-from pydantic import Field
+from pydantic import Field, ValidationError
 
 from fabricatio.core import env
 from fabricatio.journal import logger
@@ -8,6 +8,7 @@ from fabricatio.models.action import WorkFlow
 from fabricatio.models.events import Event
 from fabricatio.models.generic import LLMUsage, Memorable, WithBriefing, WithToDo
 from fabricatio.models.task import Task
+from fabricatio.parser import JsonCapture
 
 
 class Role(Memorable, WithBriefing, WithToDo, LLMUsage):
@@ -26,4 +27,24 @@ class Role(Memorable, WithBriefing, WithToDo, LLMUsage):
             env.on(event, workflow.serve)
 
     async def propose(self, prompt: str) -> Task:
-        """Propose a task to the role."""
+        """Propose a task based on the provided prompt."""
+        assert prompt, "Prompt must be provided."
+
+        def _validate_json(response: str) -> None | Task:
+            try:
+                cap = JsonCapture.capture(response)
+                logger.debug(f"Response: \n{response}")
+                logger.info(f"Captured JSON: \n{cap[0]}")
+                return Task.model_validate_json(cap[0] if cap else response)
+            except ValidationError as e:
+                logger.error(f"Failed to parse task from JSON: {e}")
+                return None
+
+        return await self.aask_validate(
+            f"{prompt} \n\nBased on requirement above, "
+            f"you need to construct a task to satisfy that requirement in JSON format "
+            f"written like this: \n\n```json\n{Task.json_example()}\n```\n\n"
+            f"No extra explanation needed. ",
+            _validate_json,
+            system_message=f"# your personal briefing: \n{self.briefing}",
+        )

fabricatio/models/task.py

@@ -12,7 +12,7 @@ from pydantic import Field, PrivateAttr
 from fabricatio.config import configs
 from fabricatio.core import env
 from fabricatio.journal import logger
-from fabricatio.models.generic import WithBriefing
+from fabricatio.models.generic import WithBriefing, WithJsonExample
 
 
 class TaskStatus(Enum):
@@ -25,27 +25,31 @@ class TaskStatus(Enum):
     Cancelled = "cancelled"
 
 
-class Task[T](WithBriefing):
+class Task[T](WithBriefing, WithJsonExample):
     """Class that represents a task with a status and output.
 
     Attributes:
         name (str): The name of the task.
         description (str): The description of the task.
         _output (Queue): The output queue of the task.
-        status (TaskStatus): The status of the task.
+        _status (TaskStatus): The status of the task.
         goal (str): The goal of the task.
     """
 
     name: str = Field(...)
     """The name of the task."""
+
     description: str = Field(default="")
     """The description of the task."""
-    _output: Queue = PrivateAttr(default_factory=lambda: Queue(maxsize=1))
-    status: TaskStatus = Field(default=TaskStatus.Pending)
-    """The status of the task."""
+
     goal: str = Field(default="")
     """The goal of the task."""
 
+    _output: Queue = PrivateAttr(default_factory=lambda: Queue(maxsize=1))
+    """The output queue of the task."""
+    _status: TaskStatus = PrivateAttr(default=TaskStatus.Pending)
+    """The status of the task."""
+
     @classmethod
     def simple_task(cls, name: str, goal: str, description: str) -> Self:
         """Create a simple task with a name, goal, and description.
@@ -151,7 +155,7 @@ class Task[T](WithBriefing):
             Self: The finished instance of the Task class.
         """
         logger.info(f"Finishing task {self.name}")
-        self.status = TaskStatus.Finished
+        self._status = TaskStatus.Finished
         await self._output.put(output)
         logger.debug(f"Output set for task {self.name}")
         await env.emit_async(self.finished_label, self)
@@ -165,7 +169,7 @@ class Task[T](WithBriefing):
             Self: The running instance of the Task class.
         """
         logger.info(f"Starting task {self.name}")
-        self.status = TaskStatus.Running
+        self._status = TaskStatus.Running
         await env.emit_async(self.running_label, self)
         return self
 
@@ -175,7 +179,7 @@ class Task[T](WithBriefing):
         Returns:
             Self: The cancelled instance of the Task class.
         """
-        self.status = TaskStatus.Cancelled
+        self._status = TaskStatus.Cancelled
         await env.emit_async(self.cancelled_label, self)
         return self
 
@@ -186,7 +190,7 @@ class Task[T](WithBriefing):
             Self: The failed instance of the Task class.
         """
         logger.error(f"Task {self.name} failed")
-        self.status = TaskStatus.Failed
+        self._status = TaskStatus.Failed
         await env.emit_async(self.failed_label, self)
         return self
 

fabricatio/parser.py

@@ -1,6 +1,7 @@
 from typing import Any, Self, Tuple
 
-from pydantic import Field, PrivateAttr
+import regex
+from pydantic import Field, PositiveInt, PrivateAttr
 from regex import Pattern, compile
 
 from fabricatio.models.generic import Base
@@ -18,6 +19,8 @@ class Capture(Base):
     """The target groups to capture from the pattern."""
     pattern: str = Field(frozen=True)
     """The regular expression pattern to search for."""
+    flags: PositiveInt = Field(default=regex.DOTALL | regex.MULTILINE | regex.IGNORECASE, frozen=True)
+    """The flags to use when compiling the regular expression pattern."""
     _compiled: Pattern = PrivateAttr()
 
     def model_post_init(self, __context: Any) -> None:
@@ -26,7 +29,7 @@ class Capture(Base):
         Args:
             __context (Any): The context in which the model is initialized.
         """
-        self._compiled = compile(self.pattern)
+        self._compiled = compile(self.pattern, self.flags)
 
     def capture(self, text: str) -> Tuple[str, ...] | None:
         """Capture the first occurrence of the pattern in the given text.

{fabricatio-0.1.1.dist-info → fabricatio-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.1.1
+Version: 0.1.2
 Summary: A LLM multi-agent framework.
 Author-email: Whth <zettainspector@foxmail.com>
 License: MIT License
@@ -40,6 +40,7 @@ Requires-Dist: asyncio>=3.4.3
 Requires-Dist: gitpython>=3.1.44
 Requires-Dist: litellm>=1.60.0
 Requires-Dist: loguru>=0.7.3
+Requires-Dist: orjson>=3.10.15
 Requires-Dist: pydantic-settings>=2.7.1
 Requires-Dist: pydantic>=2.10.6
 Requires-Dist: pymitter>=1.0.0

{fabricatio-0.1.1.dist-info → fabricatio-0.1.2.dist-info}/RECORD

@@ -1,19 +1,19 @@
 fabricatio/__init__.py,sha256=nFPtohqceECRYzU-WlVT6o4oSaKN0vGok-w9JIaiJfs,644
-fabricatio/config.py,sha256=Y-XPY23p6DrNk9YUMMpu1ECNON-hRUMUDePqeW6Qx0w,6954
+fabricatio/config.py,sha256=EOlVkuEBAHESAlrGtolGwEG2YrTaJPhEGPKS7QDxrx0,6995
 fabricatio/core.py,sha256=B6KBIfBRF023HF0UUaUprEkQd6sT7G_pexGXQ9btJnE,5788
 fabricatio/journal.py,sha256=CW9HePtgTiboOyPTExq9GjG5BseZcbc-S6lxDXrpmv0,667
-fabricatio/parser.py,sha256=Nxrfw-m0DVaI0wIE1b6LK67zXiYbQdXtv8ZqiZd3hbw,2096
+fabricatio/parser.py,sha256=On_YUCvOuA0FA_NtDVNJqKp7KEO_sUE89oO_WnkEhQ4,2314
 fabricatio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fabricatio/models/action.py,sha256=M-12dc-nQiNJU6Y9j-dr4Ef3642vRvzHlzxekBepzaU,3358
 fabricatio/models/events.py,sha256=0p42QmNDzmC76DhMwW1H_Mlg15MQ_XjEqkCJc8UkIB8,2055
-fabricatio/models/generic.py,sha256=_1HKN3tdU-SI1uEnMZnAaUFH1_7IvEOfyE0I8JP9TX8,14929
-fabricatio/models/role.py,sha256=0P8Ys84cHNYk1uhPfkJdIOl8-GiqO5y3gAE2IZX_MbQ,1123
-fabricatio/models/task.py,sha256=1ZTMktQGuCe7LGWfNFQEL-7M4adoKA_esmZgVS23CnU,6772
+fabricatio/models/generic.py,sha256=Sxpx0BO0t85YF5Lwks6F165N6TJsDe7xym28dQG5Mqs,17681
+fabricatio/models/role.py,sha256=jdabuYRXwgvpYoNwvazygDiZHGGQApUIIKltniu78O8,2151
+fabricatio/models/task.py,sha256=0oQeGQ6Rvd_x6ZM5ImtcN2vr0ojFmF6EiWBAMOjledI,6865
 fabricatio/models/tool.py,sha256=UkEp1Nzbl5wZX21q_Z2VkpiJmVDSdoGDzINQniO8hSY,3536
 fabricatio/models/utils.py,sha256=2mgXla9_K3dnRrz6hIKzmltTYPmvDk0MBjjEBkCXTdg,2474
 fabricatio/toolboxes/__init__.py,sha256=bjefmPd7wBaWhbZzdMPXvrjMTeRzlUh_Dev2PUAc124,158
 fabricatio/toolboxes/task.py,sha256=xgyPetm2R_HlQwpzE8YPnBN7QOYLd0-T8E6QPZG1PPQ,204
-fabricatio-0.1.1.dist-info/METADATA,sha256=2y5f2Z9wK_sOyKJpLHO6-CBRXZq9Z4JeMKnL7LFafD8,3766
-fabricatio-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-fabricatio-0.1.1.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
-fabricatio-0.1.1.dist-info/RECORD,,
+fabricatio-0.1.2.dist-info/METADATA,sha256=JoHDaag_cV_OOthFdXHGJyBKlJpyUg4C30lBOvAVA_U,3797
+fabricatio-0.1.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+fabricatio-0.1.2.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
+fabricatio-0.1.2.dist-info/RECORD,,