beekeeper-core 1.0.2__py3-none-any.whl → 1.0.10__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/guardrails/__init__.py

@@ -0,0 +1,4 @@
+from beekeeper.core.guardrails.base import BaseGuardrail
+from beekeeper.core.guardrails.types import GuardrailResponse
+
+__all__ = ["BaseGuardrail", "GuardrailResponse"]

beekeeper/core/guardrails/base.py

@@ -0,0 +1,15 @@
+from abc import ABC, abstractmethod
+
+from beekeeper.core.guardrails.types import GuardrailResponse
+
+
+class BaseGuardrail(ABC):
+    """Abstract base class defining the interface for LLMs."""
+
+    @classmethod
+    def class_name(cls) -> str:
+        return "BaseGuardrail"
+
+    @abstractmethod
+    def enforce(self, text: str, direction: str) -> GuardrailResponse:
+        """Runs policies enforcement to specified guardrail."""

beekeeper/core/guardrails/types.py

@@ -0,0 +1,13 @@
+from typing import Any, Optional
+
+from pydantic import BaseModel, Field
+
+
+class GuardrailResponse(BaseModel):
+    """Guardrail response."""
+
+    text: str = Field(..., description="Generated text response")
+    action: Optional[str] = Field(
+        default=None, description="Action taken by the guardrail"
+    )
+    raw: Optional[Any] = Field(default=None)

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,24 +10,28 @@ 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."""
-        return [message.model_dump() for message in messages]
+    def text_completion(self, prompt: str, **kwargs: Any) -> str:
+        """
+        Generates a chat completion for LLM. Using OpenAI's standard endpoint (/completions).
+
+        Args:
+            prompt (str): The input prompt to generate a completion for.
+            **kwargs (Any): Additional keyword arguments to customize the LLM completion request.
+        """
+        response = self.completion(prompt=prompt, **kwargs)
+
+        return response.text
 
     @abstractmethod
     def completion(self, prompt: str, **kwargs: Any) -> GenerateResponse:
         """Generates a completion for LLM."""
 
-    @abstractmethod
-    def text_completion(self, prompt: str, **kwargs: Any) -> str:
-        """Generates a text completion for LLM."""
-
     @abstractmethod
     def chat_completion(
         self, messages: List[ChatMessage], **kwargs: Any

beekeeper/core/llms/decorators.py

@@ -5,11 +5,17 @@ from logging import getLogger
 from typing import Callable
 
 from beekeeper.core.llms.types import ChatMessage
-from beekeeper.core.observers.types import PayloadRecord
+from beekeeper.core.monitors.types import PayloadRecord
+from deprecated import deprecated
 
 logger = getLogger(__name__)
 
 
+@deprecated(
+    reason="'llm_chat_observer()' is deprecated and will be removed in a future version. Use 'llm_chat_monitor()'.",
+    version="1.0.8",
+    action="always",
+)
 def llm_chat_observer() -> Callable:
     """
     Decorator to wrap a method with llm handler logic.
@@ -81,3 +87,76 @@ def llm_chat_observer() -> Callable:
         return async_wrapper
 
     return decorator
+
+
+def llm_chat_monitor() -> Callable:
+    """
+    Decorator to wrap a method with llm handler logic.
+    Looks for observability instances in `self.callback_manager`.
+    """
+
+    def decorator(f: Callable) -> Callable:
+        def async_wrapper(self, *args, **kwargs):
+            callback_manager_fns = getattr(self, "callback_manager", None)
+
+            start_time = time.time()
+            llm_return_val = f(self, *args, **kwargs)
+            response_time = int((time.time() - start_time) * 1000)
+
+            if callback_manager_fns:
+
+                def async_callback_thread():
+                    try:
+                        # Extract input messages
+                        if len(args) > 0 and isinstance(args[0], ChatMessage):
+                            input_chat_messages = args[0]
+                        elif "messages" in kwargs:
+                            input_chat_messages = kwargs["messages"]
+                        else:
+                            raise ValueError(
+                                "No messages provided in positional or keyword arguments"
+                            )
+
+                        # Get the user's latest message after each interaction to chat observability.
+                        user_messages = [
+                            msg for msg in input_chat_messages if msg.role == "user"
+                        ]
+                        last_user_message = (
+                            user_messages[-1].content if user_messages else None
+                        )
+
+                        # Get the system/instruct (first) message to chat observability.
+                        system_messages = [
+                            msg for msg in input_chat_messages if msg.role == "system"
+                        ]
+                        system_message = (
+                            system_messages[0].content if system_messages else None
+                        )
+
+                        callback = callback_manager_fns(
+                            payload=PayloadRecord(
+                                input_text=(system_message or "") + last_user_message,
+                                generated_text=llm_return_val.message.content,
+                                generated_token_count=llm_return_val.raw["usage"][
+                                    "completion_tokens"
+                                ],
+                                input_token_count=llm_return_val.raw["usage"][
+                                    "prompt_tokens"
+                                ],
+                                response_time=response_time,
+                            )
+                        )
+
+                        if asyncio.iscoroutine(callback):
+                            asyncio.run(callback)
+
+                    except Exception as e:
+                        logger.error(f"Observability callback error: {e}")
+
+                threading.Thread(target=async_callback_thread).start()
+
+            return llm_return_val
+
+        return async_wrapper
+
+    return decorator

