lionagi 0.3.8__py3-none-any.whl → 0.5.0__py3-none-any.whl

lionagi/core/unit/template/plan.py

@@ -1,69 +0,0 @@
-from lionagi.libs.ln_convert import to_str
-
-from .base import BaseUnitForm, Field
-
-
-class PlanTemplate(BaseUnitForm):
-    """
-    A template for generating a step-by-step plan based on given instructions and context.
-
-    Inherits from `BaseUnitForm` and adds fields and methods specific to plan generation.
-
-    Attributes:
-        template_name (str): The name of the template.
-        plan (dict | str): The generated step-by-step plan in the format {step_n: {plan: ..., reason: ...}}.
-        signature (str): A string representing the task signature for the plan.
-    """
-
-    template_name: str = "plan_template"
-
-    plan: dict | str = Field(
-        default_factory=dict,
-        description="the generated step by step plan, return as a dictionary following {step_n: {plan: ..., reason: ...}} format",
-    )
-
-    assignment: str = "task -> plan"
-
-    @property
-    def answer(self):
-        """
-        Gets the plan attribute.
-
-        Returns:
-            dict | str: The generated plan.
-        """
-        return getattr(self, "plan", None)
-
-    def __init__(
-        self,
-        *,
-        instruction=None,
-        context=None,
-        confidence_score=False,
-        reason=False,
-        num_step=3,
-        **kwargs,
-    ):
-        """
-        Initializes a new instance of the PlanTemplate class.
-
-        Args:
-            instruction (str, optional): Additional instructions for the plan.
-            context (str, optional): Additional context for the plan.
-            confidence_score (bool, optional): Whether to include a confidence score.
-            reason (bool, optional): Whether to include a reasoning field.
-            num_step (int, optional): The number of steps in the plan. Defaults to 3.
-            **kwargs: Additional keyword arguments.
-        """
-        super().__init__(**kwargs)
-
-        self.task = f"""
-Generate a {num_step}_step plan based on the given context
-1. additional instruction, {to_str(instruction or "N/A")}
-2. additional context, {to_str(context or "N/A")}
-"""
-        if reason:
-            self.append_to_request("reason")
-
-        if confidence_score:
-            self.append_to_request("confidence_score")

lionagi/core/unit/template/predict.py

@@ -1,95 +0,0 @@
-from .base import BaseUnitForm, Field
-
-
-class PredictTemplate(BaseUnitForm):
-    """
-    A template for predicting the next sentence(s) based on given instructions and context.
-
-    Inherits from `BaseUnitForm` and adds fields and methods specific to prediction tasks.
-
-    Attributes:
-        confidence_score (float | None): A numeric score between 0 to 1 formatted to 2 decimal places, indicating confidence in the prediction.
-        reason (str | None): A brief reason for the given output.
-        template_name (str): The name of the template.
-        num_sentences (int): The number of sentences to predict.
-        prediction (None | str | list): The predicted sentence(s) or desired output.
-        assignment (str): A string representing the task assignment for the prediction.
-    """
-
-    confidence_score: float | None = Field(
-        None,
-        description="a numeric score between 0 to 1 formatted in num:0.2f, 1 being very confident and 0 being not confident at all, just guessing",
-        validation_kwargs={
-            "upper_bound": 1,
-            "lower_bound": 0,
-            "num_type": float,
-            "precision": 2,
-        },
-    )
-
-    reason: str | None = Field(
-        None,
-        description="brief reason for the given output, format: This is my best response because ...",
-    )
-
-    template_name: str = "predict_template"
-
-    num_sentences: int = Field(
-        2, description="the number of sentences to predict"
-    )
-
-    prediction: None | str | list = Field(
-        None,
-        description="the predicted sentence(s) or desired output",
-    )
-
-    assignment: str = "task -> prediction"
-
-    @property
-    def answer(self):
-        """
-        Gets the prediction attribute.
-
-        Returns:
-            None | str | list: The predicted sentence(s) or desired output.
-        """
-        return getattr(self, "prediction", None)
-
-    def __init__(
-        self,
-        *,
-        instruction=None,
-        context=None,
-        num_sentences=2,
-        confidence_score=False,
-        reason=False,
-        **kwargs,
-    ):
-        """
-        Initializes a new instance of the PredictTemplate class.
-
-        Args:
-            instruction (str, optional): Additional instructions for the prediction.
-            context (str, optional): Additional context for the prediction.
-            num_sentences (int, optional): The number of sentences to predict. Defaults to 2.
-            confidence_score (bool, optional): Whether to include a confidence score. Defaults to False.
-            reason (bool, optional): Whether to include a reasoning field. Defaults to False.
-            **kwargs: Additional keyword arguments.
-        """
-
-        super().__init__(**kwargs)
-
-        self.num_sentences = num_sentences
-
-        self.task = f"""
-predict the next sentence(s) according to the following constraints
-1. number of sentences: {self.num_sentences}
-2. additional objective , {instruction or "N/A"}
-3. additional information, {context or "N/A"}
-"""
-
-        if reason:
-            self.append_to_request("reason")
-
-        if confidence_score:
-            self.append_to_request("confidence_score")

lionagi/core/unit/template/score.py

