docent-python 0.1.0a1__py3-none-any.whl

docent/sdk/client.py

@@ -0,0 +1,285 @@
+import os
+from typing import Any
+
+import requests
+
+from docent._log_util.logger import get_logger
+from docent.data_models.agent_run import AgentRun
+from docent.data_models.filters import FrameFilter
+
+logger = get_logger(__name__)
+
+
+class Docent:
+    """Client for interacting with the Docent API.
+
+    This client provides methods for creating and managing FrameGrids,
+    dimensions, agent runs, and filters in the Docent system.
+
+    Args:
+        server_url: URL of the Docent API server.
+        web_url: URL of the Docent web UI.
+        email: Email address for authentication.
+        password: Password for authentication.
+    """
+
+    def __init__(
+        self, server_url: str, web_url: str, email: str | None = None, password: str | None = None
+    ):
+        self._server_url = server_url.rstrip("/") + "/rest"
+        self._web_url = web_url.rstrip("/")
+
+        self._email = email or os.getenv("DOCENT_EMAIL")
+        if self._email is None:
+            raise ValueError(
+                "Email address must be provided through keyword argument or DOCENT_EMAIL environment variable"
+            )
+
+        self._password = password or os.getenv("DOCENT_PASSWORD")
+        if self._password is None:
+            raise ValueError(
+                "Password must be provided through keyword argument or DOCENT_PASSWORD environment variable"
+            )
+
+        # Use requests.Session for connection pooling and persistent headers
+        self._session = requests.Session()
+        self._login()
+
+    def _login(self):
+        """Login with email/password to establish session."""
+        login_url = f"{self._server_url}/login"
+        response = self._session.post(
+            login_url, json={"email": self._email, "password": self._password}
+        )
+        response.raise_for_status()
+        logger.info(f"Successfully logged in as {self._email}")
+
+    def create_framegrid(
+        self,
+        fg_id: str | None = None,
+        name: str | None = None,
+        description: str | None = None,
+    ) -> str:
+        """Creates a new FrameGrid.
+
+        Creates a new FrameGrid and sets up a default MECE dimension
+        for grouping on the homepage.
+
+        Args:
+            fg_id: Optional ID for the new FrameGrid. If not provided, one will be generated.
+            name: Optional name for the FrameGrid.
+            description: Optional description for the FrameGrid.
+
+        Returns:
+            str: The ID of the created FrameGrid.
+
+        Raises:
+            ValueError: If the response is missing the FrameGrid ID.
+            requests.exceptions.HTTPError: If the API request fails.
+        """
+        url = f"{self._server_url}/create"
+        payload = {
+            "fg_id": fg_id,
+            "name": name,
+            "description": description,
+        }
+
+        response = self._session.post(url, json=payload)
+        response.raise_for_status()
+
+        response_data = response.json()
+        fg_id = response_data.get("fg_id")
+        if fg_id is None:
+            raise ValueError("Failed to create frame grid: 'fg_id' missing in response.")
+
+        logger.info(f"Successfully created FrameGrid with id='{fg_id}'")
+
+        logger.info(f"FrameGrid creation complete. Frontend available at: {self._web_url}/{fg_id}")
+        return fg_id
+
+    def set_io_bin_keys(self, fg_id: str, inner_bin_key: str | None, outer_bin_key: str | None):
+        """Set inner and outer bin keys for a frame grid."""
+        response = self._session.post(
+            f"{self._server_url}/{fg_id}/set_io_bin_keys",
+            json={"inner_bin_key": inner_bin_key, "outer_bin_key": outer_bin_key},
+        )
+        response.raise_for_status()
+
+    def set_inner_bin_key(self, fg_id: str, dim: str):
+        """Set the inner bin key for a frame grid."""
+        current_io_bin_keys = self.get_io_bin_keys(fg_id)
+        if current_io_bin_keys is None:
+            current_io_bin_keys = (None, None)
+        self.set_io_bin_keys(fg_id, dim, current_io_bin_keys[1])  # Set inner, keep outer
+
+    def set_outer_bin_key(self, fg_id: str, dim: str):
+        """Set the outer bin key for a frame grid."""
+        current_io_bin_keys = self.get_io_bin_keys(fg_id)
+        if current_io_bin_keys is None:
+            current_io_bin_keys = (None, None)
+        self.set_io_bin_keys(fg_id, current_io_bin_keys[0], dim)  # Keep inner, set outer
+
+    def get_io_bin_keys(self, fg_id: str) -> tuple[str | None, str | None] | None:
+        """Gets the current inner and outer bin keys for a FrameGrid.
+
+        Args:
+            fg_id: ID of the FrameGrid.
+
+        Returns:
+            tuple: (inner_bin_key | None, outer_bin_key | None)
+
+        Raises:
+            requests.exceptions.HTTPError: If the API request fails.
+        """
+        url = f"{self._server_url}/{fg_id}/io_bin_keys"
+        response = self._session.get(url)
+        response.raise_for_status()
+        data = response.json()
+        return (data.get("inner_bin_key"), data.get("outer_bin_key"))
+
+    def add_agent_runs(self, fg_id: str, agent_runs: list[AgentRun]) -> dict[str, Any]:
+        """Adds agent runs to a FrameGrid.
+
+        Agent runs represent execution traces that can be visualized and analyzed.
+        This method batches the insertion in groups of 5,000 for better performance.
+
+        Args:
+            fg_id: ID of the FrameGrid.
+            agent_runs: List of AgentRun objects to add.
+
+        Returns:
+            dict: API response data.
+
+        Raises:
+            requests.exceptions.HTTPError: If the API request fails.
+        """
+        from tqdm import tqdm
+
+        url = f"{self._server_url}/{fg_id}/agent_runs"
+        batch_size = 1000
+        total_runs = len(agent_runs)
+
+        # Process agent runs in batches
+        with tqdm(total=total_runs, desc="Adding agent runs", unit="runs") as pbar:
+            for i in range(0, total_runs, batch_size):
+                batch = agent_runs[i : i + batch_size]
+                payload = {"agent_runs": [ar.model_dump(mode="json") for ar in batch]}
+
+                response = self._session.post(url, json=payload)
+                response.raise_for_status()
+
+                pbar.update(len(batch))
+
+        url = f"{self._server_url}/{fg_id}/compute_embeddings"
+        response = self._session.post(url)
+        response.raise_for_status()
+
+        logger.info(f"Successfully added {total_runs} agent runs to FrameGrid '{fg_id}'")
+        return {"status": "success", "total_runs_added": total_runs}
+
+    def get_base_filter(self, fg_id: str) -> dict[str, Any] | None:
+        """Retrieves the base filter for a FrameGrid.
+
+        The base filter defines default filtering applied to all views.
+
+        Args:
+            fg_id: ID of the FrameGrid.
+
+        Returns:
+            dict or None: Filter data if a filter exists, None otherwise.
+
+        Raises:
+            requests.exceptions.HTTPError: If the API request fails.
+        """
+        url = f"{self._server_url}/{fg_id}/base_filter"
+        response = self._session.get(url)
+        response.raise_for_status()
+        # The endpoint returns the filter model directly or null
+        filter_data = response.json()
+        return filter_data
+
+    def set_base_filter(self, fg_id: str, filter: FrameFilter | None) -> dict[str, Any]:
+        """Sets the base filter for a FrameGrid.
+
+        The base filter defines default filtering applied to all views.
+
+        Args:
+            fg_id: ID of the FrameGrid.
+            filter: FrameFilter object defining the filter, or None to clear the filter.
+
+        Returns:
+            dict: API response data.
+
+        Raises:
+            requests.exceptions.HTTPError: If the API request fails.
+        """
+        url = f"{self._server_url}/{fg_id}/base_filter"
+        payload = {
+            "filter": filter.model_dump() if filter else None,
+        }
+
+        response = self._session.post(url, json=payload)
+        response.raise_for_status()
+
+        logger.info(f"Successfully set base filter for FrameGrid '{fg_id}'")
+        return response.json()
+
+    def list_framegrids(self) -> list[dict[str, Any]]:
+        """Lists all available FrameGrids.
+
+        Returns:
+            list: List of dictionaries containing FrameGrid information.
+
+        Raises:
+            requests.exceptions.HTTPError: If the API request fails.
+        """
+        url = f"{self._server_url}/framegrids"
+        response = self._session.get(url)
+        response.raise_for_status()
+        return response.json()
+
+    def get_dimensions(self, fg_id: str, dim_ids: list[str] | None = None) -> list[dict[str, Any]]:
+        """Retrieves dimensions for a FrameGrid.
+
+        Args:
+            fg_id: ID of the FrameGrid.
+            dim_ids: Optional list of dimension IDs to retrieve. If None, retrieves all dimensions.
+
+        Returns:
+            list: List of dictionaries containing dimension information.
+
+        Raises:
+            requests.exceptions.HTTPError: If the API request fails.
+        """
+        url = f"{self._server_url}/{fg_id}/get_dimensions"
+        payload = {
+            "dim_ids": dim_ids,
+        }
+        response = self._session.post(url, json=payload)
+        response.raise_for_status()
+        return response.json()
+
+    def list_attribute_searches(
+        self, fg_id: str, base_data_only: bool = True
+    ) -> list[dict[str, Any]]:
+        """Lists available attribute searches for a FrameGrid.
+
+        Attribute searches allow finding frames with specific metadata attributes.
+
+        Args:
+            fg_id: ID of the FrameGrid.
+            base_data_only: If True, returns only basic search information.
+
+        Returns:
+            list: List of dictionaries containing attribute search information.
+
+        Raises:
+            requests.exceptions.HTTPError: If the API request fails.
+        """
+        url = f"{self._server_url}/{fg_id}/attribute_searches"
+        params = {
+            "base_data_only": base_data_only,
+        }
+        response = self._session.get(url, params=params)
+        response.raise_for_status()
+        return response.json()

