unique_toolkit 0.5.41__py3-none-any.whl → 0.5.43__py3-none-any.whl

unique_toolkit/language_model/__init__.py

@@ -1,5 +1,8 @@
 from .infos import LanguageModel as LanguageModel
 from .infos import LanguageModelName as LanguageModelName
+from .prompt import (
+    Prompt as Prompt,
+)
 from .schemas import (
     LanguageModelAssistantMessage as LanguageModelAssistantMessage,
 )

unique_toolkit/language_model/prompt.py

@@ -0,0 +1,124 @@
+from string import Template
+from typing import Any
+
+from unique_toolkit.language_model.schemas import (
+    LanguageModelSystemMessage,
+    LanguageModelUserMessage,
+)
+
+
+class Prompt:
+    """
+    A class for handling templated prompts that can be formatted into LanguageModelSystemMessage and LanguageModelUserMessage.
+
+    This class wraps a string template and provides methods to format it with variables and
+    convert it into different types of language model messages. It uses Python's string.Template
+    for variable substitution.
+
+    Usage:
+        # Create a prompt with a template and set variables
+        prompt = Prompt("Hello, ${name}!", name="World")
+
+        # Substitute the template with variables and return the formatted content
+        content = prompt.substitute(name="World")
+
+        # Get the formatted content
+        content = prompt.content  # Returns "Hello, World!"
+
+        # Get the template
+        template = prompt.template
+
+        # Convert to language model messages
+        system_msg = prompt.to_system_msg()
+        user_msg = prompt.to_user_msg()
+        user_msg_with_images = prompt.to_user_msg_with_images(images=["IMAGE_IN_BASE64"])
+
+    Properties:
+        template: Returns the underlying template string
+        content: Returns the current formatted content string
+
+    Methods:
+        substitute(**kwargs): Substitutes the template with the given variables
+        to_user_msg(): Converts the prompt to a LanguageModelUserMessage
+        to_user_msg_with_images(images): Converts the prompt to a LanguageModelUserMessage with images
+    """
+
+    def __init__(self, template: str, **kwargs):
+        self._template = Template(template)
+        self._content = self._template.template
+        if kwargs:
+            self._content = self._template.substitute(**kwargs)
+
+    @property
+    def template(self):
+        """
+        Returns the template string.
+
+        Returns:
+            str: The template string.
+        """
+        return self._template
+
+    @property
+    def content(self):
+        """
+        Returns the formatted content string.
+
+        Returns:
+            str: The formatted content string.
+        """
+        return self._content
+
+    def substitute(self, **kwargs: Any) -> str:
+        """
+        Substitutes the template with the given kwargs. Raises KeyError if a required parameter is missing.
+
+        Args:
+            **kwargs: Keyword arguments to substitute into the template.
+
+        Returns:
+            str: The substituted template string.
+
+        Raises:
+            KeyError: If a required parameter in the template is missing from kwargs.
+        """
+        self._content = self._template.substitute(**kwargs)
+        return self._content
+
+    def to_system_msg(self) -> LanguageModelSystemMessage:
+        """
+        Returns a LanguageModelSystemMessage with the content of the prompt.
+
+        Returns:
+            LanguageModelSystemMessage: The formatted prompt.
+        """
+        return LanguageModelSystemMessage(content=self._content)
+
+    def to_user_msg(self) -> LanguageModelUserMessage:
+        """
+        Returns a LanguageModelUserMessage with the content of the prompt.
+
+        Returns:
+            LanguageModelUserMessage: The formatted prompt.
+        """
+        return LanguageModelUserMessage(content=self._content)
+
+    def to_user_msg_with_images(self, images: list[str]) -> LanguageModelUserMessage:
+        """
+        Returns a LanguageModelUserMessage with the content of the prompt and the images.
+
+        Args:
+            images: List of images in base64 format.
+
+        Returns:
+            LanguageModelUserMessage: The formatted prompt with images.
+        """
+        return LanguageModelUserMessage(
+            content=[
+                {"type": "text", "text": self._content},
+                *[
+                    {"type": "image_url", "imageUrl": {"url": image}}
+                    for image in images
+                ],
+            ]
+        )

unique_toolkit/language_model/schemas.py

@@ -1,4 +1,5 @@
 import json
+import math
 from enum import StrEnum
 from typing import Any, Optional, Self
 from uuid import uuid4
