deeprails 0.2.0__tar.gz

deeprails-0.2.0/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.2.0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: deeprails
+Version: 0.2.0
+Summary: Python SDK for interacting with the DeepRails API
+Project-URL: Homepage, https://deeprails.com
+Project-URL: Documentation, https://docs.deeprails.com
+Author-email: Neil Mate <support@deeprails.ai>
+License: 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.
+License-File: LICENSE
+Keywords: ai,deeprails,evaluation,genai,guardrails,sdk
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Requires-Dist: httpx<0.29.0,>=0.28.1
+Requires-Dist: pydantic<3.0.0,>=2.11.7
+Description-Content-Type: text/markdown
+
+# DeepRails Python SDK
+
+A lightweight, intuitive Python SDK for interacting with the DeepRails API. DeepRails helps you evaluate and improve AI-generated outputs through a comprehensive set of guardrail metrics.
+
+## Installation
+
+```bash
+pip install deeprails
+```
+
+## Quick Start
+
+```python
+from deeprails import DeepRails
+
+# Initialize with your API token
+client = DeepRails(token="YOUR_API_KEY")
+
+# Create an evaluation
+evaluation = client.create_evaluation(
+    model_input={"user_prompt": "Prompt used to generate completion"},
+    model_output="Generated output",
+    model_used="gpt-4o-mini (LLM used to generate completion)",
+    guardrail_metrics=["correctness", "completeness"]
+)
+
+# Print evaluation ID
+print(f"Evaluation created with ID: {evaluation.eval_id}")
+```
+
+## Features
+
+- **Simple API**: Just a few lines of code to integrate evaluation into your workflow
+- **Comprehensive Metrics**: Evaluate outputs on correctness, completeness, and more
+- **Real-time Progress**: Track evaluation progress in real-time
+- **Detailed Results**: Get detailed scores and rationales for each metric
+
+## Authentication
+
+All API requests require authentication using your DeepRails API key. Your API key is a sensitive credential that should be kept secure.
+
+```python
+# Best practice: Load token from environment variable
+import os
+token = os.environ.get("DEEPRAILS_API_KEY")
+client = DeepRails(token=token)
+```
+
+## Creating Evaluations
+
+```python
+try:
+    evaluation = client.create_evaluation(
+        model_input={"user_prompt": "Prompt used to generate completion"},
+        model_output="Generated output",
+        model_used="gpt-4o-mini (LLM used to generate completion)",
+        guardrail_metrics=["correctness", "completeness"]
+    )
+    print(f"ID: {evaluation.eval_id}")
+    print(f"Status: {evaluation.evaluation_status}")
+    print(f"Progress: {evaluation.progress}%")
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+### Parameters
+
+- `model_input`: Dictionary containing the prompt and any context (must include `user_prompt`)
+- `model_output`: The generated output to evaluate
+- `model_used`: (Optional) The model that generated the output
+- `run_mode`: (Optional) Evaluation run mode - defaults to "smart"
+- `guardrail_metrics`: (Optional) List of metrics to evaluate
+- `nametag`: (Optional) Custom identifier for this evaluation
+- `webhook`: (Optional) URL to receive completion notifications
+
+## Retrieving Evaluations
+
+```python
+try:
+    eval_id = "eval-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+    evaluation = client.get_evaluation(eval_id)
+    
+    print(f"Status: {evaluation.evaluation_status}")
+    
+    if evaluation.evaluation_result:
+        print("\nResults:")
+        for metric, result in evaluation.evaluation_result.items():
+            score = result.get('score', 'N/A')
+            print(f"  {metric}: {score}")
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+## Available Metrics
+
+- `correctness`: Evaluates factual accuracy of the output
+- `completeness`: Checks if the output addresses all aspects of the prompt
+- `harmfulness`: Detects potentially harmful content
+- `bias`: Identifies biased language or reasoning
+- And more...
+
+## Error Handling
+
+The SDK throws `DeepRailsAPIError` for API-related errors, with status code and detailed message.
+
+```python
+from deeprails import DeepRailsAPIError
+
+try:
+    # SDK operations
+except DeepRailsAPIError as e:
+    print(f"API Error: {e.status_code} - {e.error_detail}")
+except Exception as e:
+    print(f"Unexpected error: {e}")
+```
+
+## Support
+
+For questions or support, please contact support@deeprails.ai.

deeprails-0.2.0/README.md

