fabricatio 0.2.7.dev0__cp39-cp39-win_amd64.whl → 0.2.7.dev1__cp39-cp39-win_amd64.whl

fabricatio/models/generic.py

@@ -10,6 +10,7 @@ from fabricatio._rust_instances import TEMPLATE_MANAGER
 from fabricatio.config import configs
 from fabricatio.fs.readers import MAGIKA, safe_text_read
 from fabricatio.journal import logger
+from fabricatio.models.utils import ok
 from fabricatio.parser import JsonCapture
 from pydantic import (
     BaseModel,
@@ -19,6 +20,7 @@ from pydantic import (
     NonNegativeFloat,
     PositiveFloat,
     PositiveInt,
+    PrivateAttr,
     SecretStr,
 )
 
@@ -63,6 +65,44 @@ class Described(Base):
     """The description of the object."""
 
 
+class AsPrompt(Base):
+    """Class that provides a method to generate a prompt from the model."""
+
+    @final
+    def as_prompt(self) -> str:
+        """Generate a prompt from the model.
+
+        Returns:
+            str: The generated prompt.
+        """
+        return TEMPLATE_MANAGER.render_template(
+            configs.templates.as_prompt_template,
+            self._as_prompt_inner(),
+        )
+
+    @abstractmethod
+    def _as_prompt_inner(self) -> Dict[str, str]: ...
+
+
+class WithRef[T](Base):
+    """Class that provides a reference to another object."""
+
+    _reference: Optional[T] = PrivateAttr(None)
+
+    @property
+    def referenced(self) -> T:
+        """Get the referenced object."""
+        return ok(self._reference, "_reference is None")
+
+    def update_ref(self, reference: T | Self) -> Self:
+        """Update the reference of the object."""
+        if isinstance(reference, self.__class__):
+            self._reference = reference.referenced
+        else:
+            self._reference = reference
+        return self
+
+
 class WithBriefing(Named, Described):
     """Class that provides a briefing based on the name and description."""
 
@@ -75,17 +115,26 @@ class WithBriefing(Named, Described):
         """
         return f"{self.name}: {self.description}" if self.description else self.name
 
-    def prepend[D: Dict[str, Any]](self, kwargs: D) -> D:
-        """Prepend the briefing to the system message in the kwargs.
+    def _prepend_inner(self, input_text: str) -> str:
+        return f"# your personal briefing: \n{self.briefing}\n{input_text}"
+
+    def prepend_sys_msg[D: (Dict[str, Any], str)](self, system_msg_like: D = "") -> Dict[str, Any]:
+        """Prepend the system message with the briefing.
 
         Args:
-            kwargs (Dict[str, Any]): The keyword arguments to modify.
+            system_msg_like (str | dict): The system message or a dictionary containing the system message.
 
         Returns:
-            Dict[str, Any]: The modified keyword arguments.
+            dict: The system message with the briefing prepended.
         """
-        kwargs["system_message"] = f"# your personal briefing: \n{self.briefing}\n" + kwargs.get("system_message", "")
-        return kwargs
+        match system_msg_like:
+            case dict(d):
+                d["system_message"] = self._prepend_inner(d.get("system_message", ""))
+                return d
+            case str(s):
+                return {"system_message": self._prepend_inner(s)}
+            case _:
+                raise TypeError(f"{system_msg_like} is not a dict or str")
 
 
 class WithFormatedJsonSchema(Base):
@@ -158,19 +207,17 @@ class InstantiateFromString(Base):
 class ProposedAble(CreateJsonObjPrompt, InstantiateFromString):
     """Class that provides a method to propose a JSON object based on the requirement."""
 
-    pass
-
 
 class FinalizedDumpAble(Base):
     """Class that provides a method to finalize the dump of the object."""
 
-    @abstractmethod
     def finalized_dump(self) -> str:
         """Finalize the dump of the object.
 
         Returns:
             str: The finalized dump of the object.
         """
+        return self.model_dump_json()
 
     def finalized_dump_to(self, path: str | Path) -> Self:
         """Finalize the dump of the object to a file.
@@ -185,6 +232,10 @@ class FinalizedDumpAble(Base):
         return self
 
 
+class CensoredAble(ProposedAble, FinalizedDumpAble):
+    """Class that provides a method to censor the object."""
+
+
 class WithDependency(Base):
     """Class that manages file dependencies."""
 

fabricatio/models/kwargs_types.py

@@ -38,6 +38,12 @@ class FetchKwargs(TypedDict, total=False):
     result_per_query: int
 
 
+class RetrievalKwargs(FetchKwargs, total=False):
+    """Arguments for retrieval operations."""
+
+    final_limit: int
+
+
 class EmbeddingKwargs(TypedDict, total=False):
     """Configuration parameters for text embedding operations.
 
@@ -94,8 +100,14 @@ class ValidateKwargs[T](GenerateKwargs, total=False):
     co_extractor: GenerateKwargs
 
 
+class ReviewInnerKwargs[T](ValidateKwargs[T], total=False):
+    """Arguments for content review operations."""
+
+    criteria: set[str]
+
+
 # noinspection PyTypedDict
-class ReviewKwargs[T](ValidateKwargs[T], total=False):
+class ReviewKwargs[T](ReviewInnerKwargs[T], total=False):
     """Arguments for content review operations.
 
     Extends GenerateKwargs with parameters for evaluating content against
@@ -103,7 +115,6 @@ class ReviewKwargs[T](ValidateKwargs[T], total=False):
     """
 
     topic: Required[str]
-    criteria: set[str]
 
 
 class CorrectKwargs[T](ReviewKwargs[T], total=False):
@@ -117,6 +128,13 @@ class CorrectKwargs[T](ReviewKwargs[T], total=False):
     supervisor_check: bool
 
 
+class CensoredCorrectKwargs[T](ReviewInnerKwargs[T], total=False):
+    """Arguments for content censorship operations."""
+
+    reference: str
+    supervisor_check: bool
+
+
 # noinspection PyTypedDict
 class ChooseKwargs[T](ValidateKwargs[T], total=False):
     """Arguments for selection operations.

fabricatio/models/usages.py

@@ -23,7 +23,7 @@ from litellm.types.utils import (
     StreamingChoices,
     TextChoices,
 )
-from litellm.utils import CustomStreamWrapper  # pyright: ignore [reportPrivateImportUsage]
+from litellm.utils import CustomStreamWrapper, token_counter  # pyright: ignore [reportPrivateImportUsage]
 from more_itertools import duplicates_everseen
 from pydantic import Field, NonNegativeInt, PositiveInt
 
@@ -118,6 +118,7 @@ class LLMUsage(ScopedConfig):
         question: str,
         system_message: str = "",
         n: PositiveInt | None = None,
+        stream_buffer_size: int = 50,
         **kwargs: Unpack[LLMKwargs],
     ) -> Sequence[TextChoices | Choices | StreamingChoices]:
         """Asynchronously invokes the language model with a question and optional system message.
@@ -126,6 +127,7 @@ class LLMUsage(ScopedConfig):
             question (str): The question to ask the model.
             system_message (str): The system message to provide context to the model. Defaults to an empty string.
             n (PositiveInt | None): The number of responses to generate. Defaults to the instance's `llm_generation_count` or the global configuration.
+            stream_buffer_size (int): The buffer size for streaming responses. Defaults to 50.
             **kwargs (Unpack[LLMKwargs]): Additional keyword arguments for the LLM usage.
 
         Returns:
@@ -142,9 +144,13 @@ class LLMUsage(ScopedConfig):
             if not configs.debug.streaming_visible and (pack := stream_chunk_builder(await asyncstdlib.list())):
                 return pack.choices
             chunks = []
+            buffer = ""
             async for chunk in resp:
                 chunks.append(chunk)
-                print(chunk.choices[0].delta.content or "", end="")  # noqa: T201
+                buffer += chunk.choices[0].delta.content or ""
+                if len(buffer) % stream_buffer_size == 0:
+                    print(buffer, end="")  # noqa: T201
+                    buffer = ""
             if pack := stream_chunk_builder(chunks):
                 return pack.choices
         logger.critical(err := f"Unexpected response type: {type(resp)}")
@@ -196,8 +202,7 @@ class LLMUsage(ScopedConfig):
         Returns:
             str | List[str]: The content of the model's response message.
         """
-        system_message = system_message or ""
-        match (question, system_message):
+        match (question, system_message or ""):
             case (list(q_seq), list(sm_seq)):
                 res = await gather(
                     *[
@@ -205,18 +210,23 @@ class LLMUsage(ScopedConfig):
                         for q, sm in zip(q_seq, sm_seq, strict=True)
                     ]
                 )
-                return [r[0].message.content for r in res]  # pyright: ignore [reportReturnType, reportAttributeAccessIssue]
+                out = [r[0].message.content for r in res]  # pyright: ignore [reportAttributeAccessIssue]
             case (list(q_seq), str(sm)):
                 res = await gather(*[self.ainvoke(n=1, question=q, system_message=sm, **kwargs) for q in q_seq])
-                return [r[0].message.content for r in res]  # pyright: ignore [reportReturnType, reportAttributeAccessIssue]
+                out = [r[0].message.content for r in res]  # pyright: ignore [reportAttributeAccessIssue]
             case (str(q), list(sm_seq)):
                 res = await gather(*[self.ainvoke(n=1, question=q, system_message=sm, **kwargs) for sm in sm_seq])
-                return [r[0].message.content for r in res]  # pyright: ignore [reportReturnType, reportAttributeAccessIssue]
+                out = [r[0].message.content for r in res]  # pyright: ignore [reportAttributeAccessIssue]
             case (str(q), str(sm)):
-                return ((await self.ainvoke(n=1, question=q, system_message=sm, **kwargs))[0]).message.content  # pyright: ignore [reportReturnType, reportAttributeAccessIssue]
+                out = ((await self.ainvoke(n=1, question=q, system_message=sm, **kwargs))[0]).message.content  # pyright: ignore [reportAttributeAccessIssue]
             case _:
                 raise RuntimeError("Should not reach here.")
 
+        logger.debug(
+            f"Response Token Count: {token_counter(text=out) if isinstance(out, str) else sum(token_counter(text=o) for o in out)}"  # pyright: ignore [reportOptionalIterable]
+        )
+        return out  # pyright: ignore [reportReturnType]
+
     @overload
     async def aask_validate[T](
         self,
@@ -286,26 +296,26 @@ class LLMUsage(ScopedConfig):
         async def _inner(q: str) -> Optional[T]:
             for lap in range(max_validations):
                 try:
-                    if (response := await self.aask(question=q, **kwargs)) and (validated := validator(response)):
-                        logger.debug(f"Successfully validated the response at {lap}th attempt.")
-                        return validated
-
-                    if co_extractor and (
-                        (
-                            co_response := await self.aask(
-                                question=(
-                                    TEMPLATE_MANAGER.render_template(
-                                        configs.templates.co_validation_template,
-                                        {"original_q": q, "original_a": response},
-                                    )
-                                ),
-                                **co_extractor,
+                    if (
+                        (response := await self.aask(question=q, **kwargs))
+                        or (
+                            co_extractor
+                            and (
+                                response := await self.aask(
+                                    question=(
+                                        TEMPLATE_MANAGER.render_template(
+                                            configs.templates.co_validation_template,
+                                            {"original_q": q, "original_a": response},
+                                        )
+                                    ),
+                                    **co_extractor,
+                                )
                             )
                         )
-                        and (validated := validator(co_response))
-                    ):
-                        logger.debug(f"Successfully validated the co-response at {lap}th attempt.")
+                    ) and (validated := validator(response)):
+                        logger.debug(f"Successfully validated the response at {lap}th attempt.")
                         return validated
+
                 except RateLimitError as e:
                     logger.warning(f"Rate limit error: {e}")
                     continue
@@ -319,10 +329,7 @@ class LLMUsage(ScopedConfig):
                 logger.error(f"Failed to validate the response after {max_validations} attempts.")
             return default
 
-        if isinstance(question, str):
-            return await _inner(question)
-
-        return await gather(*[_inner(q) for q in question])
+        return await (gather(*[_inner(q) for q in question]) if isinstance(question, list) else _inner(question))
 
     async def aliststr(
         self, requirement: str, k: NonNegativeInt = 0, **kwargs: Unpack[ValidateKwargs[List[str]]]
@@ -364,7 +371,7 @@ class LLMUsage(ScopedConfig):
             **kwargs,
         )
 
-    async def awhich_pathstr(self, requirement: str, **kwargs: Unpack[ValidateKwargs[List[str]]]) -> str:
+    async def awhich_pathstr(self, requirement: str, **kwargs: Unpack[ValidateKwargs[List[str]]]) -> Optional[str]:
         """Asynchronously generates a single path string based on a given requirement.
 
         Args:
@@ -374,13 +381,14 @@ class LLMUsage(ScopedConfig):
         Returns:
             str: The validated response as a single string.
         """
-        return ok(
-            await self.apathstr(
-                requirement,
-                k=1,
-                **kwargs,
-            )
-        ).pop()
+        if paths := await self.apathstr(
+            requirement,
+            k=1,
+            **kwargs,
+        ):
+            return paths.pop()
+
+        return None
 
     async def ageneric_string(self, requirement: str, **kwargs: Unpack[ValidateKwargs[str]]) -> Optional[str]:
         """Asynchronously generates a generic string based on a given requirement.

{fabricatio-0.2.7.dev0.dist-info → fabricatio-0.2.7.dev1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.2.7.dev0
+Version: 0.2.7.dev1
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3.12
@@ -24,9 +24,13 @@ Requires-Dist: questionary>=2.1.0
 Requires-Dist: regex>=2024.11.6
 Requires-Dist: rich>=13.9.4
 Requires-Dist: pymilvus>=2.5.4 ; extra == 'rag'
-Requires-Dist: fabricatio[rag] ; extra == 'full'
+Requires-Dist: fabricatio[calc,plot,rag] ; extra == 'full'
+Requires-Dist: sympy>=1.13.3 ; extra == 'calc'
+Requires-Dist: matplotlib>=3.10.1 ; extra == 'plot'
 Provides-Extra: rag
 Provides-Extra: full
+Provides-Extra: calc
+Provides-Extra: plot
 License-File: LICENSE
 Summary: A LLM multi-agent framework.
 Keywords: ai,agents,multi-agent,llm,pyo3

{fabricatio-0.2.7.dev0.dist-info → fabricatio-0.2.7.dev1.dist-info}/RECORD

@@ -1,16 +1,16 @@
-fabricatio-0.2.7.dev0.dist-info/METADATA,sha256=UGoqkmyaQYHhvOsskZl8ReMV59mpzz--X3w0sbYKhW0,14085
-fabricatio-0.2.7.dev0.dist-info/WHEEL,sha256=mDFV3bKFgwlxLHvOsPqpR9up9dUKYzsUQNKBdkW5c08,94
-fabricatio-0.2.7.dev0.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
-fabricatio/actions/article.py,sha256=c2dKJIQiyhF2UJOVQMSzTJs8ykY4j_secTxyhem4ldI,4553
-fabricatio/actions/output.py,sha256=KSSLvEvXsA10ACN2mbqGo98QwKLVUAoMUJNKYk6HhGc,645
+fabricatio-0.2.7.dev1.dist-info/METADATA,sha256=rbtzXxw7C4TQhFkrr8L-0M_EbrmJV3VKDgJEMX5ewgs,14236
+fabricatio-0.2.7.dev1.dist-info/WHEEL,sha256=mDFV3bKFgwlxLHvOsPqpR9up9dUKYzsUQNKBdkW5c08,94
+fabricatio-0.2.7.dev1.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
+fabricatio/actions/article.py,sha256=m35NoNcnc2vPnAT9Ya3xtBFTUr52K8ymqPUSq6AQDpQ,5309
+fabricatio/actions/output.py,sha256=K7xsBH8MjXRH6JOy3ZO94KCQzX2jNrwPPK_rRXVkS0E,1161
 fabricatio/actions/rag.py,sha256=QBdzEM8MloM_ahx5pTBZAETm9_631lTe_0ih_he_Iuo,2759
-fabricatio/capabilities/correct.py,sha256=rrz1ItQ2KlxbGCpUJ14AsX2_IPan9PthuDbt59XRyWk,5226
+fabricatio/capabilities/correct.py,sha256=8GOU2VBPUakjG-r59SqsCgCD0QHX-l__IynCLO-ib8Q,6482
 fabricatio/capabilities/propose.py,sha256=y3kge5g6bb8HYuV8e9h4MdqOMTlsfAIZpqE_cagWPTY,1593
-fabricatio/capabilities/rag.py,sha256=2SG_O1qkUeYAS5hy3FsgKFtyuaAGHseSflZYL3-2hB0,16461
-fabricatio/capabilities/rating.py,sha256=R9otyZVE2E3kKxrOCTZMeesBCPbC-fSb7bXgZPMQzfU,14406
+fabricatio/capabilities/rag.py,sha256=XVvfH6rcog-moj1WCgwtR-l0-NdbFR6-fMQFLG7_asY,17690
+fabricatio/capabilities/rating.py,sha256=vzEWOjGXmcZcw-bHtOWba0VojONU1Toy015o9H42RLQ,14438
 fabricatio/capabilities/review.py,sha256=zETLiWBU0sJ_xHGyDMpTIItofaEieLyv0eSZGqEjDT4,11106
-fabricatio/capabilities/task.py,sha256=UN-Ft4A8x2qGRFA3FQDkJ18p7mFizlBGpGHclfCOqxA,4623
-fabricatio/config.py,sha256=3lIblK-aEjdwQkTVYRDm8_u3xinjsn6NudFspNn2cp4,16757
+fabricatio/capabilities/task.py,sha256=vtS0YOe639vN8iTrkP2WK0AJVCr5N_JAaJuvRGyY2Fg,4639
+fabricatio/config.py,sha256=hUv5XMzOkEw8cQjsVHTpPPix52IKwmxjBsZM6Px3xZI,16915
 fabricatio/core.py,sha256=VQ_JKgUGIy2gZ8xsTBZCdr_IP7wC5aPg0_bsOmjQ588,6458
 fabricatio/decorators.py,sha256=uzsP4tFKQNjDHBkofsjjoJA0IUAaYOtt6YVedoyOqlo,6551
 fabricatio/fs/curd.py,sha256=N6l2MncjrFfnXBRtteRouXp5Rjy8EAKC_i29_G-zz98,4618
@@ -19,13 +19,13 @@ fabricatio/fs/__init__.py,sha256=PCf0s_9KDjVfNw7AfPoJzGt3jMq4gJOfbcT4pb0D0ZY,588
 fabricatio/journal.py,sha256=stnEP88aUBA_GmU9gfTF2EZI8FS2OyMLGaMSTgK4QgA,476
 fabricatio/models/action.py,sha256=6gffWv8NKw5HwtbmNimWfD5AZqQRzBV-PgAICHq7ZYU,8608
 fabricatio/models/events.py,sha256=QvlnS8FEELg6KNabcJMeh2GV_y0ZBzKOPphcteKYWYU,4183
-fabricatio/models/extra.py,sha256=inW8q3axFtn_NBNJsb29wjadsczBesT87SYju_g2e1E,27776
-fabricatio/models/generic.py,sha256=IdPJMf3qxZFq8yqd6OuAYKfCM0wBlJkozgxvxQZVEEc,14025
-fabricatio/models/kwargs_types.py,sha256=H6DI3Jdben-FER_kx7owiRzmbSFKuu0sFjCADA1LJB0,5008
+fabricatio/models/extra.py,sha256=QuN4pv80DApjzU1Jny03Dib8bu7ff5YXZs7yMzVhH30,28176
+fabricatio/models/generic.py,sha256=vS7klUD4FMsRfdwWCskN0qtsEGcNUAQGJwp6dMvFHjU,15715
+fabricatio/models/kwargs_types.py,sha256=J8Ct2_toefwehGfPi6ttSPd2AvqnZXpKGNZdhhv1UuA,5433
 fabricatio/models/role.py,sha256=mmQbJ6GKr2Gx3wtjEz8d-vYoXs09ffcEkT_eCXaDd3E,2782
 fabricatio/models/task.py,sha256=8NaR7ojQWyM740EDTqt9stwHKdrD6axCRpLKo0QzS-I,10492
 fabricatio/models/tool.py,sha256=kD0eB7OxO9geZOxO6JIKvCBeG-KOpRAkfRZqK_WGfW4,7105
-fabricatio/models/usages.py,sha256=yHEMi7xSRvv3RqIynIf3HtlWtbmnWT9DSC9V0sVlCQ8,31086
+fabricatio/models/usages.py,sha256=LvU3Zfy3TZp6dwxWczRw9sb2c7xleqhsGscZ9gymf_0,31453
 fabricatio/models/utils.py,sha256=NyIS82Gex4Q9qs6pzys5HplQ6JJXOLJBj4OkMPZYioc,5910
 fabricatio/parser.py,sha256=9Jzw-yV6uKbFvf6sPna-XHdziVGVBZWvPctgX_6ODL8,6251
 fabricatio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -34,9 +34,9 @@ fabricatio/toolboxes/fs.py,sha256=l4L1CVxJmjw9Ld2XUpIlWfV0_Fu_2Og6d3E13I-S4aE,73
 fabricatio/toolboxes/__init__.py,sha256=KBJi5OG_pExscdlM7Bnt_UF43j4I3Lv6G71kPVu4KQU,395
 fabricatio/workflows/articles.py,sha256=G5HGRr-DHuYuEcfhFdFAuDvTTJ9aSU_UQ2yYXEjTMtM,1047
 fabricatio/workflows/rag.py,sha256=-YYp2tlE9Vtfgpg6ROpu6QVO8j8yVSPa6yDzlN3qVxs,520
-fabricatio/_rust.pyi,sha256=eawBfpyGrB-JtOh4I6RSbjFSq83SSl-0syBeZ-g8270,3491
+fabricatio/_rust.pyi,sha256=dGTGV7viu3YAGl1cRKIWrdHPc1hlwk3_hbaDaswxdVo,3831
 fabricatio/_rust_instances.py,sha256=2GwF8aVfYNemRI2feBzH1CZfBGno-XJJE5imJokGEYw,314
 fabricatio/__init__.py,sha256=SzBYsRhZeL77jLtfJEjmoHOSwHwUGyvMATX6xfndLDM,1135
-fabricatio/_rust.cp39-win_amd64.pyd,sha256=tQwnKZ33cdWkqDb02n8tIfFR5a_o7V-PyOKBQ84ZEOc,1830400
-fabricatio-0.2.7.dev0.data/scripts/tdown.exe,sha256=KMZaVXOnadUI1DiSZsxx_KGSu2MySqf8fBsr_mJyzKU,3405824
-fabricatio-0.2.7.dev0.dist-info/RECORD,,
+fabricatio/_rust.cp39-win_amd64.pyd,sha256=v28StThnbVVewtNPoW6XDKZ004F-CB0y7aRUcHATz-s,1840128
+fabricatio-0.2.7.dev1.data/scripts/tdown.exe,sha256=1BjZ8Iu_BgKhjSg9nH8BdSHfCjIYNq50DfaKWsomKxA,3401728
+fabricatio-0.2.7.dev1.dist-info/RECORD,,