fabricatio 0.3.13__tar.gz → 0.3.14.dev1__tar.gz

{fabricatio-0.3.13 → fabricatio-0.3.14.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.3.13
+Version: 0.3.14.dev1
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3.12
@@ -86,7 +86,7 @@ make bdist
 
 ```python
 import asyncio
-from fabricatio import Action, Role, Task, logger, WorkFlow
+from fabricatio import Action, Role, Task, logger, WorkFlow, Event
 from typing import Any
 
 
@@ -101,14 +101,14 @@ class Hello(Action):
 
 
 async def main() -> None:
-    role = Role(
+    Role(
         name="talker",
         description="talker role",
-        registry={Task.pending_label: WorkFlow(name="talk", steps=(Hello,))}
+        registry={Event.quick_instantiate("talk"): WorkFlow(name="talk", steps=(Hello,))}
     )
 
-    task = Task(name="say hello", goals="say hello", description="say hello to the world")
-    result = await task.delegate()
+    task = Task(name="say hello", goals=["say hello"], description="say hello to the world")
+    result = await task.delegate("talk")
     logger.success(f"Result: {result}")
 
 
@@ -163,11 +163,11 @@ max_tokens = 8192
     ```bash
     make test
     ```
+
 ## TODO
 
 - Add an element based format strategy
 
-
 ## Contributing
 
 Contributions are welcome! Follow these steps:

{fabricatio-0.3.13 → fabricatio-0.3.14.dev1}/README.md

@@ -42,7 +42,7 @@ make bdist
 
 ```python
 import asyncio
-from fabricatio import Action, Role, Task, logger, WorkFlow
+from fabricatio import Action, Role, Task, logger, WorkFlow, Event
 from typing import Any
 
 
@@ -57,14 +57,14 @@ class Hello(Action):
 
 
 async def main() -> None:
-    role = Role(
+    Role(
         name="talker",
         description="talker role",
-        registry={Task.pending_label: WorkFlow(name="talk", steps=(Hello,))}
+        registry={Event.quick_instantiate("talk"): WorkFlow(name="talk", steps=(Hello,))}
     )
 
-    task = Task(name="say hello", goals="say hello", description="say hello to the world")
-    result = await task.delegate()
+    task = Task(name="say hello", goals=["say hello"], description="say hello to the world")
+    result = await task.delegate("talk")
     logger.success(f"Result: {result}")
 
 
@@ -119,11 +119,11 @@ max_tokens = 8192
     ```bash
     make test
     ```
+
 ## TODO
 
 - Add an element based format strategy
 
-
 ## Contributing
 
 Contributions are welcome! Follow these steps:

{fabricatio-0.3.13 → fabricatio-0.3.14.dev1}/examples/llm_usages/llm_usage.py

@@ -2,9 +2,8 @@
 
 import asyncio
 
-from fabricatio import Action, Role, Task, WorkFlow
+from fabricatio import Action, Event, Role, Task, WorkFlow
 from fabricatio.journal import logger
-from fabricatio.models.events import Event
 from fabricatio.parser import PythonCapture
 
 

{fabricatio-0.3.13 → fabricatio-0.3.14.dev1}/examples/minor/hello_fabricatio.py

@@ -3,7 +3,7 @@
 import asyncio
 from typing import Any
 
-from fabricatio import Action, Role, Task, WorkFlow, logger
+from fabricatio import Action, Event, Role, Task, WorkFlow, logger
 
 task = Task(name="say hello")
 
@@ -21,9 +21,10 @@ class Hello(Action):
 
 async def main() -> None:
     """Main function."""
-    Role(name="talker", description="talker role", registry={task.pending_label: WorkFlow(name="talk", steps=(Hello,))})
+    Role(name="talker", description="talker role",
+         registry={Event.quick_instantiate("talk"): WorkFlow(name="talk", steps=(Hello,))})
 
-    logger.success(f"Result: {await task.delegate()}")
+    logger.success(f"Result: {await task.delegate("talk")}")
 
 
 if __name__ == "__main__":

{fabricatio-0.3.13 → fabricatio-0.3.14.dev1}/examples/minor/write_a_poem.py

@@ -3,15 +3,17 @@
 import asyncio
 from typing import Any
 
-from fabricatio import Action, Role, Task, WorkFlow, logger
+from fabricatio import Action, Event, Role, Task, WorkFlow, logger
+from fabricatio.models.usages import LLMUsage
 
 task = Task(name="write poem")
 
 
-class WritePoem(Action):
+class WritePoem(Action, LLMUsage):
     """Action that generates a poem."""
 
     output_key: str = "task_output"
+    llm_stream: bool = False
 
     async def _execute(self, **_) -> Any:
         logger.info("Generating poem about the sea")
@@ -25,10 +27,10 @@ async def main() -> None:
     Role(
         name="poet",
         description="A role that creates poetic content",
-        registry={task.pending_label: WorkFlow(name="poetry_creation", steps=(WritePoem,))},
+        registry={Event.quick_instantiate(ns := 'poem'): WorkFlow(name="poetry_creation", steps=(WritePoem,))},
     )
 
-    poem = await task.delegate()
+    poem = await task.delegate(ns)
     logger.success(f"Poem:\n\n{poem}")
 
 

{fabricatio-0.3.13 → fabricatio-0.3.14.dev1}/pyproject.toml

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

{fabricatio-0.3.13 → fabricatio-0.3.14.dev1}/python/fabricatio/__init__.py

@@ -2,35 +2,29 @@
 
 from fabricatio.rust import CONFIG, TEMPLATE_MANAGER, BibManager, Event
 
-from fabricatio import actions, capabilities, toolboxes, workflows
-from fabricatio.core import env
+from fabricatio import actions, capabilities, parser, toolboxes, workflows
 from fabricatio.journal import logger
 from fabricatio.models import extra
 from fabricatio.models.action import Action, WorkFlow
 from fabricatio.models.role import Role
 from fabricatio.models.task import Task
 from fabricatio.models.tool import ToolBox
-from fabricatio.parser import Capture, GenericCapture, JsonCapture, PythonCapture
 
 __all__ = [
     "CONFIG",
     "TEMPLATE_MANAGER",
     "Action",
     "BibManager",
-    "Capture",
     "Event",
-    "GenericCapture",
-    "JsonCapture",
-    "PythonCapture",
     "Role",
     "Task",
     "ToolBox",
     "WorkFlow",
     "actions",
     "capabilities",
-    "env",
     "extra",
     "logger",
+    "parser",
     "toolboxes",
     "workflows",
 ]

{fabricatio-0.3.13 → fabricatio-0.3.14.dev1}/python/fabricatio/journal.py

@@ -4,10 +4,7 @@ import sys
 
 from fabricatio.rust import CONFIG
 from loguru import logger
-from rich import pretty, traceback
 
-pretty.install()
-traceback.install()
 logger.remove()
 logger.add(sys.stderr, level=CONFIG.debug.log_level)
 

{fabricatio-0.3.13 → fabricatio-0.3.14.dev1}/python/fabricatio/models/action.py

@@ -12,14 +12,13 @@ Classes:
 import traceback
 from abc import abstractmethod
 from asyncio import Queue, create_task
-from typing import Any, ClassVar, Dict, Self, Sequence, Tuple, Type, Union, final
+from typing import Any, ClassVar, Dict, Generator, Self, Sequence, Tuple, Type, Union, final
 
 from pydantic import Field, PrivateAttr
 
 from fabricatio.journal import logger
 from fabricatio.models.generic import WithBriefing
 from fabricatio.models.task import Task
-from fabricatio.models.usages import ToolBoxUsage
 from fabricatio.utils import override_kwargs
 
 OUTPUT_KEY = "task_output"
@@ -106,7 +105,7 @@ class Action(WithBriefing):
         return self
 
 
-class WorkFlow(WithBriefing, ToolBoxUsage):
+class WorkFlow(WithBriefing):
     """Manages sequences of actions to fulfill tasks.
 
     Handles context propagation between actions, error handling, and task lifecycle
@@ -148,6 +147,10 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
         # Convert any action classes to instances
         self._instances = tuple(step if isinstance(step, Action) else step() for step in self.steps)
 
+    def iter_actions(self) -> Generator[Action, None, None]:
+        """Iterate over action instances."""
+        yield from self._instances
+
     def inject_personality(self, personality: str) -> Self:
         """Set personality for actions without existing personality.
 
@@ -249,24 +252,6 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
 
         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.
-
-        Returns:
-            Self: The workflow instance for method chaining.
-        """
-        self.hold_to(self._instances)
-        return self
-
-    def steps_supply_tools_from_self(self) -> Self:
-        """Provide this workflow's tools to all steps in the workflow.
-
-        Returns:
-            Self: The workflow instance for method chaining.
-        """
-        self.provide_tools_to(i for i in self._instances if isinstance(i, ToolBoxUsage))
-        return self
-
     def update_init_context(self, /, **kwargs) -> Self:
         """Update the initial context with additional key-value pairs.
 

{fabricatio-0.3.13 → fabricatio-0.3.14.dev1}/python/fabricatio/models/generic.py

@@ -7,12 +7,10 @@ from typing import Any, Callable, Dict, Iterable, List, Mapping, Optional, Self,
 
 import ujson
 from fabricatio.rust import CONFIG, TEMPLATE_MANAGER, blake3_hash, detect_language
-from litellm.utils import token_counter
 from pydantic import (
     BaseModel,
     ConfigDict,
     Field,
-    HttpUrl,
     NonNegativeFloat,
     PositiveFloat,
     PositiveInt,
@@ -24,7 +22,6 @@ from pydantic.json_schema import GenerateJsonSchema, JsonSchemaValue
 from fabricatio.fs import dump_text
 from fabricatio.fs.readers import safe_text_read
 from fabricatio.journal import logger
-from fabricatio.parser import JsonCapture
 from fabricatio.utils import ok
 
 
@@ -497,6 +494,8 @@ class InstantiateFromString(Base):
         Returns:
             Self | None: The instance of the class or None if the string is not valid.
         """
+        from fabricatio.parser import JsonCapture
+
         obj = JsonCapture.convert_with(string, cls.model_validate_json)
         logger.debug(f"Instantiate `{cls.__name__}` from string, {'Failed' if obj is None else 'Success'}.")
         return obj
@@ -666,6 +665,8 @@ class Vectorizable:
         Raises:
             ValueError: If the chunk exceeds the maximum sequence length.
         """
+        from litellm.utils import token_counter
+
         max_length = max_length or CONFIG.embedding.max_sequence_length
         chunk = self._prepare_vectorization_inner()
         if max_length and (length := token_counter(text=chunk)) > max_length:
@@ -681,7 +682,7 @@ class ScopedConfig(Base):
     Allows configuration values to be overridden in a hierarchical manner.
     """
 
-    llm_api_endpoint: Optional[HttpUrl] = None
+    llm_api_endpoint: Optional[str] = None
     """The OpenAI API endpoint."""
 
     llm_api_key: Optional[SecretStr] = None
@@ -726,7 +727,7 @@ class ScopedConfig(Base):
     llm_frequency_penalty: Optional[PositiveFloat] = None
     """The frequency penalty of the LLM model."""
 
-    embedding_api_endpoint: Optional[HttpUrl] = None
+    embedding_api_endpoint: Optional[str] = None
     """The OpenAI API endpoint."""
 
     embedding_api_key: Optional[SecretStr] = None
@@ -747,7 +748,7 @@ class ScopedConfig(Base):
     embedding_caching: Optional[bool] = False
     """Whether to cache the embedding result."""
 
-    milvus_uri: Optional[HttpUrl] = Field(default=None)
+    milvus_uri: Optional[str] = Field(default=None)
     """The URI of the Milvus server."""
 
     milvus_token: Optional[SecretStr] = Field(default=None)

{fabricatio-0.3.13 → fabricatio-0.3.14.dev1}/python/fabricatio/models/kwargs_types.py

@@ -1,9 +1,6 @@
 """This module contains the types for the keyword arguments of the methods in the models module."""
 
-from typing import Any, Dict, List, Literal, NotRequired, Optional, Required, TypedDict
-
-from litellm.caching.caching import CacheMode
-from litellm.types.caching import CachingSupportedCallTypes
+from typing import Dict, List, Literal, NotRequired, Optional, Required, TypedDict
 
 
 class ChunkKwargs(TypedDict):
@@ -70,7 +67,6 @@ class ValidateKwargs[T](GenerateKwargs, total=False):
     max_validations: int
 
 
-
 class CompositeScoreKwargs(ValidateKwargs[List[Dict[str, float]]], total=False):
     """Arguments for composite score generation operations.
 
@@ -125,47 +121,6 @@ class ChooseKwargs[T](ValidateKwargs[T], total=False):
     k: int
 
 
-class CacheKwargs(TypedDict, total=False):
-    """Configuration parameters for the caching system.
-
-    These arguments control the behavior of various caching backends,
-    including in-memory, Redis, S3, and vector database caching options.
-    """
-
-    mode: CacheMode  # when default_on cache is always on, when default_off cache is opt in
-    host: str
-    port: str
-    password: str
-    namespace: str
-    ttl: float
-    default_in_memory_ttl: float
-    default_in_redis_ttl: float
-    similarity_threshold: float
-    supported_call_types: list[CachingSupportedCallTypes]
-    # s3 Bucket, boto3 configuration
-    s3_bucket_name: str
-    s3_region_name: str
-    s3_api_version: str
-    s3_use_ssl: bool
-    s3_verify: bool | str
-    s3_endpoint_url: str
-    s3_aws_access_key_id: str
-    s3_aws_secret_access_key: str
-    s3_aws_session_token: str
-    s3_config: Any
-    s3_path: str
-    redis_semantic_cache_use_async: bool
-    redis_semantic_cache_embedding_model: str
-    redis_flush_size: int
-    redis_startup_nodes: list
-    disk_cache_dir: Any
-    qdrant_api_base: str
-    qdrant_api_key: str
-    qdrant_collection_name: str
-    qdrant_quantization_config: str
-    qdrant_semantic_cache_embedding_model: str
-
-
 class RerankOptions(TypedDict, total=False):
     """Optional keyword arguments for the rerank method."""
 

{fabricatio-0.3.13 → fabricatio-0.3.14.dev1}/python/fabricatio/models/role.py

@@ -1,40 +1,35 @@
 """Module that contains the Role class for managing workflows and their event registrations."""
-
-from typing import Any, Self, Set
+from functools import partial
+from typing import Any, Dict, Self
 
 from fabricatio.rust import Event
-from pydantic import Field, ConfigDict
+from pydantic import ConfigDict, Field
 
-from fabricatio.capabilities.propose import Propose
 from fabricatio.core import env
 from fabricatio.journal import logger
 from fabricatio.models.action import WorkFlow
 from fabricatio.models.generic import WithBriefing
-from fabricatio.models.tool import ToolBox
-from fabricatio.models.usages import ToolBoxUsage
+from fabricatio.utils import is_subclass_of_base
+
+is_toolbox_usage = partial(is_subclass_of_base, base_module="fabricatio.models.usages",
+                           base_name="ToolBoxUsage")
+is_scoped_config = partial(is_subclass_of_base, base_module="fabricatio.models.generic",
+                           base_name="ScopedConfig")
 
 
-class Role(WithBriefing, Propose, ToolBoxUsage):
+class Role(WithBriefing):
     """Class that represents a role with a registry of events and workflows.
 
     A Role serves as a container for workflows, managing their registration to events
     and providing them with shared configuration like tools and personality.
-
-    Attributes:
-        registry: Mapping of events to workflows that handle them
-        toolboxes: Set of toolboxes available to this role and its workflows
     """
-    # fixme: not use arbitrary_types_allowed
     model_config = ConfigDict(use_attribute_docstrings=True, arbitrary_types_allowed=True)
     description: str = ""
     """A brief description of the role's responsibilities and capabilities."""
 
-    registry: dict[Event | str, WorkFlow] = Field(default_factory=dict)
+    registry: Dict[Event, WorkFlow] = Field(default_factory=dict)
     """The registry of events and workflows."""
 
-    toolboxes: Set[ToolBox] = Field(default_factory=set)
-    """Collection of tools available to this role."""
-
     def model_post_init(self, __context: Any) -> None:
         """Initialize the role by resolving configurations and registering workflows.
 
@@ -51,7 +46,7 @@ class Role(WithBriefing, Propose, ToolBoxUsage):
         """
         for event, workflow in self.registry.items():
             logger.debug(
-                f"Registering workflow: `{workflow.name}` for event: `{Event.instantiate_from(event).collapse()}`"
+                f"Registering workflow: `{workflow.name}` for event: `{event.collapse()}`"
             )
             env.on(event, workflow.serve)
         return self
@@ -67,12 +62,33 @@ class Role(WithBriefing, Propose, ToolBoxUsage):
         """
         for workflow in self.registry.values():
             logger.debug(f"Resolving config for workflow: `{workflow.name}`")
-            (
-                workflow.fallback_to(self)
-                .steps_fallback_to_self()
-                .inject_personality(self.briefing)
-                .supply_tools_from(self)
-                .steps_supply_tools_from_self()
-            )
-
+            self._configure_scoped_config(workflow)
+            self._configure_toolbox_usage(workflow)
+            workflow.inject_personality(self.briefing)
         return self
+
+    def _configure_scoped_config(self, workflow) -> None:
+        """Configure scoped configuration for workflow and its actions."""
+        if not is_scoped_config(self.__class__):
+            return
+
+        fallback_target = self
+        if is_scoped_config(workflow):
+            workflow.fallback_to(self)
+            fallback_target = workflow
+
+        for action in (a for a in workflow.iter_actions() if is_scoped_config(a)):
+            action.fallback_to(fallback_target)
+
+    def _configure_toolbox_usage(self, workflow) -> None:
+        """Configure toolbox usage for workflow and its actions."""
+        if not is_toolbox_usage(self.__class__):
+            return
+
+        supply_target = self
+        if is_toolbox_usage(workflow):
+            workflow.supply_tools_from(self)
+            supply_target = workflow
+
+        for action in (a for a in workflow.iter_actions() if is_toolbox_usage(a)):
+            action.supply_tools_from(supply_target)

{fabricatio-0.3.13 → fabricatio-0.3.14.dev1}/python/fabricatio/models/usages.py

@@ -26,8 +26,7 @@ from fabricatio.models.generic import ScopedConfig, WithBriefing
 from fabricatio.models.kwargs_types import ChooseKwargs, EmbeddingKwargs, GenerateKwargs, LLMKwargs, ValidateKwargs
 from fabricatio.models.task import Task
 from fabricatio.models.tool import Tool, ToolBox
-from fabricatio.parser import GenericCapture, JsonCapture
-from fabricatio.utils import ok
+from fabricatio.utils import first_available, ok
 
 ROUTER = Router(
     routing_strategy="usage-based-routing-v2",
@@ -91,7 +90,7 @@ class LLMUsage(ScopedConfig):
                         api_base=ok(
                             self.llm_api_endpoint or CONFIG.llm.api_endpoint,
                             "llm api endpoint is not set at any place",
-                        ).unicode_string(),
+                        ),
                         model=m_name,
                         tpm=self.llm_tpm or CONFIG.llm.tpm,
                         rpm=self.llm_rpm or CONFIG.llm.rpm,
@@ -109,7 +108,8 @@ class LLMUsage(ScopedConfig):
             stop=kwargs.get("stop") or self.llm_stop_sign or CONFIG.llm.stop_sign,
             top_p=kwargs.get("top_p") or self.llm_top_p or CONFIG.llm.top_p,
             max_tokens=kwargs.get("max_tokens") or self.llm_max_tokens or CONFIG.llm.max_tokens,
-            stream=ok(kwargs.get("stream") or self.llm_stream or CONFIG.llm.stream, "stream is not set at any place"),
+            stream=first_available((kwargs.get("stream"), self.llm_stream, CONFIG.llm.stream),
+                                   "stream is not set at any place"),
             cache={
                 "no-cache": kwargs.get("no_cache"),
                 "no-store": kwargs.get("no_store"),
@@ -337,6 +337,8 @@ class LLMUsage(ScopedConfig):
         Returns:
             Optional[List[str]]: The validated response as a list of strings.
         """
+        from fabricatio.parser import JsonCapture
+
         return await self.aask_validate(
             TEMPLATE_MANAGER.render_template(
                 CONFIG.templates.liststr_template,
@@ -393,6 +395,8 @@ class LLMUsage(ScopedConfig):
         Returns:
             Optional[str]: The generated string.
         """
+        from fabricatio.parser import GenericCapture
+
         return await self.aask_validate(  # pyright: ignore [reportReturnType]
             TEMPLATE_MANAGER.render_template(
                 CONFIG.templates.generic_string_template,
@@ -420,6 +424,8 @@ class LLMUsage(ScopedConfig):
         Returns:
             Optional[List[T]]: The final validated selection result list, with element types matching the input `choices`.
         """
+        from fabricatio.parser import JsonCapture
+
         if dup := duplicates_everseen(choices, key=lambda x: x.name):
             logger.error(err := f"Redundant choices: {dup}")
             raise ValueError(err)
@@ -495,6 +501,8 @@ class LLMUsage(ScopedConfig):
         Returns:
             bool: The judgment result (True or False) based on the AI's response.
         """
+        from fabricatio.parser import JsonCapture
+
         return await self.aask_validate(
             question=TEMPLATE_MANAGER.render_template(
                 CONFIG.templates.make_judgment_template,
@@ -556,7 +564,6 @@ class EmbeddingUsage(LLMUsage):
                 or self.llm_api_endpoint
                 or CONFIG.llm.api_endpoint
             )
-            .unicode_string()
             .rstrip("/"),
             # seems embedding function takes no base_url end with a slash
         )

{fabricatio-0.3.13 → fabricatio-0.3.14.dev1}/python/fabricatio/rust.pyi

@@ -11,7 +11,7 @@ Key Features:
 - Text utilities: Word boundary splitting and word counting.
 """
 from enum import StrEnum
-from typing import Any, Dict, List, Optional, Self, Tuple, overload, Union
+from typing import Any, Dict, List, Optional, Self, Tuple, Union, overload
 
 from pydantic import JsonValue
 
@@ -724,7 +724,7 @@ class SecretStr:
 
     def __init__(self, source: str) -> None: ...
 
-    def expose(self) -> str:
+    def get_secret_value(self) -> str:
         """Expose the secret string."""