beekeeper/core/llms/types.py

@@ -18,6 +18,10 @@ class ChatMessage(BaseModel):
     role: MessageRole = Field(default=MessageRole.USER)
     content: Optional[str] = Field(default=None)
 
+    def to_dict(self) -> dict:
+        """Convert ChatMessage to dict."""
+        return self.model_dump(exclude_none=True)
+
 
 class GenerateResponse(BaseModel):
     """Generate response."""

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/monitors/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/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/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.2.dist-info → beekeeper_core-1.0.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beekeeper-core
-Version: 1.0.2
+Version: 1.0.10
 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>
@@ -9,14 +9,14 @@ Keywords: AI,LLM,QA,RAG,data,observability,retrieval,semantic-search
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: <4.0,>=3.10
-Requires-Dist: deprecated<2.0.0,>=1.2.18
+Requires-Python: <3.14,>=3.11
+Requires-Dist: deprecated<2.0.0,>=1.3.1
 Requires-Dist: nltk<4.0.0,>=3.9.2
 Requires-Dist: numpy<1.27.0,>=1.26.4
-Requires-Dist: pydantic<3.0.0,>=2.11.10
-Requires-Dist: tiktoken<0.10.0,>=0.9.0
+Requires-Dist: pydantic<3.0.0,>=2.12.5
+Requires-Dist: tiktoken<0.13.0,>=0.12.0
 Provides-Extra: dev
-Requires-Dist: ruff>=0.11.13; extra == 'dev'
+Requires-Dist: ruff>=0.14.9; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # Beekeeper Core

{beekeeper_core-1.0.2.dist-info → beekeeper_core-1.0.10.dist-info}/RECORD

@@ -3,20 +3,26 @@ 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/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/guardrails/__init__.py,sha256=onznwYWAyOaxOVeYZle7oDtj3QJODQvJHcf5td_laZg,169
+beekeeper/core/guardrails/base.py,sha256=T-Ywr80iTL0EFYarCymFEEI3QkMsrw27JVh_0407sEU,427
+beekeeper/core/guardrails/types.py,sha256=7sgw1S5BZY0OqO-n04pHXPU7sG-NEZJlQyIeb2Fsq9Q,359
+beekeeper/core/llms/__init__.py,sha256=PN-5Y_Km_l2vO8v9d7iJ6_5xPCZJBh8UzwqRvQZlmTo,250
+beekeeper/core/llms/base.py,sha256=jFU1om9Qk6KTIsZXeke7lMp--x009G6-fnM1615l2BQ,1292
+beekeeper/core/llms/decorators.py,sha256=wRYXlKD5Cc8k1qPGYEEv-RSJdoHj-MQqKuAAQzkN9Fc,6534
+beekeeper/core/llms/types.py,sha256=lWswZ_bJkPmoTeheWxB1-OnABTYIVAcASkZCwjaTLzE,847
+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/observers/types.py,sha256=s-4tB8OdeaCUIRvi6FLuib2u4Yl9evqQdCundNREXQY,217
-beekeeper/core/prompts/__init__.py,sha256=MKVxQKhA72Pm4oaVMDIRYE3fB70A2Jd2Re0UZSmFIoE,88
-beekeeper/core/prompts/base.py,sha256=cuRSv30aromymNO2wuuprrrWFm5PxRTymYoVqscK4Us,739
+beekeeper/core/prompts/__init__.py,sha256=kFp2N5giNEMA4hc3eZqstqaZu0c0BRAnP0NuF5aUaqI,85
+beekeeper/core/prompts/base.py,sha256=Edh77DuYm8lDhJvHazC5hgaiQEit-R4M-TWLX8-gIU0,1106
 beekeeper/core/prompts/utils.py,sha256=Cqpefzzxd6DxPbOKVyUCsIs-ibBGKhYU6ppYqhPT9vM,1378
 beekeeper/core/readers/__init__.py,sha256=vPCmWmK92LYL-R0LFcPqjOKFHqxW0xUP5r6M9GNxoqY,157
 beekeeper/core/readers/base.py,sha256=46VRNkCmKP2RWJT1-kRTSHG9SjY1xbhKUy1a7-OrgPg,418
@@ -32,6 +38,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.10.dist-info/METADATA,sha256=6yt3XFndeAKudQ_UsnQFZ_B_MeibOrrrIk_yt_zRV_0,1331
+beekeeper_core-1.0.10.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+beekeeper_core-1.0.10.dist-info/RECORD,,