fabricatio 0.2.11.dev1__tar.gz → 0.2.11.dev3__tar.gz

{fabricatio-0.2.11.dev1 → fabricatio-0.2.11.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.2.11.dev1
+Version: 0.2.11.dev3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3.12
@@ -20,18 +20,20 @@ Requires-Dist: pydantic-settings>=2.7.1
 Requires-Dist: pymitter>=1.0.0
 Requires-Dist: rich>=13.9.4
 Requires-Dist: ujson>=5.10.0
-Requires-Dist: fabricatio[calc,ftd,plot,qa,rag] ; extra == 'full'
+Requires-Dist: fabricatio[calc,ftd,plot,qa,rag,cli] ; extra == 'full'
 Requires-Dist: pymilvus>=2.5.4 ; extra == 'rag'
 Requires-Dist: sympy>=1.13.3 ; extra == 'calc'
 Requires-Dist: matplotlib>=3.10.1 ; extra == 'plot'
 Requires-Dist: questionary>=2.1.0 ; extra == 'qa'
 Requires-Dist: magika>=0.6.1 ; extra == 'ftd'
+Requires-Dist: typer-slim[standard]>=0.15.2 ; extra == 'cli'
 Provides-Extra: full
 Provides-Extra: rag
 Provides-Extra: calc
 Provides-Extra: plot
 Provides-Extra: qa
 Provides-Extra: ftd
+Provides-Extra: cli
 License-File: LICENSE
 Summary: A LLM multi-agent framework.
 Keywords: ai,agents,multi-agent,llm,pyo3

fabricatio-0.2.11.dev3/examples/write_article/write_article.py

@@ -0,0 +1,140 @@
+"""Example of using the library."""
+
+import asyncio
+from pathlib import Path
+
+import typer
+from fabricatio import Event, Role, WorkFlow, logger
+from fabricatio.actions.article import ExtractOutlineFromRaw, GenerateArticleProposal, GenerateInitialOutline
+from fabricatio.actions.article_rag import WriteArticleContentRAG
+from fabricatio.actions.output import (
+    DumpFinalizedOutput,
+    PersistentAll,
+)
+from fabricatio.models.task import Task
+from fabricatio.utils import ok
+from typer import Typer
+
+Role(
+    name="Undergraduate Researcher",
+    description="Write an outline for an article in typst format.",
+    llm_model="openai/qwen-max",
+    llm_temperature=0.63,
+    llm_stream=True,
+    llm_top_p=0.85,
+    llm_max_tokens=8191,
+    llm_rpm=600,
+    llm_tpm=900000,
+    registry={
+        Event.quick_instantiate(ns := "article"): WorkFlow(
+            name="Generate Article",
+            description="Generate an article. dump the outline to the given path. in typst format.",
+            steps=(
+                GenerateArticleProposal,
+                GenerateInitialOutline(output_key="article_outline"),
+                PersistentAll,
+                WriteArticleContentRAG(
+                    output_key="to_dump",
+                    llm_top_p=0.9,
+                    ref_limit=35,
+                    llm_model="openai/qwq-plus",
+                    target_collection="article_chunks",
+                    extractor_model="openai/qwen-plus",
+                    query_model="openai/qwen-max",
+                ),
+                DumpFinalizedOutput(output_key="task_output"),
+                PersistentAll,
+            ),
+        ),
+        Event.quick_instantiate(ns2 := ""): WorkFlow(
+            name="Generate Article",
+            description="Generate an article with given raw article outline. dump the outline to the given path. in typst format.",
+            steps=(
+                ExtractOutlineFromRaw,
+                PersistentAll,
+                WriteArticleContentRAG(
+                    output_key="to_dump",
+                    llm_top_p=0.9,
+                    ref_limit=35,
+                    llm_model="openai/qwq-plus",
+                    target_collection="article_chunks",
+                    extractor_model="openai/qwen-plus",
+                    query_model="openai/qwen-max",
+                ),
+                DumpFinalizedOutput(output_key="task_output"),
+                PersistentAll,
+            ),
+        ),
+    },
+)
+
+
+app = Typer()
+
+
+@app.command()
+def completion(
+    article_outline_raw_path: Path = typer.Option(  # noqa: B008
+        Path("article_outline_raw.txt"), "-a", "--article-outline-raw", help="Path to the article outline raw file."
+    ),
+    dump_path: Path = typer.Option(Path("out.typ"), "-d", "--dump-path", help="Path to dump the final output."),  # noqa: B008
+    persist_dir: Path = typer.Option(  # noqa: B008
+        Path("persistent"), "-p", "--persist-dir", help="Directory to persist the output."
+    ),
+    collection_name: str = typer.Option("article_chunks", "-c", "--collection-name", help="Name of the collection."),
+    supervisor: bool = typer.Option(False, "-s", "--supervisor", help="Whether to use the supervisor mode."),
+) -> None:
+    """Write an article based on a raw article outline."""
+    path = ok(
+        asyncio.run(
+            Task(name="write an article")
+            .update_init_context(
+                article_outline_raw_path=article_outline_raw_path,
+                dump_path=dump_path,
+                persist_dir=persist_dir,
+                collection_name=collection_name,
+                supervisor=supervisor,
+            )
+            .delegate(ns)
+        ),
+        "Failed to generate an article ",
+    )
+    logger.success(f"The outline is saved in:\n{path}")
+
+
+@app.command()
+def write(
+    article_briefing: Path = typer.Option(  # noqa: B008
+        Path("article_briefing.txt"), "-a", "--article-briefing", help="Path to the article briefing file."
+    ),
+    dump_path: Path = typer.Option(Path("out.typ"), "-d", "--dump-path", help="Path to dump the final output."),  # noqa: B008
+    persist_dir: Path = typer.Option(  # noqa: B008
+        Path("persistent"), "-p", "--persist-dir", help="Directory to persist the output."
+    ),
+    collection_name: str = typer.Option("article_chunks", "-c", "--collection-name", help="Name of the collection."),
+    supervisor: bool = typer.Option(False, "-s", "--supervisor", help="Whether to use the supervisor mode."),
+) -> None:
+    """Write an article based on a briefing.
+
+    This function generates an article outline and content based on the provided briefing.
+    The outline and content are then dumped to the specified path and persisted in the given directory.
+    """
+    path = ok(
+        asyncio.run(
+            Task(name="write an article")
+            .update_init_context(
+                article_briefing=article_briefing.read_text(),
+                dump_path=dump_path,
+                persist_dir=persist_dir,
+                collection_name=collection_name,
+                supervisor=supervisor,
+            )
+            .delegate(ns)
+        ),
+        "Failed to generate an article ",
+    )
+    logger.success(f"The outline is saved in:\n{path}")
+
+
+if __name__ == "__main__":
+    app()

{fabricatio-0.2.11.dev1 → fabricatio-0.2.11.dev3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fabricatio"
-version = "0.2.11-dev1"
+version = "0.2.11-dev3"
 description = "A LLM multi-agent framework."
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -74,7 +74,7 @@ dev = [
 
 [project.optional-dependencies]
 full = [
-    "fabricatio[calc,ftd,plot,qa,rag]",
+    "fabricatio[calc,ftd,plot,qa,rag,cli]",
 ]
 rag = [
     "pymilvus>=2.5.4",
@@ -92,6 +92,9 @@ qa = [
 ftd = [
     "magika>=0.6.1",
 ]
+cli = [
+    "typer-slim[standard]>=0.15.2",
+]
 
 [tool.ruff]
 include = ["pyproject.toml", "python/fabricatio/*.py", "python/fabricatio/*.pyi", "examples/*.py"]

{fabricatio-0.2.11.dev1 → fabricatio-0.2.11.dev3}/python/fabricatio/actions/article.py

@@ -149,10 +149,10 @@ class GenerateInitialOutline(Action, Extract):
     async def _execute(
         self,
         article_proposal: ArticleProposal,
+        supervisor: Optional[bool] = None,
         **_,
     ) -> Optional[ArticleOutline]:
-        raw_outline = await self.aask(
-            f"{(article_proposal.as_prompt())}\n"
+        req = (
             f"Design each chapter of a proper and academic and ready for release manner.\n"
             f"You Must make sure every chapter have sections, and every section have subsections.\n"
             f"Make the chapter and sections and subsections bing divided into a specific enough article component.\n"
@@ -160,14 +160,16 @@ class GenerateInitialOutline(Action, Extract):
             f"Note that you SHALL use `{article_proposal.language}` as written language",
         )
 
-        if self.supervisor:
+        raw_outline = await self.aask(f"{(article_proposal.as_prompt())}\n{req}")
+
+        if supervisor or (supervisor is None and self.supervisor):
             from questionary import confirm, text
 
             r_print(raw_outline)
             while not await confirm("Accept this version and continue?", default=True).ask_async():
                 imp = await text("Enter the improvement:").ask_async()
                 raw_outline = await self.aask(
-                    f"{article_proposal.as_prompt()}\n{wrapp_in_block(raw_outline, 'Previous ArticleOutline')}\n{imp}"
+                    f"{article_proposal.as_prompt()}\n{wrapp_in_block(raw_outline, 'Previous ArticleOutline')}\n{req}\n{wrapp_in_block(imp, title='Improvement')}"
                 )
                 r_print(raw_outline)
 
@@ -177,6 +179,20 @@ class GenerateInitialOutline(Action, Extract):
         ).update_ref(article_proposal)
 
 
+class ExtractOutlineFromRaw(Action, Extract):
+    """Extract the outline from the raw outline."""
+
+    output_key: str = "article_outline_from_raw"
+
+    async def _execute(self, article_outline_raw_path: str | Path, **cxt) -> ArticleOutline:
+        logger.info(f"Extracting outline from raw: {Path(article_outline_raw_path).as_posix()}")
+
+        return ok(
+            await self.extract(ArticleOutline, safe_text_read(article_outline_raw_path)),
+            "Could not extract the outline from raw.",
+        )
+
+
 class FixIntrospectedErrors(Action, Censor):
     """Fix introspected errors in the article outline."""
 

{fabricatio-0.2.11.dev1 → fabricatio-0.2.11.dev3}/python/fabricatio/actions/article_rag.py

@@ -8,6 +8,7 @@ from fabricatio import BibManager
 from fabricatio.capabilities.censor import Censor
 from fabricatio.capabilities.extract import Extract
 from fabricatio.capabilities.rag import RAG
+from fabricatio.decorators import precheck_package
 from fabricatio.journal import logger
 from fabricatio.models.action import Action
 from fabricatio.models.extra.aricle_rag import ArticleChunk, CitationManager
@@ -15,7 +16,7 @@ from fabricatio.models.extra.article_essence import ArticleEssence
 from fabricatio.models.extra.article_main import Article, ArticleChapter, ArticleSection, ArticleSubsection
 from fabricatio.models.extra.article_outline import ArticleOutline
 from fabricatio.models.extra.rule import RuleSet
-from fabricatio.utils import ok
+from fabricatio.utils import ask_retain, ok
 
 
 class WriteArticleContentRAG(Action, RAG, Extract):
@@ -23,11 +24,14 @@ class WriteArticleContentRAG(Action, RAG, Extract):
 
     ref_limit: int = 35
     """The limit of references to be retrieved"""
+    threshold: float = 0.55
+    """The threshold of relevance"""
     extractor_model: str
     """The model to use for extracting the content from the retrieved references."""
     query_model: str
     """The model to use for querying the database"""
-
+    supervisor: bool = False
+    """Whether to use supervisor mode"""
     req: str = (
         "citation number is REQUIRED to cite any reference!\n"
         "Everything is build upon the typst language, which is similar to latex, \n"
@@ -40,31 +44,75 @@ class WriteArticleContentRAG(Action, RAG, Extract):
         "you can refer to that label by using the syntax with prefix of `@eqt:`"
         "Below is a usage example:\n"
         "```typst\n"
-        "See @eqt:mass-energy-equation , it's the equation.\n"
+        "See @eqt:mass-energy-equation , it's the foundation of physics.\n"
         "$$\n"
         "E = m c^2"
         "$$\n"
-        "<mass-energy-equation>"
-        "In @eqt:mass-energy-equation , we get the foundation of physics.\n"
+        "<mass-energy-equation>\n\n"
+        "In @eqt:mass-energy-equation , $m$ stands for mass, $c$ stands for speed of light, and $E$ stands for energy. \n"
         "```"
     )
 
     async def _execute(
         self,
         article_outline: ArticleOutline,
-        writing_ruleset: RuleSet,
         collection_name: str = "article_chunks",
+        supervisor: Optional[bool] = None,
         **cxt,
     ) -> Article:
         article = Article.from_outline(article_outline).update_ref(article_outline)
-        await gather(
-            *[
-                self._inner(article, article_outline, chap, sec, subsec)
-                for chap, sec, subsec in article.iter_subsections()
-            ]
-        )
+
+        if supervisor or (supervisor is None and self.supervisor):
+            await gather(
+                *[
+                    self._supervisor_inner(article, article_outline, chap, sec, subsec)
+                    for chap, sec, subsec in article.iter_subsections()
+                ]
+            )
+        else:
+            await gather(
+                *[
+                    self._inner(article, article_outline, chap, sec, subsec)
+                    for chap, sec, subsec in article.iter_subsections()
+                ]
+            )
         return article.convert_tex()
 
+    @precheck_package(
+        "questionary", "`questionary` is required for supervisor mode, please install it by `fabricatio[qa]`"
+    )
+    async def _supervisor_inner(
+        self,
+        article: Article,
+        article_outline: ArticleOutline,
+        chap: ArticleChapter,
+        sec: ArticleSection,
+        subsec: ArticleSubsection,
+    ) -> ArticleSubsection:
+        from questionary import confirm, text
+        from rich import print as r_print
+
+        ret = await self.search_database(article, article_outline, chap, sec, subsec)
+
+        cm = CitationManager(article_chunks=await ask_retain([r.chunk for r in ret], ret)).set_cite_number_all()
+
+        raw = await self.write_raw(article, article_outline, chap, sec, subsec, cm)
+        r_print(raw)
+
+        while not await confirm("Accept this version and continue?").ask_async():
+            if await confirm("Search for more refs?").ask_async():
+                new_refs = await self.search_database(article, article_outline, chap, sec, subsec, supervisor=True)
+                cm.add_chunks(await ask_retain([r.chunk for r in new_refs], new_refs))
+
+            instruction = await text("Enter the instructions to improve").ask_async()
+            raw = await self.write_raw(article, article_outline, chap, sec, subsec, cm, instruction)
+            if await confirm("Edit it?").ask_async():
+                raw = await text("Edit", default=raw).ask_async() or raw
+
+            r_print(raw)
+
+        return await self.extract_new_subsec(subsec, raw, cm)
+
     async def _inner(
         self,
         article: Article,
@@ -73,35 +121,17 @@ class WriteArticleContentRAG(Action, RAG, Extract):
         sec: ArticleSection,
         subsec: ArticleSubsection,
     ) -> ArticleSubsection:
-        ref_q = ok(
-            await self.arefined_query(
-                f"{article_outline.display()}\n\nAbove is my article outline, I m writing graduate thesis titled `{article.title}`. "
-                f"More specifically, i m witting the Chapter `{chap.title}` >> Section `{sec.title}` >> Subsection `{subsec.title}`.\n"
-                f"I need to search related references to build up the content of the subsec mentioned above, which is `{subsec.title}`.\n"
-                f"plus, you can search required formulas by using latex equation code.\n"
-                f"provide 10 queries as possible, to get best result!\n"
-                f"You should provide both English version and chinese version of the refined queries!\n",
-                model=self.query_model,
-            ),
-            "Failed to refine query.",
-        )
-        ret = await self.aretrieve(ref_q, ArticleChunk, final_limit=self.ref_limit, result_per_query=6)
-        ret.reverse()
-        cm = CitationManager().update_chunks(ret)
-
-        raw_paras = await self.aask(
-            f"{cm.as_prompt()}\nAbove is some related reference retrieved for you."
-            f"{article.referenced.display()}\n\nAbove is my article outline, I m writing graduate thesis titled `{article.title}`. "
-            f"More specifically, i m witting the Chapter `{chap.title}` >> Section `{sec.title}` >> Subsection `{subsec.title}`.\n"
-            f"Please help me write the paragraphs of the subsec mentioned above, which is `{subsec.title}`.\n"
-            f"{self.req}\n"
-            f"You SHALL use `{article.language}` as writing language."
-        )
+        ret = await self.search_database(article, article_outline, chap, sec, subsec)
+        cm = CitationManager(article_chunks=ret).set_cite_number_all()
 
-        raw_paras = (
-            raw_paras.replace(r" \( ", "$").replace(r" \) ", "$").replace("\\[\n", "$$\n").replace("\n\\]", "\n$$")
-        )
+        raw_paras = await self.write_raw(article, article_outline, chap, sec, subsec, cm)
+
+        return await self.extract_new_subsec(subsec, raw_paras, cm)
 
+    async def extract_new_subsec(
+        self, subsec: ArticleSubsection, raw_paras: str, cm: CitationManager
+    ) -> ArticleSubsection:
+        """Extract the new subsec."""
         new_subsec = ok(
             await self.extract(
                 ArticleSubsection,
@@ -112,14 +142,72 @@ class WriteArticleContentRAG(Action, RAG, Extract):
             ),
             "Failed to propose new subsection.",
         )
-
         for p in new_subsec.paragraphs:
             p.content = cm.apply(p.content).replace("$$", "\n$$\n")
-
         subsec.update_from(new_subsec)
         logger.debug(f"{subsec.title}:rpl\n{subsec.display()}")
         return subsec
 
+    async def write_raw(
+        self,
+        article: Article,
+        article_outline: ArticleOutline,
+        chap: ArticleChapter,
+        sec: ArticleSection,
+        subsec: ArticleSubsection,
+        cm: CitationManager,
+        extra_instruction: str = "",
+    ) -> str:
+        """Write the raw paragraphs of the subsec."""
+        return (
+            (
+                await self.aask(
+                    f"{cm.as_prompt()}\nAbove is some related reference retrieved for you."
+                    f"{article_outline.finalized_dump()}\n\nAbove is my article outline, I m writing graduate thesis titled `{article.title}`. "
+                    f"More specifically, i m witting the Chapter `{chap.title}` >> Section `{sec.title}` >> Subsection `{subsec.title}`.\n"
+                    f"Please help me write the paragraphs of the subsec mentioned above, which is `{subsec.title}`.\n"
+                    f"{self.req}\n"
+                    f"You SHALL use `{article.language}` as writing language.\n{extra_instruction}"
+                )
+            )
+            .replace(r" \( ", "$")
+            .replace(r" \) ", "$")
+            .replace(r"\(", "$")
+            .replace(r"\)", "$")
+            .replace("\\[\n", "$$\n")
+            .replace("\n\\]", "\n$$")
+        )
+
+    async def search_database(
+        self,
+        article: Article,
+        article_outline: ArticleOutline,
+        chap: ArticleChapter,
+        sec: ArticleSection,
+        subsec: ArticleSubsection,
+        extra_instruction: str = "",
+        supervisor: bool = False,
+    ) -> List[ArticleChunk]:
+        """Search database for related references."""
+        ref_q = ok(
+            await self.arefined_query(
+                f"{article_outline.finalized_dump()}\n\nAbove is my article outline, I m writing graduate thesis titled `{article.title}`. "
+                f"More specifically, i m witting the Chapter `{chap.title}` >> Section `{sec.title}` >> Subsection `{subsec.title}`.\n"
+                f"I need to search related references to build up the content of the subsec mentioned above, which is `{subsec.title}`.\n"
+                f"provide 10~16 queries as possible, to get best result!\n"
+                f"You should provide both English version and chinese version of the refined queries!\n{extra_instruction}\n",
+                model=self.query_model,
+            ),
+            "Failed to refine query.",
+        )
+
+        if supervisor:
+            ref_q = await ask_retain(ref_q)
+
+        return await self.aretrieve(
+            ref_q, ArticleChunk, final_limit=self.ref_limit, result_per_query=3, similarity_threshold=self.threshold
+        )
+
 
 class TweakArticleRAG(Action, RAG, Censor):
     """Write an article based on the provided outline.

{fabricatio-0.2.11.dev1 → fabricatio-0.2.11.dev3}/python/fabricatio/decorators.py

@@ -6,7 +6,7 @@ from importlib.util import find_spec
 from inspect import signature
 from shutil import which
 from types import ModuleType
-from typing import Callable, List, Optional
+from typing import Callable, Coroutine, List, Optional
 
 from fabricatio.config import configs
 from fabricatio.journal import logger
@@ -23,7 +23,20 @@ def precheck_package[**P, R](package_name: str, msg: str) -> Callable[[Callable[
         bool: True if the package exists, False otherwise.
     """
 
-    def _wrapper(func: Callable[P, R]) -> Callable[P, R]:
+    def _wrapper(
+        func: Callable[P, R] | Callable[P, Coroutine[None, None, R]],
+    ) -> Callable[P, R] | Callable[P, Coroutine[None, None, R]]:
+        if iscoroutinefunction(func):
+
+            @wraps(func)
+            async def _async_inner(*args: P.args, **kwargs: P.kwargs) -> R:
+                if find_spec(package_name):
+                    return await func(*args, **kwargs)
+                raise RuntimeError(msg)
+
+            return _async_inner
+
+        @wraps(func)
         def _inner(*args: P.args, **kwargs: P.kwargs) -> R:
             if find_spec(package_name):
                 return func(*args, **kwargs)
@@ -35,7 +48,7 @@ def precheck_package[**P, R](package_name: str, msg: str) -> Callable[[Callable[
 
 
 def depend_on_external_cmd[**P, R](
-        bin_name: str, install_tip: Optional[str], homepage: Optional[str] = None
+    bin_name: str, install_tip: Optional[str], homepage: Optional[str] = None
 ) -> Callable[[Callable[P, R]], Callable[P, R]]:
     """Decorator to check for the presence of an external command.
 
@@ -88,8 +101,9 @@ def logging_execution_info[**P, R](func: Callable[P, R]) -> Callable[P, R]:
     return _wrapper
 
 
-@precheck_package("questionary",
-                  "'questionary' is required to run this function. Have you installed `fabricatio[qa]`?.")
+@precheck_package(
+    "questionary", "'questionary' is required to run this function. Have you installed `fabricatio[qa]`?."
+)
 def confirm_to_execute[**P, R](func: Callable[P, R]) -> Callable[P, Optional[R]] | Callable[P, R]:
     """Decorator to confirm before executing a function.
 
@@ -109,8 +123,8 @@ def confirm_to_execute[**P, R](func: Callable[P, R]) -> Callable[P, Optional[R]]
         @wraps(func)
         async def _wrapper(*args: P.args, **kwargs: P.kwargs) -> Optional[R]:
             if await confirm(
-                    f"Are you sure to execute function: {func.__name__}{signature(func)} \n📦 Args:{args}\n🔑 Kwargs:{kwargs}\n",
-                    instruction="Please input [Yes/No] to proceed (default: Yes):",
+                f"Are you sure to execute function: {func.__name__}{signature(func)} \n📦 Args:{args}\n🔑 Kwargs:{kwargs}\n",
+                instruction="Please input [Yes/No] to proceed (default: Yes):",
             ).ask_async():
                 return await func(*args, **kwargs)
             logger.warning(f"Function: {func.__name__}{signature(func)} canceled by user.")
@@ -121,8 +135,8 @@ def confirm_to_execute[**P, R](func: Callable[P, R]) -> Callable[P, Optional[R]]
         @wraps(func)
         def _wrapper(*args: P.args, **kwargs: P.kwargs) -> Optional[R]:
             if confirm(
-                    f"Are you sure to execute function: {func.__name__}{signature(func)} \n📦 Args:{args}\n��� Kwargs:{kwargs}\n",
-                    instruction="Please input [Yes/No] to proceed (default: Yes):",
+                f"Are you sure to execute function: {func.__name__}{signature(func)} \n📦 Args:{args}\n��� Kwargs:{kwargs}\n",
+                instruction="Please input [Yes/No] to proceed (default: Yes):",
             ).ask():
                 return func(*args, **kwargs)
             logger.warning(f"Function: {func.__name__}{signature(func)} canceled by user.")
@@ -203,7 +217,9 @@ def use_temp_module[**P, R](modules: ModuleType | List[ModuleType]) -> Callable[
     return _decorator
 
 
-def logging_exec_time[**P, R](func: Callable[P, R]) -> Callable[P, R]:
+def logging_exec_time[**P, R](
+    func: Callable[P, R] | Callable[P, Coroutine[None, None, R]],
+) -> Callable[P, R] | Callable[P, Coroutine[None, None, R]]:
     """Decorator to log the execution time of a function.
 
     Args:
@@ -215,6 +231,7 @@ def logging_exec_time[**P, R](func: Callable[P, R]) -> Callable[P, R]:
     from time import time
 
     if iscoroutinefunction(func):
+
         @wraps(func)
         async def _async_wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
             start_time = time()

{fabricatio-0.2.11.dev1 → fabricatio-0.2.11.dev3}/python/fabricatio/models/action.py

@@ -18,6 +18,7 @@ from fabricatio.journal import logger
 from fabricatio.models.generic import WithBriefing
 from fabricatio.models.task import Task
 from fabricatio.models.usages import LLMUsage, ToolBoxUsage
+from fabricatio.utils import override_kwargs
 from pydantic import Field, PrivateAttr
 
 OUTPUT_KEY = "task_output"
@@ -55,7 +56,7 @@ class Action(WithBriefing, LLMUsage):
         self.description = self.description or self.__class__.__doc__ or ""
 
     @abstractmethod
-    async def _execute(self, *_:Any, **cxt) -> Any:
+    async def _execute(self, *_: Any, **cxt) -> Any:
         """Implement the core logic of the action.
 
         Args:
@@ -95,11 +96,12 @@ class Action(WithBriefing, LLMUsage):
             return f"## Your personality: \n{self.personality}\n# The action you are going to perform: \n{super().briefing}"
         return f"# The action you are going to perform: \n{super().briefing}"
 
-    def to_task_output(self)->Self:
+    def to_task_output(self) -> Self:
         """Set the output key to OUTPUT_KEY and return the action instance."""
-        self.output_key=OUTPUT_KEY
+        self.output_key = OUTPUT_KEY
         return self
 
+
 class WorkFlow(WithBriefing, ToolBoxUsage):
     """Manages sequences of actions to fulfill tasks.
 
@@ -177,7 +179,7 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
         current_action = None
         try:
             # Process each action in sequence
-            for i,step in enumerate(self._instances):
+            for i, step in enumerate(self._instances):
                 current_action = step.name
                 logger.info(f"Executing step [{i}] >> {current_action}")
 
@@ -227,8 +229,13 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
             - Any extra_init_context values
         """
         logger.debug(f"Initializing context for workflow: {self.name}")
-        initial_context = {self.task_input_key: task, **dict(self.extra_init_context)}
-        await self._context.put(initial_context)
+        ctx = override_kwargs(self.extra_init_context, **task.extra_init_context)
+        if self.task_input_key in ctx:
+            raise ValueError(
+                f"Task input key: `{self.task_input_key}`, which is reserved, is already set in the init context"
+            )
+
+        await self._context.put({self.task_input_key: task, **ctx})
 
     def steps_fallback_to_self(self) -> Self:
         """Configure all steps to use this workflow's configuration as fallback.
@@ -245,7 +252,7 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
         Returns:
             Self: The workflow instance for method chaining.
         """
-        self.provide_tools_to(i for i in self._instances if isinstance(i,ToolBoxUsage))
+        self.provide_tools_to(i for i in self._instances if isinstance(i, ToolBoxUsage))
         return self
 
     def update_init_context(self, /, **kwargs) -> Self:

{fabricatio-0.2.11.dev1 → fabricatio-0.2.11.dev3}/python/fabricatio/models/extra/aricle_rag.py

@@ -190,6 +190,12 @@ class CitationManager(AsPrompt):
             self.set_cite_number_all()
         return self
 
+    def add_chunks(self, article_chunks: List[ArticleChunk], set_cite_number: bool = True)-> Self:
+        """Add article chunks."""
+        self.article_chunks.extend(article_chunks)
+        if set_cite_number:
+            self.set_cite_number_all()
+        return self
     def set_cite_number_all(self) -> Self:
         """Set citation numbers for all article chunks."""
         for i, a in enumerate(self.article_chunks, 1):