@@ -0,0 +1,119 @@
+# DeepRails Python SDK
+
+A lightweight, intuitive Python SDK for interacting with the DeepRails API. DeepRails helps you evaluate and improve AI-generated outputs through a comprehensive set of guardrail metrics.
+
+## Installation
+
+```bash
+pip install deeprails
+```
+
+## Quick Start
+
+```python
+from deeprails import DeepRails
+
+# Initialize with your API token
+client = DeepRails(token="YOUR_API_KEY")
+
+# Create an evaluation
+evaluation = client.create_evaluation(
+    model_input={"user_prompt": "Prompt used to generate completion"},
+    model_output="Generated output",
+    model_used="gpt-4o-mini (LLM used to generate completion)",
+    guardrail_metrics=["correctness", "completeness"]
+)
+
+# Print evaluation ID
+print(f"Evaluation created with ID: {evaluation.eval_id}")
+```
+
+## Features
+
+- **Simple API**: Just a few lines of code to integrate evaluation into your workflow
+- **Comprehensive Metrics**: Evaluate outputs on correctness, completeness, and more
+- **Real-time Progress**: Track evaluation progress in real-time
+- **Detailed Results**: Get detailed scores and rationales for each metric
+
+## Authentication
+
+All API requests require authentication using your DeepRails API key. Your API key is a sensitive credential that should be kept secure.
+
+```python
+# Best practice: Load token from environment variable
+import os
+token = os.environ.get("DEEPRAILS_API_KEY")
+client = DeepRails(token=token)
+```
+
+## Creating Evaluations
+
+```python
+try:
+    evaluation = client.create_evaluation(
+        model_input={"user_prompt": "Prompt used to generate completion"},
+        model_output="Generated output",
+        model_used="gpt-4o-mini (LLM used to generate completion)",
+        guardrail_metrics=["correctness", "completeness"]
+    )
+    print(f"ID: {evaluation.eval_id}")
+    print(f"Status: {evaluation.evaluation_status}")
+    print(f"Progress: {evaluation.progress}%")
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+### Parameters
+
+- `model_input`: Dictionary containing the prompt and any context (must include `user_prompt`)
+- `model_output`: The generated output to evaluate
+- `model_used`: (Optional) The model that generated the output
+- `run_mode`: (Optional) Evaluation run mode - defaults to "smart"
+- `guardrail_metrics`: (Optional) List of metrics to evaluate
+- `nametag`: (Optional) Custom identifier for this evaluation
+- `webhook`: (Optional) URL to receive completion notifications
+
+## Retrieving Evaluations
+
+```python
+try:
+    eval_id = "eval-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+    evaluation = client.get_evaluation(eval_id)
+    
+    print(f"Status: {evaluation.evaluation_status}")
+    
+    if evaluation.evaluation_result:
+        print("\nResults:")
+        for metric, result in evaluation.evaluation_result.items():
+            score = result.get('score', 'N/A')
+            print(f"  {metric}: {score}")
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+## Available Metrics
+
+- `correctness`: Evaluates factual accuracy of the output
+- `completeness`: Checks if the output addresses all aspects of the prompt
+- `harmfulness`: Detects potentially harmful content
+- `bias`: Identifies biased language or reasoning
+- And more...
+
+## Error Handling
+
+The SDK throws `DeepRailsAPIError` for API-related errors, with status code and detailed message.
+
+```python
+from deeprails import DeepRailsAPIError
+
+try:
+    # SDK operations
+except DeepRailsAPIError as e:
+    print(f"API Error: {e.status_code} - {e.error_detail}")
+except Exception as e:
+    print(f"Unexpected error: {e}")
+```
+
+## Support
+
+For questions or support, please contact support@deeprails.ai.

deeprails-0.2.0/deeprails/__init__.py

@@ -0,0 +1 @@
+from .client import DeepRails

deeprails-0.2.0/deeprails/client.py

