fabricatio 0.2.6__cp39-cp39-win_amd64.whl

fabricatio/capabilities/task.py

@@ -0,0 +1,113 @@
+"""A module for the task capabilities of the Fabricatio library."""
+
+from types import CodeType
+from typing import Any, Dict, List, Optional, Tuple, Unpack, cast
+
+import orjson
+from fabricatio._rust_instances import TEMPLATE_MANAGER
+from fabricatio.capabilities.propose import Propose
+from fabricatio.config import configs
+from fabricatio.journal import logger
+from fabricatio.models.generic import WithBriefing
+from fabricatio.models.kwargs_types import ChooseKwargs, ValidateKwargs
+from fabricatio.models.task import Task
+from fabricatio.models.tool import Tool, ToolExecutor
+from fabricatio.models.usages import ToolBoxUsage
+from fabricatio.parser import JsonCapture, PythonCapture
+
+
+class ProposeTask(WithBriefing, Propose):
+    """A class that proposes a task based on a prompt."""
+
+    async def propose_task[T](
+        self,
+        prompt: str,
+        **kwargs: Unpack[ValidateKwargs[Task[T]]],
+    ) -> Task[T]:
+        """Asynchronously proposes a task based on a given prompt and parameters.
+
+        Parameters:
+            prompt: The prompt text for proposing a task, which is a string that must be provided.
+            **kwargs: The keyword arguments for the LLM (Large Language Model) usage.
+
+        Returns:
+            A Task object based on the proposal result.
+        """
+        if not prompt:
+            logger.error(err := f"{self.name}: Prompt must be provided.")
+            raise ValueError(err)
+
+        return await self.propose(Task, prompt, **self.prepend(cast(Dict[str, Any], kwargs)))
+
+
+class HandleTask(WithBriefing, ToolBoxUsage):
+    """A class that handles a task based on a task object."""
+
+    async def draft_tool_usage_code(
+        self,
+        task: Task,
+        tools: List[Tool],
+        data: Dict[str, Any],
+        **kwargs: Unpack[ValidateKwargs],
+    ) -> Optional[Tuple[CodeType, List[str]]]:
+        """Asynchronously drafts the tool usage code for a task based on a given task object and tools."""
+        logger.info(f"Drafting tool usage code for task: {task.briefing}")
+
+        if not tools:
+            err = f"{self.name}: Tools must be provided to draft the tool usage code."
+            logger.error(err)
+            raise ValueError(err)
+
+        def _validator(response: str) -> Tuple[CodeType, List[str]] | None:
+            if (source := PythonCapture.convert_with(response, lambda resp: compile(resp, "<string>", "exec"))) and (
+                to_extract := JsonCapture.convert_with(response, orjson.loads)
+            ):
+                return source, to_extract
+
+            return None
+
+        q = TEMPLATE_MANAGER.render_template(
+            configs.templates.draft_tool_usage_code_template,
+            {
+                "data_module_name": configs.toolbox.data_module_name,
+                "tool_module_name": configs.toolbox.tool_module_name,
+                "task": task.briefing,
+                "deps": task.dependencies_prompt,
+                "tools": [{"name": t.name, "briefing": t.briefing} for t in tools],
+                "data": data,
+            },
+        )
+        logger.debug(f"Code Drafting Question: \n{q}")
+        return await self.aask_validate(
+            question=q,
+            validator=_validator,
+            **self.prepend(cast(Dict[str, Any], kwargs)),
+        )
+
+    async def handle_fine_grind(
+        self,
+        task: Task,
+        data: Dict[str, Any],
+        box_choose_kwargs: Optional[ChooseKwargs] = None,
+        tool_choose_kwargs: Optional[ChooseKwargs] = None,
+        **kwargs: Unpack[ValidateKwargs],
+    ) -> Optional[Tuple]:
+        """Asynchronously handles a task based on a given task object and parameters."""
+        logger.info(f"Handling task: \n{task.briefing}")
+
+        tools = await self.gather_tools_fine_grind(task, box_choose_kwargs, tool_choose_kwargs)
+        logger.info(f"{self.name} have gathered {[t.name for t in tools]}")
+
+        if tools and (pack := await self.draft_tool_usage_code(task, tools, data, **kwargs)):
+            executor = ToolExecutor(candidates=tools, data=data)
+
+            code, to_extract = pack
+            cxt = executor.execute(code)
+            if to_extract:
+                return tuple(cxt.get(k) for k in to_extract)
+
+        return None
+
+    async def handle(self, task: Task, data: Dict[str, Any], **kwargs: Unpack[ValidateKwargs]) -> Optional[Tuple]:
+        """Asynchronously handles a task based on a given task object and parameters."""
+        return await self.handle_fine_grind(task, data, **kwargs)

