projectdavid 1.31.0__py3-none-any.whl → 1.38.1__py3-none-any.whl

projectdavid/decorators.py

@@ -0,0 +1,64 @@
+# decorators.py
+
+import functools
+import warnings
+from typing import Optional
+
+
+class ExperimentalWarning(UserWarning):
+    """
+    API is experimental, may be incomplete (and possibly not fully functional),
+    and may change or be removed without notice.
+    """
+
+
+class InternalWarning(UserWarning):
+    """
+    API is internal/admin-only. Intended for framework authors and
+    superusers—will likely change or go away without notice.
+    """
+
+
+def experimental(func):
+    """
+    Decorator to mark methods as experimental.
+    Emits an ExperimentalWarning on first call.
+    """
+
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        warnings.warn(
+            f"{func.__name__} is experimental, may be incomplete, and may change in a future release",
+            ExperimentalWarning,
+            stacklevel=2,
+        )
+        return func(*args, **kwargs)
+
+    wrapper.__experimental__ = True
+    return wrapper
+
+
+def internal(func):
+    """
+    Decorator to mark a method as internal/admin-only.
+    Raises PermissionError if self.is_admin is False or missing.
+    Emits an InternalWarning on use.
+    """
+
+    @functools.wraps(func)
+    def wrapper(self, *args, **kwargs):
+        # 1️⃣ Enforce admin
+        if not getattr(self, "is_admin", False):
+            raise PermissionError(
+                f"{func.__name__} is for admin use only; your client.is_admin is False."
+            )
+        # 2️⃣ Warn about internal usage
+        warnings.warn(
+            f"{func.__name__} is internal/admin-only and may change without notice",
+            InternalWarning,
+            stacklevel=2,
+        )
+        return func(self, *args, **kwargs)
+
+    wrapper.__internal__ = True
+    return wrapper

projectdavid/entity.py

@@ -18,27 +18,44 @@ from .clients.users_client import UsersClient
 from .clients.vectors import VectorStoreClient
 from .utils.run_monitor import HttpRunMonitor
 
-# Load environment variables from .env file.
-load_dotenv()
-
 # Initialize logging utility.
 logging_utility = UtilsInterface.LoggingUtility()
 
 
+class MissingAPIKeyError(ValueError):
+    """Raised when no API key is provided via arg or ENTITIES_API_KEY env var."""
+
+
 class Entity:
     def __init__(
         self,
         base_url: Optional[str] = None,
         api_key: Optional[str] = None,
+        file_processor_kwargs: Optional[dict] = None,
     ):
         """
         Initialize the main client with configuration.
         Optionally, a configuration object can be injected to decouple from environment variables.
         """
+
+        self.file_processor_kwargs = file_processor_kwargs
+
+        # -------- 1. Resolve key  -------------------------------------------------
+        self.api_key = (
+            api_key
+            or os.getenv("ENTITIES_API_KEY")  # new variable name
+            or os.getenv("API_KEY")  # legacy support, if you like
+        )
+
+        if not self.api_key:
+            raise MissingAPIKeyError(
+                "No API key supplied. Set ENTITIES_API_KEY in your environment "
+                "or pass api_key='sk-...' when creating the client."
+            )
+
         self.base_url = base_url or os.getenv(
             "ENTITIES_BASE_URL", "http://localhost:9000/"
         )
-        self.api_key = api_key or os.getenv("API_KEY", "your_api_key")
 
         logging_utility.info("Entity initialized with base_url: %s", self.base_url)
 
@@ -145,7 +162,9 @@ class Entity:
     def vectors(self) -> VectorStoreClient:
         if self._vectors_client is None:
             self._vectors_client = VectorStoreClient(
-                base_url=self.base_url, api_key=self.api_key
+                base_url=self.base_url,
+                api_key=self.api_key,
+                file_processor_kwargs=self.file_processor_kwargs,
             )
 
         return self._vectors_client

projectdavid/synthesis/reranker.py

@@ -1,10 +1,12 @@
+#
 from typing import Any, Dict, List
 
-from sentence_transformers import CrossEncoder
-
 
 def rerank(query: str, hits: List[Dict[str, Any]], top_k: int = 10) -> List[Dict]:
     try:
