deeprails 0.1.0__py3-none-any.whl

deeprails/client.py

@@ -0,0 +1,31 @@
+import requests
+from typing import Dict, Any
+
+from .evaluate import EvaluateClient
+from .monitor import MonitorClient
+
+class DeepRails:
+    """
+    Main entry point for the deeprails client.
+    
+    Usage:
+        from deeprails import DeepRails
+        
+        client = DeepRails(token="YOUR_TOKEN")
+        resp = client.evaluate.create({...})
+    """
+    def __init__(self, token: str, base_url: str = "https://deeprails.ai"):
+        """
+        :param token: Bearer token for authentication.
+        :param base_url: Base URL for the DeepRails API.
+        """
+        self.token = token
+        self.base_url = base_url.rstrip("/")
+        # Common headers for all requests
+        self.headers = {
+            "Content-Type": "application/json",
+            "Authorization": f"Bearer {self.token}"
+        }
+        # Create client objects
+        self.evaluate = EvaluateClient(self.base_url, self.headers)
+        self.monitor = MonitorClient(self.base_url, self.headers)

deeprails/evaluate.py

@@ -0,0 +1,46 @@
+import requests
+from typing import Dict, Any
+
+class EvaluateClient:
+    """
+    Client for the Evaluate endpoints:
+      - POST / (create a new evaluation)
+      - GET /{eval_id} (fetch an existing evaluation)
+    """
+    def __init__(self, base_url: str, headers: Dict[str, str]):
+        self.base_url = f"{base_url}/evaluate"
+        self.headers = headers
+
+    def create(self, evaluation_data: Dict[str, Any]) -> Dict[str, Any]:
+        """
+        Create a new evaluation by POSTing to /evaluate.
+        
+        :param evaluation_data: Dict matching the EvaluateCreate model:
+            {
+              "model_input": {...},
+              "model_output": "...",
+              "type": "...",
+              "guardrails_metrics": [...],
+              "score_format": "...",
+              "webhook": "..."
+            }
+        :return: The JSON response from the API as a Python dict
+                 matching EvaluationResponse.
+        """
+        url = self.base_url  # e.g. https://deeprails.ai/evaluate
+        response = requests.post(url, json=evaluation_data, headers=self.headers)
+        response.raise_for_status()
+        return response.json()
+
+    def fetch(self, eval_id: str) -> Dict[str, Any]:
+        """
+        Fetch an existing evaluation by GETting /evaluate/{eval_id}.
+        
+        :param eval_id: The ID of the evaluation to retrieve
+        :return: The JSON response as a Python dict
+                 matching EvaluationResponse.
+        """
+        url = f"{self.base_url}/{eval_id}"
+        response = requests.get(url, headers=self.headers)
+        response.raise_for_status()
+        return response.json()

deeprails/monitor.py

@@ -0,0 +1,50 @@
+import requests
+from typing import Dict, Any
+
+class MonitorClient:
+    """
+    Client for the Monitor endpoints:
+      - POST / (create a new monitor)
+      - POST /{monitor_id}/event (log an event)
+    """
+    def __init__(self, base_url: str, headers: Dict[str, str]):
+        self.base_url = f"{base_url}/monitor"
+        self.headers = headers
+
+    def create(self, monitor_data: Dict[str, Any]) -> Dict[str, Any]:
+        """
+        Create a new monitor.
+        
+        :param monitor_data: Dict matching the MonitorCreate model:
+            {
+              "name": "...",
+              "description": "...",
+              "metrics": [...]
+            }
+        :return: Dictionary with e.g. {"monitor_id": "..."} from the API.
+        """
+        url = self.base_url  # e.g. https://deeprails.ai/monitor
+        response = requests.post(url, json=monitor_data, headers=self.headers)
+        response.raise_for_status()
+        return response.json()
+
+    def log(self, monitor_id: str, event_data: Dict[str, Any]) -> Dict[str, Any]:
+        """
+        Log an event under a specific monitor.
+        
+        :param monitor_id: ID of the monitor to which we log the event
+        :param event_data: Dict matching MonitorEventCreate:
+            {
+              "model_input": {...},
+              "model_output": {...},
+              "temperature": 0.7,
+              "top_p": 1.0,
+              "model": "gpt-3.5-turbo",
+              ...
+            }
+        :return: Dictionary with e.g. {"event_id": "..."} from the API.
+        """
+        url = f"{self.base_url}/{monitor_id}/event"
+        response = requests.post(url, json=event_data, headers=self.headers)
+        response.raise_for_status()
+        return response.json()