fabricatio/config.py

@@ -0,0 +1,405 @@
+"""Configuration module for the Fabricatio application."""
+
+from pathlib import Path
+from typing import List, Literal, Optional
+
+from appdirs import user_config_dir
+from litellm.types.caching import LiteLLMCacheType
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    DirectoryPath,
+    Field,
+    FilePath,
+    HttpUrl,
+    NonNegativeFloat,
+    PositiveFloat,
+    PositiveInt,
+    SecretStr,
+)
+from pydantic_settings import (
+    BaseSettings,
+    PydanticBaseSettingsSource,
+    PyprojectTomlConfigSettingsSource,
+    SettingsConfigDict,
+    TomlConfigSettingsSource,
+)
+
+from fabricatio.models.kwargs_types import CacheKwargs
+
+ROAMING_DIR = user_config_dir("fabricatio", "", roaming=True)
+
+
+class LLMConfig(BaseModel):
+    """LLM configuration class.
+
+    Attributes:
+        api_endpoint (HttpUrl): OpenAI API Endpoint.
+        api_key (SecretStr): OpenAI API key. Empty by default for security reasons, should be set before use.
+        timeout (PositiveInt): The timeout of the LLM model in seconds. Default is 300 seconds as per request.
+        max_retries (PositiveInt): The maximum number of retries. Default is 3 retries.
+        model (str): The LLM model name. Set to 'gpt-3.5-turbo' as per request.
+        temperature (NonNegativeFloat): The temperature of the LLM model. Controls randomness in generation. Set to 1.0 as per request.
+        stop_sign (str): The stop sign of the LLM model. No default stop sign specified.
+        top_p (NonNegativeFloat): The top p of the LLM model. Controls diversity via nucleus sampling. Set to 0.35 as per request.
+        generation_count (PositiveInt): The number of generations to generate. Default is 1.
+        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: Optional[HttpUrl] = Field(default=HttpUrl("https://api.openai.com"))
+    """OpenAI API Endpoint."""
+
+    api_key: Optional[SecretStr] = Field(default=SecretStr("sk-setyourkey"))
+    """OpenAI API key. Empty by default for security reasons, should be set before use."""
+
+    timeout: Optional[PositiveInt] = Field(default=300)
+    """The timeout of the LLM model in seconds. Default is 300 seconds as per request."""
+
+    max_retries: Optional[PositiveInt] = Field(default=3)
+    """The maximum number of retries. Default is 3 retries."""
+
+    model: Optional[str] = Field(default="gpt-3.5-turbo")
+    """The LLM model name. Set to 'gpt-3.5-turbo' as per request."""
+
+    temperature: Optional[NonNegativeFloat] = Field(default=1.0)
+    """The temperature of the LLM model. Controls randomness in generation. Set to 1.0 as per request."""
+
+    stop_sign: Optional[str | List[str]] = Field(default=None)
+    """The stop sign of the LLM model. No default stop sign specified."""
+
+    top_p: Optional[NonNegativeFloat] = Field(default=0.35)
+    """The top p of the LLM model. Controls diversity via nucleus sampling. Set to 0.35 as per request."""
+
+    generation_count: Optional[PositiveInt] = Field(default=1)
+    """The number of generations to generate. Default is 1."""
+
+    stream: Optional[bool] = Field(default=False)
+    """Whether to stream the LLM model's response. Default is False."""
+
+    max_tokens: Optional[PositiveInt] = Field(default=None)
+    """The maximum number of tokens to generate. Set to 8192 as per request."""
+
+    rpm: Optional[PositiveInt] = Field(default=100)
+    """The rate limit of the LLM model in requests per minute. None means not checked."""
+
+    tpm: Optional[PositiveInt] = Field(default=1000000)
+    """The rate limit of the LLM model in tokens per minute. None means not checked."""
+
+
+class EmbeddingConfig(BaseModel):
+    """Embedding configuration class."""
+
+    model_config = ConfigDict(use_attribute_docstrings=True)
+
+    model: Optional[str] = Field(default="text-embedding-ada-002")
+    """The embedding model name. """
+
+    dimensions: Optional[PositiveInt] = Field(default=None)
+    """The dimensions of the embedding. None means not checked."""
+
+    timeout: Optional[PositiveInt] = Field(default=None)
+    """The timeout of the embedding model in seconds."""
+
+    max_sequence_length: Optional[PositiveInt] = Field(default=8192)
+    """The maximum sequence length of the embedding model. Default is 8192 as per request."""
+
+    caching: Optional[bool] = Field(default=False)
+    """Whether to cache the embedding. Default is False."""
+
+    api_endpoint: Optional[HttpUrl] = None
+    """The OpenAI API endpoint."""
+
+    api_key: Optional[SecretStr] = None
+    """The OpenAI API key."""
+
+
+class PymitterConfig(BaseModel):
+    """Pymitter configuration class.
+
+    Attributes:
+        delimiter (str): The delimiter used to separate the event name into segments.
+        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)
+    """The delimiter used to separate the event name into segments."""
+
+    new_listener_event: bool = Field(default=False, frozen=True)
+    """If set, a newListener event is emitted when a new listener is added."""
+
+    max_listeners: int = Field(default=-1, frozen=True)
+    """The maximum number of listeners per event."""
+
+
+class DebugConfig(BaseModel):
+    """Debug configuration class.
+
+    Attributes:
+        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")
+    """The log level of the application."""
+
+    log_file: FilePath = Field(default=Path(rf"{ROAMING_DIR}\fabricatio.log"), frozen=True)
+    """The log file of the application."""
+
+    rotation: int = Field(default=1, frozen=True)
+    """The rotation of the log file. in weeks."""
+
+    retention: int = Field(default=2, frozen=True)
+    """The retention of the log file. in weeks."""
+
+    streaming_visible: bool = Field(default=False)
+    """Whether to print the llm output when streaming."""
+
+
+class TemplateConfig(BaseModel):
+    """Template configuration class."""
+
+    model_config = ConfigDict(use_attribute_docstrings=True)
+    template_dir: List[DirectoryPath] = Field(
+        default_factory=lambda: [Path(r".\templates"), Path(rf"{ROAMING_DIR}\templates")]
+    )
+    """The directory containing the templates."""
+    active_loading: bool = Field(default=False)
+    """Whether to enable active loading of templates."""
+
+    template_suffix: str = Field(default="hbs", frozen=True)
+    """The suffix of the templates."""
+
+    create_json_obj_template: str = Field(default="create_json_obj")
+    """The name of the create json object template which will be used to create a json object."""
+
+    draft_tool_usage_code_template: str = Field(default="draft_tool_usage_code")
+    """The name of the draft tool usage code template which will be used to draft tool usage code."""
+
+    make_choice_template: str = Field(default="make_choice")
+    """The name of the make choice template which will be used to make a choice."""
+
+    make_judgment_template: str = Field(default="make_judgment")
+    """The name of the make judgment template which will be used to make a judgment."""
+
+    dependencies_template: str = Field(default="dependencies")
+    """The name of the dependencies template which will be used to manage dependencies."""
+
+    task_briefing_template: str = Field(default="task_briefing")
+    """The name of the task briefing template which will be used to brief a task."""
+
+    rate_fine_grind_template: str = Field(default="rate_fine_grind")
+    """The name of the rate fine grind template which will be used to rate fine grind."""
+
+    draft_rating_manual_template: str = Field(default="draft_rating_manual")
+    """The name of the draft rating manual template which will be used to draft rating manual."""
+
+    draft_rating_criteria_template: str = Field(default="draft_rating_criteria")
+    """The name of the draft rating criteria template which will be used to draft rating criteria."""
+
+    extract_reasons_from_examples_template: str = Field(default="extract_reasons_from_examples")
+    """The name of the extract reasons from examples template which will be used to extract reasons from examples."""
+
+    extract_criteria_from_reasons_template: str = Field(default="extract_criteria_from_reasons")
+    """The name of the extract criteria from reasons template which will be used to extract criteria from reasons."""
+
+    draft_rating_weights_klee_template: str = Field(default="draft_rating_weights_klee")
+    """The name of the draft rating weights klee template which will be used to draft rating weights with Klee method."""
+
+    retrieved_display_template: str = Field(default="retrieved_display")
+    """The name of the retrieved display template which will be used to display retrieved documents."""
+
+    liststr_template: str = Field(default="liststr")
+    """The name of the liststr template which will be used to display a list of strings."""
+
+    refined_query_template: str = Field(default="refined_query")
+    """The name of the refined query template which will be used to refine a query."""
+
+    pathstr_template: str = Field(default="pathstr")
+    """The name of the pathstr template which will be used to acquire a path of strings."""
+
+    review_string_template: str = Field(default="review_string")
+    """The name of the review string template which will be used to review a string."""
+
+    generic_string_template: str = Field(default="generic_string")
+    """The name of the generic string template which will be used to review a string."""
+
+    correct_template: str = Field(default="correct")
+    """The name of the correct template which will be used to correct a string."""
+
+    co_validation_template: str = Field(default="co_validation")
+    """The name of the co-validation template which will be used to co-validate a string."""
+
+
+class MagikaConfig(BaseModel):
+    """Magika configuration class."""
+
+    model_config = ConfigDict(use_attribute_docstrings=True)
+    model_dir: Optional[DirectoryPath] = Field(default=None)
+    """The directory containing the models for magika."""
+
+
+class GeneralConfig(BaseModel):
+    """Global configuration class."""
+
+    model_config = ConfigDict(use_attribute_docstrings=True)
+    workspace: DirectoryPath = Field(default=Path())
+    """The workspace directory for the application."""
+
+    confirm_on_ops: bool = Field(default=True)
+    """Whether to confirm on operations."""
+
+    use_json_repair: bool = Field(default=True)
+    """Whether to use JSON repair."""
+
+
+class ToolBoxConfig(BaseModel):
+    """Toolbox configuration class."""
+
+    model_config = ConfigDict(use_attribute_docstrings=True)
+
+    tool_module_name: str = Field(default="Toolbox")
+    """The name of the module containing the toolbox."""
+
+    data_module_name: str = Field(default="Data")
+    """The name of the module containing the data."""
+
+
+class RagConfig(BaseModel):
+    """RAG configuration class."""
+
+    model_config = ConfigDict(use_attribute_docstrings=True)
+
+    milvus_uri: Optional[HttpUrl] = Field(default=HttpUrl("http://localhost:19530"))
+    """The URI of the Milvus server."""
+    milvus_timeout: Optional[PositiveFloat] = Field(default=30.0)
+    """The timeout of the Milvus server."""
+    milvus_token: Optional[SecretStr] = Field(default=None)
+    """The token of the Milvus server."""
+    milvus_dimensions: Optional[PositiveInt] = Field(default=None)
+    """The dimensions of the Milvus server."""
+
+
+class CacheConfig(BaseModel):
+    """cache configuration class, uses litellm as cache backend. more info see https://docs.litellm.ai/docs/caching/all_caches."""
+
+    model_config = ConfigDict(use_attribute_docstrings=True)
+
+    type: Optional[LiteLLMCacheType] = None
+    """The type of cache to use. If None, the default cache type will be used."""
+    params: CacheKwargs = Field(default_factory=CacheKwargs)
+    """The parameters for the cache. If type is None, the default parameters will be used."""
+    enabled: bool = Field(default=False)
+    """Whether to enable cache."""
+
+
+class RoutingConfig(BaseModel):
+    """Routing configuration class."""
+
+    model_config = ConfigDict(use_attribute_docstrings=True)
+
+    max_parallel_requests: Optional[int] = 60
+    """The maximum number of parallel requests. None means not checked."""
+    allowed_fails: Optional[int] = 3
+    """The number of allowed fails before the routing is considered failed."""
+    retry_after: int = 15
+    """The time in seconds to wait before retrying the routing after a fail."""
+    cooldown_time: Optional[int] = 30
+    """The time in seconds to wait before retrying the routing after a cooldown."""
+
+
+class Settings(BaseSettings):
+    """Application settings class.
+
+    Attributes:
+        llm (LLMConfig): LLM Configuration
+        debug (DebugConfig): Debug Configuration
+        pymitter (PymitterConfig): Pymitter Configuration
+        templates (TemplateConfig): Template Configuration
+        magika (MagikaConfig): Magika Configuration
+    """
+
+    model_config = SettingsConfigDict(
+        env_prefix="FABRIK_",
+        env_nested_delimiter="__",
+        pyproject_toml_depth=1,
+        pyproject_toml_table_header=("tool", "fabricatio"),
+        toml_file=["fabricatio.toml", rf"{ROAMING_DIR}\fabricatio.toml"],
+        env_file=[".env", ".envrc"],
+        use_attribute_docstrings=True,
+        extra="ignore",
+    )
+
+    llm: LLMConfig = Field(default_factory=LLMConfig)
+    """LLM Configuration"""
+
+    routing: RoutingConfig = Field(default_factory=RoutingConfig)
+    """Routing Configuration"""
+
+    embedding: EmbeddingConfig = Field(default_factory=EmbeddingConfig)
+    """Embedding Configuration"""
+
+    debug: DebugConfig = Field(default_factory=DebugConfig)
+    """Debug Configuration"""
+
+    pymitter: PymitterConfig = Field(default_factory=PymitterConfig)
+    """Pymitter Configuration"""
+
+    templates: TemplateConfig = Field(default_factory=TemplateConfig)
+    """Template Configuration"""
+
+    magika: MagikaConfig = Field(default_factory=MagikaConfig)
+    """Magika Configuration"""
+
+    general: GeneralConfig = Field(default_factory=GeneralConfig)
+    """General Configuration"""
+
+    toolbox: ToolBoxConfig = Field(default_factory=ToolBoxConfig)
+    """Toolbox Configuration"""
+
+    rag: RagConfig = Field(default_factory=RagConfig)
+    """RAG Configuration"""
+
+    cache: CacheConfig = Field(default_factory=CacheConfig)
+    """Cache Configuration"""
+
+    @classmethod
+    def settings_customise_sources(
+        cls,
+        settings_cls: type[BaseSettings],
+        init_settings: PydanticBaseSettingsSource,
+        env_settings: PydanticBaseSettingsSource,
+        dotenv_settings: PydanticBaseSettingsSource,
+        file_secret_settings: PydanticBaseSettingsSource,
+    ) -> tuple[PydanticBaseSettingsSource, ...]:
+        """Customize settings sources.
+
+        This method customizes the settings sources used by the application. It returns a tuple of settings sources, including
+        the dotenv settings source, environment settings source, a custom TomlConfigSettingsSource, and a custom
+
+        Args:
+            settings_cls (type[BaseSettings]): The settings class.
+            init_settings (PydanticBaseSettingsSource): Initial settings source.
+            env_settings (PydanticBaseSettingsSource): Environment settings source.
+            dotenv_settings (PydanticBaseSettingsSource): Dotenv settings source.
+            file_secret_settings (PydanticBaseSettingsSource): File secret settings source.
+
+        Returns:
+            tuple[PydanticBaseSettingsSource, ...]: A tuple of settings sources.
+        """
+        return (
+            init_settings,
+            dotenv_settings,
+            env_settings,
+            file_secret_settings,
+            PyprojectTomlConfigSettingsSource(settings_cls),
+            TomlConfigSettingsSource(settings_cls),
+        )
+
+
+configs: Settings = Settings()