docent_python-0.1.0a1.dist-info/METADATA

@@ -0,0 +1,16 @@
+Metadata-Version: 2.4
+Name: docent-python
+Version: 0.1.0a1
+Summary: Docent SDK
+Project-URL: Homepage, https://github.com/TransluceAI/docent
+Project-URL: Issues, https://github.com/TransluceAI/docent/issues
+Project-URL: Docs, https://transluce-docent.readthedocs-hosted.com/en/latest
+Author-email: Transluce AI <info@transluce.org>
+License-Expression: MIT
+License-File: LICENSE.md
+Requires-Python: >=3.11
+Requires-Dist: logging>=0.4.9.6
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: sqlalchemy>=2.0.41
+Requires-Dist: tiktoken>=0.7.0

docent_python-0.1.0a1.dist-info/RECORD

@@ -0,0 +1,23 @@
+docent/__init__.py,sha256=J2BbO6rzilfw9WXRUeolr439EGFezqbMU_kCpCCryRA,59
+docent/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+docent/_log_util/__init__.py,sha256=3HXXrxrSm8PxwG4llotrCnSnp7GuroK1FNHsdg6f7aE,73
+docent/_log_util/logger.py,sha256=kwM0yRW1IJd6-XTorjWn48B4l8qvD2ZM6VDjY5eskQI,4422
+docent/data_models/__init__.py,sha256=M84x4yoPZz97-e-2KQ4qXud8i6Ykdjl1ChbwZalu2NQ,689
+docent/data_models/_tiktoken_util.py,sha256=hC0EDDWItv5-0cONBnHWgZtQOflDU7ZNEhXPFo4DvPc,3057
+docent/data_models/agent_run.py,sha256=sdvoUUpOhQAHqJHNR5KoHthCXrpJajdIREMacoR1ODk,9516
+docent/data_models/citation.py,sha256=WsVQZcBT2EJD24ysyeVOC5Xfo165RI7P5_cOnJBgHj0,10015
+docent/data_models/filters.py,sha256=nZquRQji_xZwea6nBxM_SRECaYECDMEQ8Zt1TXl-_jI,7484
+docent/data_models/metadata.py,sha256=yBEm5M_gSNuoG---Fezsjm0YDGUQoJeM_BL9rwbBt-U,8035
+docent/data_models/regex.py,sha256=0ciIerkrNwb91bY5mTcyO5nDWH67xx2tZYObV52fmBo,1684
+docent/data_models/shared_types.py,sha256=jjm-Dh5S6v7UKInW7SEqoziOsx6Z7Uu4e3VzgCbTWvc,225
+docent/data_models/transcript.py,sha256=HK1NvtD06XqVto6O5qzQ_wCmxlx0O88wSBB2NRTPs44,13667
+docent/data_models/chat/__init__.py,sha256=O04XQ2NmO8GTWqkkB_Iydj8j_CucZuLhoyMVTxJN_cs,570
+docent/data_models/chat/content.py,sha256=Co-jO8frQa_DSP11wJuhPX0s-GpJk8yqtKqPeiAIZ_U,1672
+docent/data_models/chat/message.py,sha256=iAo38kbV6wYbFh8S23cxLy6HY4C_i3PzQ6RpSQG5dxM,3861
+docent/data_models/chat/tool.py,sha256=x7NKINswPe0Kqvcx4ubjHzB-n0-i4DbFodvaBb2vitk,3042
+docent/sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+docent/sdk/client.py,sha256=XoeO8d7vCghf0WZoc22lJdPRBt6i88S2QV-viQubuEA,10090
+docent_python-0.1.0a1.dist-info/METADATA,sha256=NewmZvefKjD0vLDEHpc_VRf4v-asf_jf9DEEsVG2xmw,562
+docent_python-0.1.0a1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+docent_python-0.1.0a1.dist-info/licenses/LICENSE.md,sha256=-TCY5GNyVAczrb96jTgTPalccQeyZqVXgs0N_dhC1OI,1086
+docent_python-0.1.0a1.dist-info/RECORD,,

docent_python-0.1.0a1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

docent_python-0.1.0a1.dist-info/licenses/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2025 Clarity AI Research, Inc. dba Transluce
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.