+
+        from sentence_transformers import CrossEncoder
+
         cross_encoder = CrossEncoder(
             "cross-encoder/ms-marco-MiniLM-L-6-v2",
             max_length=512,

projectdavid/utils/function_call_suppressor.py

@@ -0,0 +1,40 @@
+# ------------------------------------------------------------------
+# utils.function_call_suppressor (unchanged except for logger)
+# ------------------------------------------------------------------
+import re
+
+from projectdavid_common.utilities.logging_service import LoggingUtility
+
+LOG = LoggingUtility()
+
+
+class FunctionCallSuppressor:
+    OPEN_RE = re.compile(r"<\s*fc\s*>", re.I)
+    CLOSE_RE = re.compile(r"</\s*fc\s*>", re.I)
+
+    def __init__(self):
+        self.in_fc = False
+        self.buf = ""
+
+    def filter_chunk(self, txt: str) -> str:
+        self.buf += txt
+        out = ""
+        while self.buf:
+            if not self.in_fc:
+                m = self.OPEN_RE.search(self.buf)
+                if not m:
+                    out += self.buf
+                    self.buf = ""
+                    break
+                out += self.buf[: m.start()]
+                LOG.debug("[SUPPRESSOR] <fc> detected")
+                self.buf = self.buf[m.end() :]
+                self.in_fc = True
+            else:
+                m = self.CLOSE_RE.search(self.buf)
+                if not m:
+                    break
+                LOG.debug("[SUPPRESSOR] </fc> detected — block suppressed")
+                self.buf = self.buf[m.end() :]
+                self.in_fc = False
+        return out

{projectdavid-1.31.0.dist-info → projectdavid-1.38.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: projectdavid
-Version: 1.31.0
+Version: 1.38.1
 Summary: Python SDK for interacting with the Entities Assistant API.
 Author-email: Francis Neequaye Armah <francis.neequaye@projectdavid.co.uk>
 License: PolyForm Noncommercial License 1.0.0
@@ -20,14 +20,13 @@ Requires-Dist: pydantic<3.0,>=2.0
 Requires-Dist: python-dotenv<2.0,>=1.0.1
 Requires-Dist: aiofiles<25.0,>=23.2.1
 Requires-Dist: ollama<0.5.0,>=0.4.4
-Requires-Dist: projectdavid_common==0.17.2
+Requires-Dist: projectdavid_common==0.19.0
 Requires-Dist: qdrant-client<2.0.0,>=1.0.0
 Requires-Dist: pdfplumber<0.12.0,>=0.11.0
 Requires-Dist: validators<0.35.0,>=0.29.0
 Requires-Dist: sentence-transformers<5.0,>=3.4.0
 Requires-Dist: sseclient-py
 Requires-Dist: requests
-Requires-Dist: python-magic
 Requires-Dist: python-docx
 Requires-Dist: python-pptx
 Provides-Extra: dev
@@ -227,7 +226,7 @@ Would you like a deeper dive into any of these trends?
 
 
 
-## 📚 Documentation
+##  Documentation
 
 | Domain              | Link                                                   |
 |---------------------|--------------------------------------------------------|
@@ -252,9 +251,9 @@ Would you like a deeper dive into any of these trends?
 
 ---
 
-## 🌍 Related Repositories
+##   Related Repositories
 
-- 🔌 [Entities API](https://github.com/frankie336/entities_api) — containerized API backend
+-   [Entities API](https://github.com/frankie336/entities_api) — containerized API backend
 - 
-- 📚 [entities_common](https://github.com/frankie336/entities_common) — shared validation, schemas, utilities, and tools.
+-   [entities_common](https://github.com/frankie336/entities_common) — shared validation, schemas, utilities, and tools.
       This package is auto installed as dependency of entities SDK or entities API.

{projectdavid-1.31.0.dist-info → projectdavid-1.38.1.dist-info}/RECORD

@@ -1,39 +1,43 @@
 projectdavid/__init__.py,sha256=QKjYL0-e4ifiRWyp05lK_dGm0u_jaxo36fyF-c0qqeI,224
 projectdavid/_version.py,sha256=_qiy4uXbgWEU-in9CM9h6tk4Ddhzpvv-HnoAYSuiGg0,100
-projectdavid/entity.py,sha256=uqRggs1zLWYnKnycPwO5pUhVegOJN8nCC0R9F2RYROI,5634
+projectdavid/decorators.py,sha256=xwjzSNJdg8pOeicdtWEeJeuwAwfrWfM2_cH9tI5O-l0,1730
+projectdavid/entity.py,sha256=gTaNoRbic2MCIqTRR3R1MYGIkMGR7gJyS5WL_SkD1wA,6329
 projectdavid/events.py,sha256=m_vu5BgphrM6dpBmnkTXK8jczwyYXO1UwXXI9340vjQ,720
 projectdavid/serializers.py,sha256=OdipJGXGGjRoZBcPkpmHSDgsNptXUg0CMn2TQoCZIOI,1723
 projectdavid/clients/actions_client.py,sha256=9DVkQzRA3wQ7DIHR1ab6VFQYcIkhExAQz1-EK8MEt2c,17006
 projectdavid/clients/api_key_client.py,sha256=8O1lkvb97WhB8V9jdPmleJ5jqWVuXJrnlBNB-u3vlwc,12650
-projectdavid/clients/assistants_client.py,sha256=SsIGa5wPr7ga9WX0ywam3djUF-uWFdk_hLWJapzVk1w,11337
+projectdavid/clients/assistants_client.py,sha256=Oo8Gu9zfCiIFaGWj2v2I4vfzejro9QXo0BR4wRZsr_I,10990
 projectdavid/clients/base_client.py,sha256=UWl6nr6sxD1_xC6iyptQDR1tnNdFCOrEx5cEUPCRqJE,3417
 projectdavid/clients/base_vector_store.py,sha256=jXivmqAW1bgYcLgIeW-hPxOiWZbs2hCsLy4oWzSvpNI,2061
 projectdavid/clients/event_handler.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-projectdavid/clients/file_processor.py,sha256=-dRibUVVfGXjPRP3P2kzJaRZYvagIUKgDmfmi96V45w,15586
+projectdavid/clients/file_processor.py,sha256=9JYejhg9htgNbfgblWB7K2xX68BdxmagjqqqhmUwq9I,15629
 projectdavid/clients/file_search.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 projectdavid/clients/files_client.py,sha256=XkIDzbQFGDrd88taf0Kouc_4YJOPIYEHiIyWYLKDofI,15581
 projectdavid/clients/inference_client.py,sha256=xz4ACPv5Tkis604QxO5mJX1inH_TGDfQP-31geETYpE,6609
-projectdavid/clients/messages_client.py,sha256=467xeIt3VYs6cG8-bl-eDRi_auWOPmfd5tSJDmQSJUI,17232
-projectdavid/clients/runs.py,sha256=-fXOq5L9w2efDPmZkNxb0s2yjl6oN0XN4_aLXqaeceo,25270
-projectdavid/clients/synchronous_inference_wrapper.py,sha256=25dNSel5DVieu2aFg6G1e4ENo5WWB4EB8_jugIiVzlo,3433
-projectdavid/clients/threads_client.py,sha256=ekzU5w14zftmtmFkiec3NC90Of-_KVSUY1qH9cmfSFg,6771
+projectdavid/clients/messages_client.py,sha256=-tUubr5f62nLER6BxVY3ihp3vn3pnZH-ceigvQRSlYs,16825
+projectdavid/clients/runs.py,sha256=-klntZIcpYLphFtPUcOGoxAJtwqHuI-dlDTSNJx8fp8,21728
+projectdavid/clients/synchronous_inference_wrapper.py,sha256=sW0jwTALuwnZeRuB5FtRppLEqEhAImpQ8UeeBIQtFH8,4789
+projectdavid/clients/threads_client.py,sha256=9RshJD09kfYxfarTysQz_Bwbv4XxQaHQXhCLRMdaWcI,7392
 projectdavid/clients/tools_client.py,sha256=GkCVOmwpAoPqVt6aYmH0G1HIFha3iEwR9IIf9teR0j8,11487
 projectdavid/clients/users_client.py,sha256=eCuUb9qvyH1GUFhZu6TRL9zdoK-qzHSs8-Vmrk_0mmg,13729
-projectdavid/clients/vector_store_manager.py,sha256=lk-sWJjo6Z0EHZzjRoKiHPr0GpEXfE4bJBQzmKV8ezc,11372
-projectdavid/clients/vectors.py,sha256=1UNnLN5nsMvVHXK4Yf7iTXGWZfgIjQ9eLQtCBe0Cqew,30986
+projectdavid/clients/vector_store_manager.py,sha256=A-L1rhURKwiRs0EDd1HOuIShOtaC9Hb1yHB4He456Zc,15943
+projectdavid/clients/vectors.py,sha256=BSa2dN5MKhn0bqDrDCD1wey5J9hCPGOJZFMbOUENPlo,32096
+projectdavid/clients/vision-file_processor.py,sha256=fyD1JVZXSkibJ1ZwIRGhPmCUBOlozAFlETFefPD22Cw,17214
+projectdavid/clients/vision_vectors.py,sha256=cysPVbUzW3byB82MTqG2X1Iz5ZAe82WTS1JfQcoqVhE,40229
 projectdavid/constants/platform.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 projectdavid/services/logging_service.py,sha256=jdoRL46E42Ar8JFTDOV-xVD67CulcHSN-xhcEqA5CXQ,2643
 projectdavid/synthesis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 projectdavid/synthesis/llm_synthesizer.py,sha256=6dlZ4XRCZSsRNuNbyogIeoGwW2dlGg42PtT3Ud5D-gU,3930
 projectdavid/synthesis/prompt.py,sha256=Jlya6avnWV5ryaJaibt4W29XYxRlJRV6rwHfjgYyh2U,799
-projectdavid/synthesis/reranker.py,sha256=aFjdLDoqnhgzxPIoRfs4y_Z_F6T88g5Sg8R5m0HMxdU,868
+projectdavid/synthesis/reranker.py,sha256=F9HaXbB2RW66MdDqXdhrx4UP_vRG8xDG2S4eFSCQ5GM,879
 projectdavid/synthesis/retriever.py,sha256=8R5HIgPXMKIQxV5KsN8u_gVVP4JY-wsDwJd92A-74-o,2300
 projectdavid/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+projectdavid/utils/function_call_suppressor.py,sha256=LsDhySVH0kS8nydPBrHrOtT30yhVvwU24QHApGu1P34,1305
 projectdavid/utils/monitor_launcher.py,sha256=3YAgJdeuaUvq3JGvpA4ymqFsAnk29nH5q93cwStP4hc,2836
 projectdavid/utils/run_monitor.py,sha256=F_WkqIP-qnWH-4llIbileWWLfRj2Q1Cg-ni23SR1rec,3786
 projectdavid/utils/vector_search_formatter.py,sha256=YTe3HPGec26qGY7uxY8_GS8lc4QaN6aNXMzkl29nZpI,1735
-projectdavid-1.31.0.dist-info/licenses/LICENSE,sha256=_8yjiEGttpS284BkfhXxfERqTRZW_tUaHiBB0GTJTMg,4563
-projectdavid-1.31.0.dist-info/METADATA,sha256=we616BQkChiuQYO_-UfQ1VL-7j-IfDfPI7OtheEMsUM,10809
-projectdavid-1.31.0.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-projectdavid-1.31.0.dist-info/top_level.txt,sha256=kil8GU4s7qYRfNnzGnFHhZnSNRSxgNG-J4HLgQMmMtw,13
-projectdavid-1.31.0.dist-info/RECORD,,
+projectdavid-1.38.1.dist-info/licenses/LICENSE,sha256=_8yjiEGttpS284BkfhXxfERqTRZW_tUaHiBB0GTJTMg,4563
+projectdavid-1.38.1.dist-info/METADATA,sha256=Ck2oQkKlAHKFfw7DR-5ENmsTFnPDVF8MhWjj72yHh1I,10768
+projectdavid-1.38.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+projectdavid-1.38.1.dist-info/top_level.txt,sha256=kil8GU4s7qYRfNnzGnFHhZnSNRSxgNG-J4HLgQMmMtw,13
+projectdavid-1.38.1.dist-info/RECORD,,

{projectdavid-1.31.0.dist-info → projectdavid-1.38.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any