deeprails 0.3.2__py3-none-any.whl → 1.0.0__py3-none-any.whl

deeprails-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Deeprails
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

deeprails/client.py

@@ -1,285 +0,0 @@
-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.3.2"
-        }
-        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())
-
-
-    def create_monitor(
-        self,
-        *,
-        name: str,
-        description: Optional[str] = None
-    ) -> MonitorResponse:
-        """
-        Creates a new monitor for tracking AI responses.
-
-        Args:
-            name: A name for the monitor.
-            description: Optional description of the monitor's purpose.
-
-        Returns:
-            A MonitorResponse object with the details of the created monitor.
-        """
-        payload = {
-            "name": name,
-            "description": description
-        }
-        
-        # Remove None values
-        json_payload = {k: v for k, v in payload.items() if v is not None}
-
-        response = self._request("POST", "/monitor", json=json_payload)
-        response_json = response.json()
-        
-        # Handle DeepRails API response structure
-        if "data" in response_json:
-            return MonitorResponse.parse_obj(response_json["data"])
-        else:
-            return MonitorResponse.parse_obj(response_json)
-
-    def get_monitor(self, monitor_id: str) -> MonitorResponse:
-        """
-        Get details of a specific monitor.
-
-        Args:
-            monitor_id: The ID of the monitor to retrieve.
-
-        Returns:
-            A MonitorResponse object with the monitor details.
-        """
-        response = self._request("GET", f"/monitor/{monitor_id}")
-        response_json = response.json()
-        
-        # Handle DeepRails API response structure
-        if "data" in response_json:
-            return MonitorResponse.parse_obj(response_json["data"])
-        else:
-            return MonitorResponse.parse_obj(response_json)
-
-    def create_monitor_event(
-        self,
-        *,
-        monitor_id: str,
-        model_input: Dict[str, Any],
-        model_output: str,
-        guardrail_metrics: List[str],
-        model_used: Optional[str] = None,
-        run_mode: Optional[str] = None,
-        nametag: Optional[str] = None,
-        webhook: Optional[str] = None
-    ) -> MonitorEventResponse:
-        """
-        Creates a new event for a monitor.
-        
-        Args:
-            monitor_id: The ID of the monitor to create an event for.
-            model_input: A dictionary containing the inputs for the model.
-            model_output: The response generated by the model you are evaluating.
-            guardrail_metrics: A list of metrics to evaluate.
-            model_used: The name or identifier of the model being evaluated.
-            run_mode: The evaluation mode (e.g., "smart", "dev").
-            nametag: A user-defined name or tag for the event.
-            webhook: A URL to send a POST request to upon evaluation completion.
-        
-        Returns:
-            A MonitorEventResponse object with the details of the created event.
-        """
-        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,
-        }
-        
-        # Remove None values
-        json_payload = {k: v for k, v in payload.items() if v is not None}
-        
-        response = self._request("POST", f"/monitor/{monitor_id}/events", json=json_payload)
-        response_json = response.json()
-        
-        # Handle DeepRails API response structure
-        if "data" in response_json:
-            return MonitorEventResponse.parse_obj(response_json["data"])
-        else:
-            return MonitorEventResponse.parse_obj(response_json)
-
-    def get_monitor_events(
-        self, 
-        monitor_id: str, 
-        limit: int = 10, 
-        offset: int = 0
-    ) -> List[MonitorEventResponse]:
-        """
-        Retrieves events for a specific monitor.
-        
-        Args:
-            monitor_id: The ID of the monitor to get events for.
-            limit: Maximum number of events to return (default: 10).
-            offset: Offset for pagination (default: 0).
-            
-        Returns:
-            A list of MonitorEventResponse objects with details of the monitor events.
-        """
-        params = {
-            "limit": limit,
-            "offset": offset
-        }
-        
-        response = self._request("GET", f"/monitor/{monitor_id}/events", params=params)
-        response_json = response.json()
-        
-        # Handle DeepRails API response structure
-        if "data" in response_json and isinstance(response_json["data"], list):
-            return [MonitorEventResponse.parse_obj(event) for event in response_json["data"]]
-        else:
-            # Fallback if the response structure is unexpected
-            return []
-
-    def get_monitors(
-        self,
-        *,
-        page: int = 1,
-        limit: int = 20,
-        search: Optional[List[str]] = None,
-        monitor_status: Optional[List[str]] = None,
-        date_from: Optional[str] = None,
-        date_to: Optional[str] = None,
-        sort_by: str = "created_at",
-        sort_order: str = "desc"
-    ) -> MonitorListResponse:
-        """
-        Get a paginated list of monitors with optional filtering.
-        
-        Args:
-            page: Page number for pagination (default: 1)
-            limit: Number of items per page (default: 20, max: 100)
-            search: Optional list of free-text search terms
-            monitor_status: Optional list of monitor statuses ("active", "inactive", "all")
-            date_from: Optional filter for monitors from this date (ISO format)
-            date_to: Optional filter for monitors to this date (ISO format)
-            sort_by: Field to sort by (default: "created_at")
-            sort_order: Sort order (default: "desc")
-            
-        Returns:
-            A MonitorListResponse object containing monitors, pagination info, and applied filters.
-        """
-        params = {
-            "page": page,
-            "limit": limit,
-            "sort_by": sort_by,
-            "sort_order": sort_order,
-            "search": search,
-            "monitor_status": monitor_status,
-            "date_from": date_from,
-            "date_to": date_to
-        }
-        
-        # Remove None values
-        params = {k: v for k, v in params.items() if v is not None}
-        
-        response = self._request("GET", "/monitor", params=params)
-        return MonitorListResponse.parse_obj(response.json())

deeprails/exceptions.py

@@ -1,10 +0,0 @@
-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/schemas.py

@@ -1,92 +0,0 @@
-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'
-
-class MonitorResponse(BaseModel):
-    """Represents a monitor from the DeepRails API."""
-    monitor_id: str
-    user_id: str
-    name: str
-    description: Optional[str] = None
-    monitor_status: str
-    created_at: str
-    updated_at: str
-
-    class Config:
-        extra = 'ignore'
-
-class MonitorEventCreate(BaseModel):
-    """Model for creating a new monitor event."""
-    model_input: Dict[str, Any]
-    model_output: str
-    model_used: Optional[str] = None
-    run_mode: Optional[str] = None
-    guardrail_metrics: List[str]
-    nametag: Optional[str] = None
-    webhook: Optional[str] = None
-
-class MonitorEventResponse(BaseModel):
-    """Response model for a monitor event."""
-    event_id: str
-    monitor_id: str
-    evaluation_id: str
-    created_at: str
-
-    class Config:
-        extra = 'ignore'
-
-class PaginationInfo(BaseModel):
-    """Pagination information for list responses."""
-    page: int
-    limit: int
-    total_pages: int
-    total_count: int
-    has_next: bool
-    has_previous: bool
-
-class MonitorFiltersApplied(BaseModel):
-    """Information about which filters were applied to the monitor query."""
-    search: Optional[List[str]] = None
-    status: Optional[List[str]] = None
-    date_from: Optional[str] = None
-    date_to: Optional[str] = None
-    sort_by: Optional[str] = None
-    sort_order: Optional[str] = None
-
-class MonitorWithEventCountResponse(MonitorResponse):
-    """Monitor response with event count information."""
-    event_count: int
-    latest_event_modified_at: Optional[str] = None
-
-class MonitorListResponse(BaseModel):
-    """Response model for a paginated list of monitors."""
-    monitors: List[MonitorWithEventCountResponse]
-    pagination: PaginationInfo
-    filters_applied: MonitorFiltersApplied