beekeeper-core 1.0.2__py3-none-any.whl → 1.0.4__py3-none-any.whl

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/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/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/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/monitors/__init__.py

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

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/observers/__init__.py

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

beekeeper/core/observers/base.py

@@ -1,36 +1,33 @@
-from abc import ABC, abstractmethod
-from typing import Optional
+from beekeeper.core.monitors import BaseMonitor, PromptMonitor
+from deprecated import deprecated
 
-from beekeeper.core.observers.types import PayloadRecord
-from beekeeper.core.prompts import PromptTemplate
 
+class BaseObserver(BaseMonitor):
+    """DEPRECATED: An interface for observability."""
 
-class BaseObserver(ABC):
-    """An interface for observability."""
 
-    @classmethod
-    def class_name(cls) -> str:
-        return "BaseObserver"
+@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."""
 
 
-class ModelObserver(BaseObserver):
-    """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."""
 
-    def __init__(self, prompt_template: Optional[PromptTemplate] = None) -> None:
-        self.prompt_template = prompt_template
 
-    @classmethod
-    def class_name(cls) -> str:
-        return "ModelObserver"
-
-    @abstractmethod
-    def __call__(self, payload: PayloadRecord) -> None:
-        """ModelObserver."""
-
-
-class TelemetryObserver(BaseObserver):
-    """Abstract base class defining the interface for telemetry observability."""
-
-    @classmethod
-    def class_name(cls) -> str:
-        return "TelemetryObserver"
+@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/prompts/__init__.py

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

{beekeeper_core-1.0.2.dist-info → beekeeper_core-1.0.4.dist-info}/METADATA

@@ -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.dist-info → beekeeper_core-1.0.4.dist-info}/RECORD

@@ -3,19 +3,21 @@ beekeeper/core/schema.py,sha256=8OZkRVDry6nglof38w4AvWaRDpf0zOUtqGyfWBhj8lk,267
 beekeeper/core/document/__init__.py,sha256=nCN0CNee1v-28W5a26Ca6iAVefcr_KAieAH6QfN4eyw,144
 beekeeper/core/document/base.py,sha256=NBlyj8C0uvvsiElU1wFcXU27LOb3VP0U11nMgOR6cgY,2635
 beekeeper/core/embeddings/__init__.py,sha256=4AzGUtoL7wComtQ-bEVwzoMQgahBhpxcF_4M5rQ0ClQ,159
-beekeeper/core/embeddings/base.py,sha256=FerdOZt-U3SD8LwlXbLlo-oyCs5zoA4tVqa3bcj6bhg,3116
+beekeeper/core/embeddings/base.py,sha256=3r_gr9ceezuAXexkeS5Bq23778BeF7h--IDEvL5pLjE,3464
 beekeeper/core/evaluation/__init__.py,sha256=FyZGpbTXcIM3BynssiS6wUm2KZkMnLVmKF50D7iqkXM,135
-beekeeper/core/evaluation/context_similarity.py,sha256=SX4__MBClfBWpH1ZbgOMksQakhg9Fz5RUlKGEjkZDb0,2706
+beekeeper/core/evaluation/context_similarity.py,sha256=kT1J3HUgF51HHQA5Sew9ahbSV_jhgbCBMRYqPLKlljQ,2690
 beekeeper/core/flows/__init__.py,sha256=v6VLJ309l5bHYcG1JLUu6_kRoOwIZazonH4-n_UQzYQ,91
 beekeeper/core/flows/ingestion_flow.py,sha256=lfZM6lHF9rBTviimSlptHm_1htaA5qLLhE-Sm_7fwGY,6110
-beekeeper/core/llms/__init__.py,sha256=8fPQqw9vYdQJtQlYyFF9YskFSQBHBstmqurPOyEb0rA,259
-beekeeper/core/llms/base.py,sha256=5q7MsFcm__1NgGRsLiear-24bfdELl2y7gvZ0TKSCjc,1174
+beekeeper/core/llms/__init__.py,sha256=PN-5Y_Km_l2vO8v9d7iJ6_5xPCZJBh8UzwqRvQZlmTo,250
+beekeeper/core/llms/base.py,sha256=cMllU_pJeNQGnSXX8WfHc09nrlLLx7cSKtRk9e_ubSg,1174
 beekeeper/core/llms/decorators.py,sha256=lPfrQPFiCLAp468mVsiX6DIxSIvmrHjz3urnV9-q54U,3284
 beekeeper/core/llms/types.py,sha256=CqLsB78y6-y8actABp87nHQh3AhHcE5i4IjeUxaXyA4,722
-beekeeper/core/observers/__init__.py,sha256=O2TNVupW0UKBDnhPAoz1YB6uQXws7YdDPi-GOGw2il0,118
-beekeeper/core/observers/base.py,sha256=9fnPCuwPc7Krialv4Ooq6uCiempkKHdFEwbiAF4UWvw,962
-beekeeper/core/observers/types.py,sha256=s-4tB8OdeaCUIRvi6FLuib2u4Yl9evqQdCundNREXQY,217
-beekeeper/core/prompts/__init__.py,sha256=MKVxQKhA72Pm4oaVMDIRYE3fB70A2Jd2Re0UZSmFIoE,88
+beekeeper/core/monitors/__init__.py,sha256=TvoiIUJtWRO_4zqCICsFaGl_v4Tpvft1M542Bi13pOI,112
+beekeeper/core/monitors/base.py,sha256=3ooSfgVpWoRLe2TqizHMRK_bI5C-sla57aYJ47FmIXM,980
+beekeeper/core/monitors/types.py,sha256=s-4tB8OdeaCUIRvi6FLuib2u4Yl9evqQdCundNREXQY,217
+beekeeper/core/observers/__init__.py,sha256=Z5sDAajai4QLdGIrjq-vr5eJEBhriMMCw5u46j6xHvA,149
+beekeeper/core/observers/base.py,sha256=y1SE_0WQusKhVomFuZCkk42Jb7r93ZS6r_j8vs_Y_r4,1203
+beekeeper/core/prompts/__init__.py,sha256=kFp2N5giNEMA4hc3eZqstqaZu0c0BRAnP0NuF5aUaqI,85
 beekeeper/core/prompts/base.py,sha256=cuRSv30aromymNO2wuuprrrWFm5PxRTymYoVqscK4Us,739
 beekeeper/core/prompts/utils.py,sha256=Cqpefzzxd6DxPbOKVyUCsIs-ibBGKhYU6ppYqhPT9vM,1378
 beekeeper/core/readers/__init__.py,sha256=vPCmWmK92LYL-R0LFcPqjOKFHqxW0xUP5r6M9GNxoqY,157
@@ -32,6 +34,6 @@ beekeeper/core/tools/base.py,sha256=A6TXn7g3DAZMREYAobfVlyOBuJn_8mIeCByc5412L9Y,
 beekeeper/core/utils/pairwise.py,sha256=cpi8GItPFSYP4sjB5zgTFHi6JfBVWsMnNu8koA9VYQU,536
 beekeeper/core/vector_stores/__init__.py,sha256=R5SRG3YpOZqRwIfBLB8KVV6FALWqhIzIhCjRGj-bwPc,93
 beekeeper/core/vector_stores/base.py,sha256=YFW1ioZbFEcJovAh0ZCpHnj0eiXtZvqy_pj2lxPS92k,1652
-beekeeper_core-1.0.2.dist-info/METADATA,sha256=axLwH-NNoKs7_KuaEvyJCSNlXFVRRPYy6U0T66eto9Y,1331
-beekeeper_core-1.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-beekeeper_core-1.0.2.dist-info/RECORD,,
+beekeeper_core-1.0.4.dist-info/METADATA,sha256=jQ78PrN-WvYM4Kmt_hLLEzPeWN_wrGk49mNGh826ZMY,1331
+beekeeper_core-1.0.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+beekeeper_core-1.0.4.dist-info/RECORD,,