@@ -0,0 +1,101 @@
+import httpx
+from typing import List, Optional, Dict, Any
+
+from .schemas import EvaluationResponse
+from .exceptions import DeepRailsAPIError
+
+class DeepRails:
+    """
+    Python SDK client for the DeepRails API.
+    """
+    def __init__(self, token: str, base_url: str = "https://api.deeprails.com"):
+        """
+        Initializes the DeepRails client.
+
+        Args:
+            token: Your DeepRails API key (starts with 'sk_').
+            base_url: The base URL of the DeepRails API.
+        """
+        if not token:
+            raise ValueError("A valid DeepRails API token is required.")
+        
+        self._base_url = base_url
+        self._headers = {
+            "Authorization": f"Bearer {token}",
+            "Content-Type": "application/json",
+            "User-Agent": "deeprails-python-sdk/0.2.0"
+        }
+        self._client = httpx.Client(base_url=self._base_url, headers=self._headers, timeout=30.0)
+
+    def _request(self, method: str, endpoint: str, **kwargs) -> httpx.Response:
+        """Helper method to make requests and handle API errors."""
+        try:
+            response = self._client.request(method, endpoint, **kwargs)
+            response.raise_for_status()
+            return response
+        except httpx.HTTPStatusError as e:
+            error_detail = "No detail provided."
+            try:
+                error_detail = e.response.json().get("detail", error_detail)
+            except Exception:
+                error_detail = e.response.text
+            raise DeepRailsAPIError(status_code=e.response.status_code, error_detail=error_detail) from e
+        except httpx.RequestError as e:
+            raise DeepRailsAPIError(status_code=500, error_detail=f"Request failed: {e}") from e
+
+    def create_evaluation(
+        self,
+        *,
+        model_input: Dict[str, Any],
+        model_output: str,
+        model_used: Optional[str] = None,
+        run_mode: Optional[str] = "smart",  # Set default to "smart"
+        guardrail_metrics: Optional[List[str]] = None,
+        nametag: Optional[str] = None,
+        webhook: Optional[str] = None
+    ) -> EvaluationResponse:
+        """
+        Creates a new evaluation and immediately processes it.
+
+        Args:
+            model_input: A dictionary containing the inputs for the model.
+                         Must contain a "user_prompt" key.
+            model_output: The response generated by the model you are evaluating.
+            model_used: The name or identifier of the model being evaluated.
+            run_mode: The evaluation mode (e.g., "smart", "dev").
+            guardrail_metrics: A list of metrics to evaluate.
+            nametag: A user-defined name or tag for the evaluation.
+            webhook: A URL to send a POST request to upon evaluation completion.
+
+        Returns:
+            An EvaluationResponse object with the details of the created evaluation.
+        """
+        if "user_prompt" not in model_input:
+            raise ValueError("`model_input` must contain a 'user_prompt' key.")
+
+        payload = {
+            "model_input": model_input,
+            "model_output": model_output,
+            "model_used": model_used,
+            "run_mode": run_mode,
+            "guardrail_metrics": guardrail_metrics,
+            "nametag": nametag,
+            "webhook": webhook,
+        }
+        json_payload = {k: v for k, v in payload.items() if v is not None}
+
+        response = self._request("POST", "/evaluate", json=json_payload)
+        return EvaluationResponse.parse_obj(response.json())
+
+    def get_evaluation(self, eval_id: str) -> EvaluationResponse:
+        """
+        Retrieves the status and results of a specific evaluation.
+
+        Args:
+            eval_id: The unique identifier of the evaluation.
+
+        Returns:
+            An EvaluationResponse object with the full, up-to-date details of the evaluation.
+        """
+        response = self._request("GET", f"/evaluate/{eval_id}")
+        return EvaluationResponse.parse_obj(response.json())

deeprails-0.2.0/deeprails/exceptions.py

@@ -0,0 +1,10 @@
+class DeepRailsError(Exception):
+    """Base exception class for the DeepRails SDK."""
+    pass
+
+class DeepRailsAPIError(DeepRailsError):
+    """Raised when the DeepRails API returns an error."""
+    def __init__(self, status_code: int, error_detail: str):
+        self.status_code = status_code
+        self.error_detail = error_detail
+        super().__init__(f"API Error {status_code}: {error_detail}")

deeprails-0.2.0/deeprails/schemas.py

@@ -0,0 +1,30 @@
+from typing import List, Optional, Dict, Any
+from pydantic import BaseModel, Field
+from datetime import datetime
+
+
+class EvaluationResponse(BaseModel):
+    """Represents the response for an evaluation from the DeepRails API."""
+    eval_id: str
+    evaluation_status: str
+    guardrail_metrics: Optional[List[str]] = None
+    model_used: Optional[str] = None
+    run_mode: Optional[str] = None
+    model_input: Optional[Dict[str, Any]] = None
+    model_output: Optional[str] = None
+    estimated_cost: Optional[float] = None
+    input_tokens: Optional[int] = None
+    output_tokens: Optional[int] = None
+    nametag: Optional[str] = None
+    progress: Optional[int] = Field(None, ge=0, le=100)
+    start_timestamp: Optional[datetime] = None
+    completion_timestamp: Optional[datetime] = None
+    error_message: Optional[str] = None
+    error_timestamp: Optional[datetime] = None
+    evaluation_result: Optional[Dict[str, Any]] = None
+    evaluation_total_cost: Optional[float] = None
+    created_at: Optional[datetime] = None
+    modified_at: Optional[datetime] = None
+
+    class Config:
+        extra = 'ignore'

deeprails-0.2.0/pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "deeprails"
+version = "0.2.0"
+description = "Python SDK for interacting with the DeepRails API"
+readme = {file = "README.md", content-type = "text/markdown"}
+authors = [{name = "Neil Mate", email = "support@deeprails.ai"}]
+license = {file = "LICENSE"}
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+keywords = ["ai", "evaluation", "guardrails", "sdk", "genai", "deeprails"]
+dependencies = [
+    "httpx>=0.28.1,<0.29.0",
+    "pydantic>=2.11.7,<3.0.0",
+]
+requires-python = ">=3.8"
+
+[project.urls]
+"Homepage" = "https://deeprails.com"
+"Documentation" = "https://docs.deeprails.com"
+
+[tool.hatch.build.targets.wheel]
+packages = ["deeprails"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "deeprails",
+    "LICENSE",
+    "README.md",
+]