@@ -212,8 +213,10 @@ class LanguageModelTokenLimits(BaseModel):
             if not self.fraction_input:
                 self.fraction_input = 0.4
 
-            self.token_limit_input = self.fraction_input * self.token_limit
-            self.token_limit_output = (1 - self.fraction_input) * self.token_limit
+            self.token_limit_input = math.floor(self.fraction_input * self.token_limit)
+            self.token_limit_output = math.floor(
+                (1 - self.fraction_input) * self.token_limit
+            )
             return self
 
         raise ValueError(

{unique_toolkit-0.5.41.dist-info → unique_toolkit-0.5.43.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 0.5.41
+Version: 0.5.43
 Summary: 
 License: Proprietary
 Author: Martin Fadler
@@ -100,6 +100,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+
+## [0.5.43] - 2024-12-13
+- Add `Prompt` class to handle templated prompts that can be formatted into LanguageModelSystemMessage and LanguageModelUserMessage.
+
+## [0.5.42] - 2024-12-11
+- Update `LanguageModelTokenLimits` with fix avoiding floats for token
+
 ## [0.5.41] - 2024-12-11
 - Update `LanguageModelTokenLimits` includes a fraction_input now to always have input/output token limits available.
 

{unique_toolkit-0.5.41.dist-info → unique_toolkit-0.5.43.dist-info}/RECORD

@@ -35,12 +35,13 @@ unique_toolkit/evaluators/hallucination/service.py,sha256=k8qro5Lw4Ak58m4HYp3G4H
 unique_toolkit/evaluators/hallucination/utils.py,sha256=507BsX1mFTEne1-LdRCNMgBj-IXSFvBj1t3BPe1UkGs,7639
 unique_toolkit/evaluators/output_parser.py,sha256=eI72qkzK1dZyUvnfP2SOAQCGBj_-PwX5wy_aLPMsJMY,883
 unique_toolkit/evaluators/schemas.py,sha256=Jaue6Uhx75X1CyHKWj8sT3RE1JZXTqoLtfLt2xQNCX8,2507
-unique_toolkit/language_model/__init__.py,sha256=YuhyczGPj6w9xX-sOVUhmozvzIFxcckHFEkeMBecr5s,1784
+unique_toolkit/language_model/__init__.py,sha256=hgk5yiFF4SpIcE2QSoki9YknFxmcKnq2LCJ1cK9de9I,1830
 unique_toolkit/language_model/infos.py,sha256=kQK6F3r8xTN7oT6b39J7rxW-Y4iPXjx_Fr9bCOVQdm0,12509
-unique_toolkit/language_model/schemas.py,sha256=-5yTJsEUMKSc6qZ1zdBU9Eewo9qQlpqlVssKHIwUY64,6925
+unique_toolkit/language_model/prompt.py,sha256=JSawaLjQg3VR-E2fK8engFyJnNdk21zaO8pPIodzN4Q,3991
+unique_toolkit/language_model/schemas.py,sha256=MBwEAFnnCYjSpbZDUYLrqkCc-0bsarsepSQEj1v6YEY,6991
 unique_toolkit/language_model/service.py,sha256=brNCPRA0XxgqHi2rI5i2lyFCkUiw4MNMe1VaR3UgWmY,15500
 unique_toolkit/language_model/utils.py,sha256=bPQ4l6_YO71w-zaIPanUUmtbXC1_hCvLK0tAFc3VCRc,1902
-unique_toolkit-0.5.41.dist-info/LICENSE,sha256=GlN8wHNdh53xwOPg44URnwag6TEolCjoq3YD_KrWgss,193
-unique_toolkit-0.5.41.dist-info/METADATA,sha256=im-lBhwsW2ZgUZoA6mfyogye1c6ZIFXqgaw_Ilf2yLs,14764
-unique_toolkit-0.5.41.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-unique_toolkit-0.5.41.dist-info/RECORD,,
+unique_toolkit-0.5.43.dist-info/LICENSE,sha256=GlN8wHNdh53xwOPg44URnwag6TEolCjoq3YD_KrWgss,193
+unique_toolkit-0.5.43.dist-info/METADATA,sha256=Fyf1RYuO_XRaoF0SLEvAQRxKCYOWzIA2AaXgJhUmZNk,15022
+unique_toolkit-0.5.43.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+unique_toolkit-0.5.43.dist-info/RECORD,,