beekeeper-core 1.0.2__tar.gz → 1.0.4__tar.gz

{beekeeper_core-1.0.2 → beekeeper_core-1.0.4}/.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.2 → beekeeper_core-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beekeeper-core
-Version: 1.0.2
+Version: 1.0.4
 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.2 → beekeeper_core-1.0.4}/beekeeper/core/embeddings/base.py

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 from enum import Enum
-from typing import List
+from typing import List, Union
 
 import numpy as np
 from beekeeper.core.document import Document
@@ -43,17 +43,20 @@ class BaseEmbedding(TransformerComponent, ABC):
         return "BaseEmbedding"
 
     @abstractmethod
-    def embed_texts(self, texts: List[str]) -> List[Embedding]:
-        """Embed a list of text strings."""
-
-    def embed_text(self, query: str) -> Embedding:
-        """Embed a single text string."""
-        return self.embed_texts([query])[0]
+    def embed_text(
+        self, input: Union[str, List[str]]
+    ) -> Union[Embedding, List[Embedding]]:
+        """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_texts(texts)
+        embeddings = self.embed_text(texts)
 
         for document, embedding in zip(documents, embeddings):
             document.embedding = embedding
@@ -61,7 +64,15 @@ class BaseEmbedding(TransformerComponent, ABC):
         return documents
 
     @deprecated(
-        reason="'get_text_embedding()' is deprecated and will be removed in a future version. Use 'embed_text' instead.",
+        reason="'embed_texts()' is deprecated and will be removed in a future version. Use 'embed_text()' instead.",
+        version="1.0.3",
+        action="always",
+    )
+    def embed_texts(self, texts: List[str]) -> List[Embedding]:
+        return self.embed_text(texts)
+
+    @deprecated(
+        reason="'get_text_embedding()' is deprecated and will be removed in a future version. Use 'embed_text()' instead.",
         version="1.0.2",
         action="always",
     )
@@ -69,7 +80,7 @@ class BaseEmbedding(TransformerComponent, ABC):
         return self.embed_text(query)
 
     @deprecated(
-        reason="'get_texts_embedding()' is deprecated and will be removed in a future version. Use 'embed_texts' instead.",
+        reason="'get_texts_embedding()' is deprecated and will be removed in a future version. Use 'embed_texts()' instead.",
         version="1.0.2",
         action="always",
     )
@@ -77,7 +88,7 @@ class BaseEmbedding(TransformerComponent, ABC):
         return self.embed_texts(texts)
 
     @deprecated(
-        reason="'get_documents_embedding()' is deprecated and will be removed in a future version. Use 'embed_documents' instead.",
+        reason="'get_documents_embedding()' is deprecated and will be removed in a future version. Use 'embed_documents()' instead.",
         version="1.0.2",
         action="always",
     )

{beekeeper_core-1.0.2 → beekeeper_core-1.0.4}/beekeeper/core/evaluation/context_similarity.py

@@ -53,10 +53,10 @@ class ContextSimilarityEvaluator(BaseModel):
             )
 
         evaluation_result = {"contexts_score": [], "score": 0}
-        candidate_embedding = self.embed_model.get_text_embedding(generated_text)
+        candidate_embedding = self.embed_model.embed_text(generated_text)
 
         for context in contexts:
-            context_embedding = self.embed_model.get_text_embedding(context)
+            context_embedding = self.embed_model.embed_text(context)
             evaluation_result["contexts_score"].append(
                 self.embed_model.similarity(
                     candidate_embedding,

{beekeeper_core-1.0.2 → beekeeper_core-1.0.4}/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.2 → beekeeper_core-1.0.4}/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.4/beekeeper/core/monitors/__init__.py

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

{beekeeper_core-1.0.2/beekeeper/core/observers → beekeeper_core-1.0.4/beekeeper/core/monitors}/base.py

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

beekeeper_core-1.0.4/beekeeper/core/observers/__init__.py

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

beekeeper_core-1.0.4/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.2 → beekeeper_core-1.0.4}/beekeeper/core/prompts/__init__.py

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

{beekeeper_core-1.0.2 → beekeeper_core-1.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "beekeeper-core"
-version = "1.0.2"
+version = "1.0.4"
 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.2/beekeeper/core/observers/__init__.py

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