beekeeper-core 1.0.3__tar.gz → 1.0.6__tar.gz

{beekeeper_core-1.0.3 → beekeeper_core-1.0.6}/.gitignore

@@ -73,7 +73,7 @@ target/
 # pyenv
 #   For a library or package, you might want to ignore these files since the code is
 #   intended to run in multiple environments; otherwise, check them in:
-# .python-version
+.python-version
 
 # Environments
 .env

{beekeeper_core-1.0.3 → beekeeper_core-1.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beekeeper-core
-Version: 1.0.3
+Version: 1.0.6
 Summary: Load any data in one line of code and connect with AI applications
 Project-URL: Repository, https://github.com/beekeeper-ai/beekeeper
 Author-email: Leonardo Furnielis <leonardofurnielis@outlook.com>

{beekeeper_core-1.0.3 → beekeeper_core-1.0.6}/beekeeper/core/embeddings/base.py

@@ -49,7 +49,12 @@ class BaseEmbedding(TransformerComponent, ABC):
         """Embed one or more text strings."""
 
     def embed_documents(self, documents: List[Document]) -> List[Document]:
-        """Embed a list of documents and set them in the 'embedding' attribute."""
+        """
+        Embed a list of documents and assign the computed embeddings to the 'embedding' attribute.
+
+        Args:
+            documents (List[Document]): List of documents to compute embeddings.
+        """
         texts = [document.get_content() for document in documents]
         embeddings = self.embed_text(texts)
 

{beekeeper_core-1.0.3 → beekeeper_core-1.0.6}/beekeeper/core/llms/__init__.py

@@ -6,6 +6,4 @@ from beekeeper.core.llms.types import (
     MessageRole,
 )
 
-__all__ = (
-    ["BaseLLM", "ChatMessage", "ChatResponse", "GenerateResponse", "MessageRole"],
-)
+__all__ = ["BaseLLM", "ChatMessage", "ChatResponse", "GenerateResponse", "MessageRole"]

{beekeeper_core-1.0.3 → beekeeper_core-1.0.6}/beekeeper/core/llms/base.py

@@ -2,7 +2,7 @@ from abc import ABC, abstractmethod
 from typing import Any, List, Optional
 
 from beekeeper.core.llms.types import ChatMessage, ChatResponse, GenerateResponse
-from beekeeper.core.observers import BaseObserver
+from beekeeper.core.monitors import BaseMonitor
 from pydantic import BaseModel
 
 
@@ -10,14 +10,14 @@ class BaseLLM(ABC, BaseModel):
     """Abstract base class defining the interface for LLMs."""
 
     model_config = {"arbitrary_types_allowed": True}
-    callback_manager: Optional[BaseObserver] = None
+    callback_manager: Optional[BaseMonitor] = None
 
     @classmethod
     def class_name(cls) -> str:
         return "BaseLLM"
 
     def convert_chat_messages(self, messages: List[ChatMessage]) -> List[dict]:
-        """Convert chat messages to LLM message format."""
+        """Convert ChatMessage to LLM message dict format."""
         return [message.model_dump() for message in messages]
 
     @abstractmethod

beekeeper_core-1.0.6/beekeeper/core/monitors/__init__.py

@@ -0,0 +1,3 @@
+from beekeeper.core.monitors.base import BaseMonitor, PromptMonitor
+
+__all__ = ["BaseMonitor", "PromptMonitor"]

beekeeper_core-1.0.6/beekeeper/core/monitors/base.py

@@ -0,0 +1,36 @@
+from abc import ABC, abstractmethod
+from typing import Optional
+
+from beekeeper.core.monitors.types import PayloadRecord
+from beekeeper.core.prompts import PromptTemplate
+
+
+class BaseMonitor(ABC):
+    """Abstract base class defining the interface for monitors."""
+
+    @classmethod
+    def class_name(cls) -> str:
+        return "BaseMonitor"
+
+
+class PromptMonitor(BaseMonitor):
+    """Abstract base class defining the interface for prompt observability."""
+
+    def __init__(self, prompt_template: Optional[PromptTemplate] = None) -> None:
+        self.prompt_template = prompt_template
+
+    @classmethod
+    def class_name(cls) -> str:
+        return "PromptMonitor"
+
+    @abstractmethod
+    def __call__(self, payload: PayloadRecord) -> None:
+        """PromptMonitor."""
+
+
+class TelemetryMonitor(BaseMonitor):
+    """Abstract base class defining the interface for telemetry observability."""
+
+    @classmethod
+    def class_name(cls) -> str:
+        return "TelemetryMonitor"

{beekeeper_core-1.0.3 → beekeeper_core-1.0.6}/beekeeper/core/observers/__init__.py

@@ -1,3 +1,3 @@
 from beekeeper.core.observers.base import BaseObserver, ModelObserver, PromptObserver
 
-__all__ = (["BaseObserver", "ModelObserver", "PromptObserver"],)
+__all__ = ["BaseObserver", "ModelObserver", "PromptObserver"]

beekeeper_core-1.0.6/beekeeper/core/observers/base.py

@@ -0,0 +1,33 @@
+from beekeeper.core.monitors import BaseMonitor, PromptMonitor
+from deprecated import deprecated
+
+
+class BaseObserver(BaseMonitor):
+    """DEPRECATED: An interface for observability."""
+
+
+@deprecated(
+    reason="'PromptObserver()' is deprecated and will be removed in a future version. Use 'PromptMonitor()' from 'beekeeper.core.monitors' instead.",
+    version="1.0.4",
+    action="always",
+)
+class PromptObserver(PromptMonitor):
+    """DEPRECATED: Abstract base class defining the interface for prompt observability."""
+
+
+@deprecated(
+    reason="'ModelObserver()' is deprecated and will be removed in a future version. Use 'PromptMonitor()' from 'beekeeper.core.monitors' instead.",
+    version="1.0.3",
+    action="always",
+)
+class ModelObserver(PromptMonitor):
+    """DEPRECATED: This class is deprecated and kept only for backward compatibility."""
+
+
+@deprecated(
+    reason="'TelemetryObserver()' is deprecated and will be removed in a future version. Use 'TelemetryMonitor()' from 'beekeeper.core.monitors' instead.",
+    version="1.0.4",
+    action="always",
+)
+class TelemetryObserver(BaseMonitor):
+    """DEPRECATED: Abstract base class defining the interface for telemetry observability."""

beekeeper_core-1.0.6/beekeeper/core/observers/types.py

@@ -0,0 +1,11 @@
+from pydantic import BaseModel
+
+
+class PayloadRecord(BaseModel):
+    """Payload record."""
+
+    input_text: str
+    generated_text: str
+    generated_token_count: int
+    input_token_count: int
+    response_time: int

{beekeeper_core-1.0.3 → beekeeper_core-1.0.6}/beekeeper/core/prompts/__init__.py

@@ -1,3 +1,3 @@
 from beekeeper.core.prompts.base import PromptTemplate
 
-__all__ = (["PromptTemplate"],)
+__all__ = ["PromptTemplate"]

{beekeeper_core-1.0.3 → beekeeper_core-1.0.6}/beekeeper/core/prompts/base.py

@@ -22,6 +22,18 @@ class PromptTemplate(BaseModel):
     def __init__(self, template: str):
         super().__init__(template=template)
 
+    @classmethod
+    def from_value(cls, value: str) -> "PromptTemplate":
+        if isinstance(value, cls):
+            return value
+
+        if isinstance(value, str):
+            return cls(value)
+
+        raise TypeError(
+            f"Invalid type for parameter 'prompt_template'. Expected str or PromptTemplate, but received {type(value).__name__}."
+        )
+
     def format(self, **kwargs):
         """
         Formats the template using the provided dynamic variables.

{beekeeper_core-1.0.3 → beekeeper_core-1.0.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "beekeeper-core"
-version = "1.0.3"
+version = "1.0.6"
 description = "Load any data in one line of code and connect with AI applications"
 authors = [{ name = "Leonardo Furnielis", email = "leonardofurnielis@outlook.com" }]
 license = { text = "Apache-2.0" }

beekeeper_core-1.0.3/beekeeper/core/observers/base.py

@@ -1,46 +0,0 @@
-from abc import ABC, abstractmethod
-from typing import Optional
-
-from beekeeper.core.observers.types import PayloadRecord
-from beekeeper.core.prompts import PromptTemplate
-from deprecated import deprecated
-
-
-class BaseObserver(ABC):
-    """An interface for observability."""
-
-    @classmethod
-    def class_name(cls) -> str:
-        return "BaseObserver"
-
-
-class PromptObserver(BaseObserver):
-    """Abstract base class defining the interface for prompt observability."""
-
-    def __init__(self, prompt_template: Optional[PromptTemplate] = None) -> None:
-        self.prompt_template = prompt_template
-
-    @classmethod
-    def class_name(cls) -> str:
-        return "PromptObserver"
-
-    @abstractmethod
-    def __call__(self, payload: PayloadRecord) -> None:
-        """PromptObserver."""
-
-
-@deprecated(
-    reason="'ModelObserver()' is deprecated and will be removed in a future version. Use 'PromptObserver()' instead.",
-    version="1.0.3",
-    action="always",
-)
-class ModelObserver(PromptObserver):
-    """DEPRECATED: This class is deprecated and kept only for backward compatibility."""
-
-
-class TelemetryObserver(BaseObserver):
-    """Abstract base class defining the interface for telemetry observability."""
-
-    @classmethod
-    def class_name(cls) -> str:
-        return "TelemetryObserver"