deeprails-0.1.0.dist-info/LICENSE

@@ -0,0 +1,11 @@
+MIT License
+
+Copyright (c) [2025] [DeepRails Inc.ß]
+
+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.

deeprails-0.1.0.dist-info/METADATA

@@ -0,0 +1,86 @@
+Metadata-Version: 2.1
+Name: deeprails
+Version: 0.1.0
+Summary: Python client library for deeprails.ai
+Home-page: https://github.com/yourusername/deeprails
+Author: Your Name or Organization
+Author-email: your.email@example.com
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests (>=2.0.0)
+
+# DeepRails
+
+A Python client library for interacting with the [DeepRails.ai](https://deeprails.ai) API. This package exposes high-level methods for creating and fetching evaluations, as well as creating monitors and logging monitor events.
+
+## Features
+
+- **Evaluation**:  
+  - `client.evaluate.create(data)` – Create an evaluation
+  - `client.evaluate.fetch(eval_id)` – Retrieve the status and results of an evaluation
+
+- **Monitor**:  
+  - `client.monitor.create(data)` – Create a monitor
+  - `client.monitor.log(monitor_id, data)` – Log an event under a monitor
+
+## Installation
+
+Install via [PyPI](https://pypi.org/) using:
+
+```bash
+pip install deeprails
+```
+
+## Quick Start
+```python
+from deeprails import DeepRails
+
+# Initialize the client (replace "YOUR_TOKEN" with a valid token)
+client = DeepRails(token="YOUR_TOKEN")
+
+# 1) Create an evaluation
+eval_request_data = {
+    "model_input": {"user_prompt": "Write a poem about winter"},
+    "model_output": "A frosty greeting on a snowy morn...",
+    "type": "text",
+    "guardrails_metrics": ["correctness", "completeness"],
+    "score_format": "continuous",
+    "webhook": None
+}
+eval_response = client.evaluate.create(eval_request_data)
+print("Evaluation created:", eval_response)
+
+# 2) Fetch the evaluation by ID
+evaluation = client.evaluate.fetch(eval_response["eval_id"])
+print("Fetched evaluation:", evaluation)
+
+# 3) Create a new monitor
+monitor_data = {
+    "name": "My Example Monitor",
+    "description": "Track LLM usage in production",
+    "metrics": ["correctness", "completeness"]
+}
+monitor_resp = client.monitor.create(monitor_data)
+monitor_id = monitor_resp["monitor_id"]
+print("Monitor created:", monitor_resp)
+
+# 4) Log an event under that monitor
+event_data = {
+    "model_input": {"user_prompt": "Tell me a joke"},
+    "model_output": {"response": "Why did the chicken cross the road..."},
+    "temperature": 0.7,
+    "top_p": 1.0,
+    "model": "gpt-3.5-turbo"
+}
+event_resp = client.monitor.log(monitor_id, event_data)
+print("Monitor event logged:", event_resp)
+```
+
+
+

deeprails-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+deeprails/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+deeprails/client.py,sha256=28vSTSp2tWzFLJq4racWW4lXMXOyF3W9hEvROhZd5VU,983
+deeprails/evaluate.py,sha256=HJ3QtGiCho169r8dx1LXV6U7xjbreTr1X2BjDEfFwuw,1647
+deeprails/monitor.py,sha256=XYtl5TdNqRHtrUetSYHxAOJNisFE_uLmbFSa__q08kA,1743
+deeprails-0.1.0.dist-info/LICENSE,sha256=GsV7lN6fihCcDgkJbfs0rq1q9d6IyB0TFQ8HLKUpSXM,1077
+deeprails-0.1.0.dist-info/METADATA,sha256=kmaiXXtnBuZQhT_tV0vKJH1P3Z3RVU3Npk-dRkg4cj8,2578
+deeprails-0.1.0.dist-info/WHEEL,sha256=ewwEueio1C2XeHTvT17n8dZUJgOvyCWCt0WVNLClP9o,92
+deeprails-0.1.0.dist-info/top_level.txt,sha256=8-3gictPOXqg2k5S_yW66DdO8EqZ-YFab0LNarWUv4Q,10
+deeprails-0.1.0.dist-info/RECORD,,

deeprails-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.37.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

deeprails-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+deeprails