@@ -1,108 +0,0 @@
-from lionagi.core.collections.abc import Field
-from lionagi.core.unit import UnitForm
-from lionagi.libs.ln_convert import to_str
-
-
-class ScoreTemplate(UnitForm):
-    """
-    A template for performing a scoring task based on given instructions and context.
-
-    Inherits from `UnitForm` and adds fields and methods specific to scoring tasks.
-
-    Attributes:
-        confidence_score (float | None): A numeric score between 0 to 1 formatted to 2 decimal places, indicating confidence in the score.
-        reason (str | None): A brief reason for the given output.
-        template_name (str): The name of the template.
-        score (float | None): A score for the given context and task.
-        assignment (str): A string representing the task assignment for the score.
-    """
-
-    confidence_score: float | None = Field(
-        None,
-        description="a numeric score between 0 to 1 formatted in num:0.2f, 1 being very confident and 0 being not confident at all",
-        validation_kwargs={
-            "upper_bound": 1,
-            "lower_bound": 0,
-            "num_type": float,
-            "precision": 2,
-        },
-    )
-
-    reason: str | None = Field(
-        None,
-        description="brief reason for the given output, format: This is my best response because ...",
-    )
-
-    template_name: str = "score_template"
-
-    score: float | None = Field(
-        None,
-        description="a score for the given context and task, numeric",
-    )
-
-    assignment: str = "task -> score"
-
-    @property
-    def answer(self):
-        """
-        Gets the score attribute.
-
-        Returns:
-            float | None: The score for the given context and task.
-        """
-        return getattr(self, "score", None)
-
-    def __init__(
-        self,
-        *,
-        instruction=None,
-        context=None,
-        score_range=(0, 10),
-        include_endpoints=True,
-        num_digit=0,
-        confidence_score=False,
-        reason=False,
-        **kwargs,
-    ):
-        """
-        Initializes a new instance of the ScoreTemplate class.
-
-        Args:
-            instruction (str, optional): Additional instructions for the scoring task.
-            context (str, optional): Additional context for the scoring task.
-            score_range (tuple, optional): The range of the score. Defaults to (0, 10).
-            include_endpoints (bool, optional): Whether to include the endpoints in the score range. Defaults to True.
-            num_digit (int, optional): The number of digits allowed after the decimal point. Defaults to 0.
-            confidence_score (bool, optional): Whether to include a confidence score. Defaults to False.
-            reason (bool, optional): Whether to include a reasoning field. Defaults to False.
-            **kwargs: Additional keyword arguments.
-        """
-        super().__init__(**kwargs)
-
-        return_precision = ""
-
-        if num_digit == 0:
-            return_precision = "integer"
-        else:
-            return_precision = f"num:{to_str(num_digit)}f"
-
-        self.task = f"""
-perform scoring task according to the following constraints:
-1. additional objective: {to_str(instruction or "N/A")}.
-2. score range: {to_str(score_range)}.
-3. include_endpoints: {"yes" if include_endpoints else "no"}.
-4. precision, (max number of digits allowed after "."): {return_precision}.
-5. additional information: {to_str(context or "N/A")}.
-"""
-        if reason:
-            self.append_to_request("reason")
-
-        if confidence_score:
-            self.append_to_request("confidence_score")
-
-        self.validation_kwargs["score"] = {
-            "upper_bound": score_range[1],
-            "lower_bound": score_range[0],
-            "num_type": int if num_digit == 0 else float,
-            "precision": num_digit if num_digit != 0 else None,
-        }

lionagi/core/unit/template/select.py

@@ -1,91 +0,0 @@
-from enum import Enum
-
-from .base import BaseUnitForm, Field
-
-
-class SelectTemplate(BaseUnitForm):
-    """
-    A template for performing a selection task based on given instructions and context.
-
-    Inherits from `BaseUnitForm` and adds fields and methods specific to selection tasks.
-
-    Attributes:
-        confidence_score (float | None): A numeric score between 0 to 1 formatted to 2 decimal places, indicating confidence in the selection.
-        reason (str | None): A brief reason for the given output.
-        template_name (str): The name of the template.
-        selection (Enum | str | list | None): The selection from given choices.
-        choices (list): The given choices to select from.
-        assignment (str): A string representing the task assignment for the selection.
-    """
-
-    confidence_score: float | None = Field(
-        None,
-        description="a numeric score between 0 to 1 formatted in num:0.2f, 1 being very confident and 0 being not confident at all, just guessing",
-        validation_kwargs={
-            "upper_bound": 1,
-            "lower_bound": 0,
-            "num_type": float,
-            "precision": 2,
-        },
-    )
-
-    reason: str | None = Field(
-        default_factory=str,
-        description="brief reason for the given output, format: This is my best response because ...",
-    )
-
-    template_name: str = "default_select"
-
-    selection: Enum | str | list | None = Field(
-        None, description="selection from given choices"
-    )
-    choices: list = Field(
-        default_factory=list, description="the given choices"
-    )
-
-    assignment: str = "task -> selection"
-
-    @property
-    def answer(self):
-        """
-        Gets the selection attribute.
-
-        Returns:
-            Enum | str | list | None: The selection from given choices.
-        """
-        return getattr(self, "selection", None)
-
-    def __init__(
-        self,
-        *,
-        instruction=None,
-        context=None,
-        choices=None,
-        reason=False,
-        confidence_score=False,
-        **kwargs,
-    ):
-        """
-        Initializes a new instance of the SelectTemplate class.
-
-        Args:
-            instruction (str, optional): Additional instructions for the selection task.
-            context (str, optional): Additional context for the selection task.
-            choices (list, optional): The choices to select from.
-            reason (bool, optional): Whether to include a reasoning field. Defaults to False.
-            confidence_score (bool, optional): Whether to include a confidence score. Defaults to False.
-            **kwargs: Additional keyword arguments.
-        """
-        super().__init__(**kwargs)
-
-        self.choices = choices
-        self.task = f"""
-select 1 item from the provided choices {choices}.
-1. additional objective: {instruction or "N/A"}.
-2. additional information: {context or "N/A"}.
-"""
-        if reason:
-            self.append_to_request("reason")
-
-        if confidence_score:
-            self.append_to_request("confidence_score")