circuit-breaker-labs 1.0.4__tar.gz → 1.0.6__tar.gz

{circuit_breaker_labs-1.0.4 → circuit_breaker_labs-1.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: circuit-breaker-labs
-Version: 1.0.4
+Version: 1.0.6
 Summary: A client library for accessing Circuit Breaker Labs API
 Requires-Dist: httpx>=0.23.0,<0.29.0
 Requires-Dist: attrs>=22.2.0
@@ -13,14 +13,26 @@ Description-Content-Type: text/markdown
 
 ![Python Version](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fcircuitbreakerlabs%2Fcircuitbreakerlabs-python%2Frefs%2Fheads%2Fmain%2Fpyproject.toml&logo=python&logoColor=yellow&label=Python&color=blue)
 ![Ruff](https://img.shields.io/badge/Ruff-Check-34223D?logo=ruff)
-![MyPy](https://img.shields.io/badge/Mypy-Check-blue?logo=python)
+[![MyPy](https://img.shields.io/badge/Mypy-Check-blue?logo=python)](https://github.com/circuitbreakerlabs/circuitbreakerlabs-python/actions/workflows/type-checking.yml)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![PyPI - Version](https://img.shields.io/pypi/v/circuit-breaker-labs?logo=pypi&label=PyPi)](https://pypi.org/project/circuit-breaker-labs/)
 
 <!-- prettier-ignore-start -->
 > [!Note]
 > This project was automatically generated by [OpenAPI Python Client](https://github.com/openapi-generators/openapi-python-client)
-> from [this OpenAPI spec](https://api.circuitbreakerlabs.ai/v1/openapi.json).
+> from [this OpenAPI spec](https://github.com/circuitbreakerlabs/circuitbreakerlabs-python/blob/main/openapi.json).
 <!-- prettier-ignore-end -->
 
+## Installation
+
+Install from PyPi directly:
+
+```sh
+uv pip install circuit-breaker-labs
+```
+
+Or install using a wheel/sdist distributed with [each release](https://github.com/circuitbreakerlabs/circuitbreakerlabs-python/releases).
+
 ## Usage
 
 First, create a client:
@@ -36,19 +48,19 @@ Now build a request and use it when calling an endpoint
 ```python
 import os
 
-from circuit_breaker_labs.api.evaluations import evaluate_system_prompt_post
-from circuit_breaker_labs.models import EvaluateSystemPromptRequest
+from circuit_breaker_labs.api.evaluations import singleturn_evaluate_system_prompt_post
+from circuit_breaker_labs.models import SingleTurnEvaluateSystemPromptRequest
 
 with client as client:
-    request = EvaluateSystemPromptRequest(
-        0.5,
-        3,
-        2,
-        os.getenv("SYSTEM_PROMPT"),
-        "anthropic/claude-3.7-sonnet",
+    request = SingleTurnEvaluateSystemPromptRequest(
+        threshold=0.5,
+        variations=3,
+        maximum_iteration_layers=2,
+        system_prompt=os.getenv("SYSTEM_PROMPT"),
+        openrouter_model_name="anthropic/claude-3.7-sonnet",
     )
 
-    run_tests_response = evaluate_system_prompt_post.sync(
+    run_tests_response = singleturn_evaluate_system_prompt_post.sync(
         client=client,
         cbl_api_key=os.getenv("CBL_API_KEY"),
         body=request,
@@ -60,19 +72,19 @@ Or do the same thing with an async version:
 ```python
 import os
 
-from circuit_breaker_labs.api.evaluations import evaluate_system_prompt_post
-from circuit_breaker_labs.models import EvaluateSystemPromptRequest
+from circuit_breaker_labs.api.evaluations import singleturn_evaluate_system_prompt_post
+from circuit_breaker_labs.models import SingleTurnEvaluateSystemPromptRequest
 
 async with client as client:
-    request = EvaluateSystemPromptRequest(
-        0.5,
-        3,
-        2,
-        os.getenv("SYSTEM_PROMPT"),
-        "anthropic/claude-3.7-sonnet",
+    request = SingleTurnEvaluateSystemPromptRequest(
+        threshold=0.5,
+        variations=3,
+        maximum_iteration_layers=2,
+        system_prompt=os.getenv("SYSTEM_PROMPT"),
+        openrouter_model_name="anthropic/claude-3.7-sonnet",
     )
 
-    run_tests_response = evaluate_system_prompt_post.asyncio(
+    run_tests_response = await singleturn_evaluate_system_prompt_post.asyncio(
         client=client,
         cbl_api_key=os.getenv("CBL_API_KEY"),
         body=request,

{circuit_breaker_labs-1.0.4 → circuit_breaker_labs-1.0.6}/README.md

@@ -2,14 +2,26 @@
 
 ![Python Version](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fcircuitbreakerlabs%2Fcircuitbreakerlabs-python%2Frefs%2Fheads%2Fmain%2Fpyproject.toml&logo=python&logoColor=yellow&label=Python&color=blue)
 ![Ruff](https://img.shields.io/badge/Ruff-Check-34223D?logo=ruff)
-![MyPy](https://img.shields.io/badge/Mypy-Check-blue?logo=python)
+[![MyPy](https://img.shields.io/badge/Mypy-Check-blue?logo=python)](https://github.com/circuitbreakerlabs/circuitbreakerlabs-python/actions/workflows/type-checking.yml)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![PyPI - Version](https://img.shields.io/pypi/v/circuit-breaker-labs?logo=pypi&label=PyPi)](https://pypi.org/project/circuit-breaker-labs/)
 
 <!-- prettier-ignore-start -->
 > [!Note]
 > This project was automatically generated by [OpenAPI Python Client](https://github.com/openapi-generators/openapi-python-client)
-> from [this OpenAPI spec](https://api.circuitbreakerlabs.ai/v1/openapi.json).
+> from [this OpenAPI spec](https://github.com/circuitbreakerlabs/circuitbreakerlabs-python/blob/main/openapi.json).
 <!-- prettier-ignore-end -->
 
+## Installation
+
+Install from PyPi directly:
+
+```sh
+uv pip install circuit-breaker-labs
+```
+
+Or install using a wheel/sdist distributed with [each release](https://github.com/circuitbreakerlabs/circuitbreakerlabs-python/releases).
+
 ## Usage
 
 First, create a client:
@@ -25,19 +37,19 @@ Now build a request and use it when calling an endpoint
 ```python
 import os
 
-from circuit_breaker_labs.api.evaluations import evaluate_system_prompt_post
-from circuit_breaker_labs.models import EvaluateSystemPromptRequest
+from circuit_breaker_labs.api.evaluations import singleturn_evaluate_system_prompt_post
+from circuit_breaker_labs.models import SingleTurnEvaluateSystemPromptRequest
 
 with client as client:
-    request = EvaluateSystemPromptRequest(
-        0.5,
-        3,
-        2,
-        os.getenv("SYSTEM_PROMPT"),
-        "anthropic/claude-3.7-sonnet",
+    request = SingleTurnEvaluateSystemPromptRequest(
+        threshold=0.5,
+        variations=3,
+        maximum_iteration_layers=2,
+        system_prompt=os.getenv("SYSTEM_PROMPT"),
+        openrouter_model_name="anthropic/claude-3.7-sonnet",
     )
 
-    run_tests_response = evaluate_system_prompt_post.sync(
+    run_tests_response = singleturn_evaluate_system_prompt_post.sync(
         client=client,
         cbl_api_key=os.getenv("CBL_API_KEY"),
         body=request,
@@ -49,19 +61,19 @@ Or do the same thing with an async version:
 ```python
 import os
 
-from circuit_breaker_labs.api.evaluations import evaluate_system_prompt_post
-from circuit_breaker_labs.models import EvaluateSystemPromptRequest
+from circuit_breaker_labs.api.evaluations import singleturn_evaluate_system_prompt_post
+from circuit_breaker_labs.models import SingleTurnEvaluateSystemPromptRequest
 
 async with client as client:
-    request = EvaluateSystemPromptRequest(
-        0.5,
-        3,
-        2,
-        os.getenv("SYSTEM_PROMPT"),
-        "anthropic/claude-3.7-sonnet",
+    request = SingleTurnEvaluateSystemPromptRequest(
+        threshold=0.5,
+        variations=3,
+        maximum_iteration_layers=2,
+        system_prompt=os.getenv("SYSTEM_PROMPT"),
+        openrouter_model_name="anthropic/claude-3.7-sonnet",
     )
 
-    run_tests_response = evaluate_system_prompt_post.asyncio(
+    run_tests_response = await singleturn_evaluate_system_prompt_post.asyncio(
         client=client,
         cbl_api_key=os.getenv("CBL_API_KEY"),
         body=request,

{circuit_breaker_labs-1.0.4 → circuit_breaker_labs-1.0.6}/circuit_breaker_labs/api/api_keys/monthly_quota_get.py

@@ -7,7 +7,7 @@ from ... import errors
 from ...client import AuthenticatedClient, Client
 from ...models.http_validation_error import HTTPValidationError
 from ...models.monthly_quota_response import MonthlyQuotaResponse
-from ...models.unauthorized_error import UnauthorizedError
+from ...models.unauthorized_response import UnauthorizedResponse
 from ...types import Response
 
 
@@ -29,14 +29,14 @@ def _get_kwargs(
 
 def _parse_response(
     *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> HTTPValidationError | MonthlyQuotaResponse | UnauthorizedError | None:
+) -> HTTPValidationError | MonthlyQuotaResponse | UnauthorizedResponse | None:
     if response.status_code == 200:
         response_200 = MonthlyQuotaResponse.from_dict(response.json())
 
         return response_200
 
     if response.status_code == 401:
-        response_401 = UnauthorizedError.from_dict(response.json())
+        response_401 = UnauthorizedResponse.from_dict(response.json())
 
         return response_401
 
@@ -53,7 +53,7 @@ def _parse_response(
 
 def _build_response(
     *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> Response[HTTPValidationError | MonthlyQuotaResponse | UnauthorizedError]:
+) -> Response[HTTPValidationError | MonthlyQuotaResponse | UnauthorizedResponse]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -66,7 +66,7 @@ def sync_detailed(
     *,
     client: AuthenticatedClient | Client,
     cbl_api_key: str,
-) -> Response[HTTPValidationError | MonthlyQuotaResponse | UnauthorizedError]:
+) -> Response[HTTPValidationError | MonthlyQuotaResponse | UnauthorizedResponse]:
     """Monthly Quota
 
      Get the monthly usage statistics for the provided API key.
@@ -79,7 +79,7 @@ def sync_detailed(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[HTTPValidationError | MonthlyQuotaResponse | UnauthorizedError]
+        Response[HTTPValidationError | MonthlyQuotaResponse | UnauthorizedResponse]
     """
 
     kwargs = _get_kwargs(
@@ -97,7 +97,7 @@ def sync(
     *,
     client: AuthenticatedClient | Client,
     cbl_api_key: str,
-) -> HTTPValidationError | MonthlyQuotaResponse | UnauthorizedError | None:
+) -> HTTPValidationError | MonthlyQuotaResponse | UnauthorizedResponse | None:
     """Monthly Quota
 
      Get the monthly usage statistics for the provided API key.
@@ -110,7 +110,7 @@ def sync(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        HTTPValidationError | MonthlyQuotaResponse | UnauthorizedError
+        HTTPValidationError | MonthlyQuotaResponse | UnauthorizedResponse
     """
 
     return sync_detailed(
@@ -123,7 +123,7 @@ async def asyncio_detailed(
     *,
     client: AuthenticatedClient | Client,
     cbl_api_key: str,
-) -> Response[HTTPValidationError | MonthlyQuotaResponse | UnauthorizedError]:
+) -> Response[HTTPValidationError | MonthlyQuotaResponse | UnauthorizedResponse]:
     """Monthly Quota
 
      Get the monthly usage statistics for the provided API key.
@@ -136,7 +136,7 @@ async def asyncio_detailed(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[HTTPValidationError | MonthlyQuotaResponse | UnauthorizedError]
+        Response[HTTPValidationError | MonthlyQuotaResponse | UnauthorizedResponse]
     """
 
     kwargs = _get_kwargs(
@@ -152,7 +152,7 @@ async def asyncio(
     *,
     client: AuthenticatedClient | Client,
     cbl_api_key: str,
-) -> HTTPValidationError | MonthlyQuotaResponse | UnauthorizedError | None:
+) -> HTTPValidationError | MonthlyQuotaResponse | UnauthorizedResponse | None:
     """Monthly Quota
 
      Get the monthly usage statistics for the provided API key.
@@ -165,7 +165,7 @@ async def asyncio(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        HTTPValidationError | MonthlyQuotaResponse | UnauthorizedError
+        HTTPValidationError | MonthlyQuotaResponse | UnauthorizedResponse
     """
 
     return (

circuit_breaker_labs-1.0.4/circuit_breaker_labs/api/evaluations/evaluate_system_prompt_post.py → circuit_breaker_labs-1.0.6/circuit_breaker_labs/api/evaluations/multi_turn_evaluate_system_prompt_post.py

@@ -5,17 +5,19 @@ import httpx
 
 from ... import errors
 from ...client import AuthenticatedClient, Client
-from ...models.evaluate_system_prompt_request import EvaluateSystemPromptRequest
 from ...models.http_validation_error import HTTPValidationError
-from ...models.quota_exceeded_error import QuotaExceededError
-from ...models.run_tests_response import RunTestsResponse
-from ...models.unauthorized_error import UnauthorizedError
+from ...models.internal_server_error_response import InternalServerErrorResponse
+from ...models.multi_turn_evaluate_system_prompt_request import MultiTurnEvaluateSystemPromptRequest
+from ...models.multi_turn_run_tests_response import MultiTurnRunTestsResponse
+from ...models.not_found_response import NotFoundResponse
+from ...models.quota_exceeded_response import QuotaExceededResponse
+from ...models.unauthorized_response import UnauthorizedResponse
 from ...types import Response
 
 
 def _get_kwargs(
     *,
-    body: EvaluateSystemPromptRequest,
+    body: MultiTurnEvaluateSystemPromptRequest,
     cbl_api_key: str,
 ) -> dict[str, Any]:
     headers: dict[str, Any] = {}
@@ -23,7 +25,7 @@ def _get_kwargs(
 
     _kwargs: dict[str, Any] = {
         "method": "post",
-        "url": "/evaluate_system_prompt",
+        "url": "/multiturn_evaluate_system_prompt",
     }
 
     _kwargs["json"] = body.to_dict()
@@ -36,27 +38,45 @@ def _get_kwargs(
 
 def _parse_response(
     *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> HTTPValidationError | QuotaExceededError | RunTestsResponse | UnauthorizedError | None:
+) -> (
+    HTTPValidationError
+    | InternalServerErrorResponse
+    | MultiTurnRunTestsResponse
+    | NotFoundResponse
+    | QuotaExceededResponse
+    | UnauthorizedResponse
+    | None
+):
     if response.status_code == 200:
-        response_200 = RunTestsResponse.from_dict(response.json())
+        response_200 = MultiTurnRunTestsResponse.from_dict(response.json())
 
         return response_200
 
     if response.status_code == 401:
-        response_401 = UnauthorizedError.from_dict(response.json())
+        response_401 = UnauthorizedResponse.from_dict(response.json())
 
         return response_401
 
     if response.status_code == 403:
-        response_403 = QuotaExceededError.from_dict(response.json())
+        response_403 = QuotaExceededResponse.from_dict(response.json())
 
         return response_403
 
+    if response.status_code == 404:
+        response_404 = NotFoundResponse.from_dict(response.json())
+
+        return response_404
+
     if response.status_code == 422:
         response_422 = HTTPValidationError.from_dict(response.json())
 
         return response_422
 
+    if response.status_code == 500:
+        response_500 = InternalServerErrorResponse.from_dict(response.json())
+
+        return response_500
+
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
     else:
@@ -65,7 +85,14 @@ def _parse_response(
 
 def _build_response(
     *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> Response[HTTPValidationError | QuotaExceededError | RunTestsResponse | UnauthorizedError]:
+) -> Response[
+    HTTPValidationError
+    | InternalServerErrorResponse
+    | MultiTurnRunTestsResponse
+    | NotFoundResponse
+    | QuotaExceededResponse
+    | UnauthorizedResponse
+]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -77,23 +104,30 @@ def _build_response(
 def sync_detailed(
     *,
     client: AuthenticatedClient | Client,
-    body: EvaluateSystemPromptRequest,
+    body: MultiTurnEvaluateSystemPromptRequest,
     cbl_api_key: str,
-) -> Response[HTTPValidationError | QuotaExceededError | RunTestsResponse | UnauthorizedError]:
-    """Evaluate System Prompt
-
-     Run agentic safety tests aginst a system prompt.
+) -> Response[
+    HTTPValidationError
+    | InternalServerErrorResponse
+    | MultiTurnRunTestsResponse
+    | NotFoundResponse
+    | QuotaExceededResponse
+    | UnauthorizedResponse
+]:
+    """Multi-turn Evaluate System Prompt
+
+     Run multi-turn safety tests against a system prompt.
 
     Args:
         cbl_api_key (str): Circuit Breaker Labs API Key
-        body (EvaluateSystemPromptRequest):
+        body (MultiTurnEvaluateSystemPromptRequest):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[HTTPValidationError | QuotaExceededError | RunTestsResponse | UnauthorizedError]
+        Response[HTTPValidationError | InternalServerErrorResponse | MultiTurnRunTestsResponse | NotFoundResponse | QuotaExceededResponse | UnauthorizedResponse]
     """
 
     kwargs = _get_kwargs(
@@ -111,23 +145,31 @@ def sync_detailed(
 def sync(
     *,
     client: AuthenticatedClient | Client,
-    body: EvaluateSystemPromptRequest,
+    body: MultiTurnEvaluateSystemPromptRequest,
     cbl_api_key: str,
-) -> HTTPValidationError | QuotaExceededError | RunTestsResponse | UnauthorizedError | None:
-    """Evaluate System Prompt
-
-     Run agentic safety tests aginst a system prompt.
+) -> (
+    HTTPValidationError
+    | InternalServerErrorResponse
+    | MultiTurnRunTestsResponse
+    | NotFoundResponse
+    | QuotaExceededResponse
+    | UnauthorizedResponse
+    | None
+):
+    """Multi-turn Evaluate System Prompt
+
+     Run multi-turn safety tests against a system prompt.
 
     Args:
         cbl_api_key (str): Circuit Breaker Labs API Key
-        body (EvaluateSystemPromptRequest):
+        body (MultiTurnEvaluateSystemPromptRequest):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        HTTPValidationError | QuotaExceededError | RunTestsResponse | UnauthorizedError
+        HTTPValidationError | InternalServerErrorResponse | MultiTurnRunTestsResponse | NotFoundResponse | QuotaExceededResponse | UnauthorizedResponse
     """
 
     return sync_detailed(
@@ -140,23 +182,30 @@ def sync(
 async def asyncio_detailed(
     *,
     client: AuthenticatedClient | Client,
-    body: EvaluateSystemPromptRequest,
+    body: MultiTurnEvaluateSystemPromptRequest,
     cbl_api_key: str,
-) -> Response[HTTPValidationError | QuotaExceededError | RunTestsResponse | UnauthorizedError]:
-    """Evaluate System Prompt
-
-     Run agentic safety tests aginst a system prompt.
+) -> Response[
+    HTTPValidationError
+    | InternalServerErrorResponse
+    | MultiTurnRunTestsResponse
+    | NotFoundResponse
+    | QuotaExceededResponse
+    | UnauthorizedResponse
+]:
+    """Multi-turn Evaluate System Prompt
+
+     Run multi-turn safety tests against a system prompt.
 
     Args:
         cbl_api_key (str): Circuit Breaker Labs API Key
-        body (EvaluateSystemPromptRequest):
+        body (MultiTurnEvaluateSystemPromptRequest):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[HTTPValidationError | QuotaExceededError | RunTestsResponse | UnauthorizedError]
+        Response[HTTPValidationError | InternalServerErrorResponse | MultiTurnRunTestsResponse | NotFoundResponse | QuotaExceededResponse | UnauthorizedResponse]
     """
 
     kwargs = _get_kwargs(
@@ -172,23 +221,31 @@ async def asyncio_detailed(
 async def asyncio(
     *,
     client: AuthenticatedClient | Client,
-    body: EvaluateSystemPromptRequest,
+    body: MultiTurnEvaluateSystemPromptRequest,
     cbl_api_key: str,
-) -> HTTPValidationError | QuotaExceededError | RunTestsResponse | UnauthorizedError | None:
-    """Evaluate System Prompt
-
-     Run agentic safety tests aginst a system prompt.
+) -> (
+    HTTPValidationError
+    | InternalServerErrorResponse
+    | MultiTurnRunTestsResponse
+    | NotFoundResponse
+    | QuotaExceededResponse
+    | UnauthorizedResponse
+    | None
+):
+    """Multi-turn Evaluate System Prompt
+
+     Run multi-turn safety tests against a system prompt.
 
     Args:
         cbl_api_key (str): Circuit Breaker Labs API Key
-        body (EvaluateSystemPromptRequest):
+        body (MultiTurnEvaluateSystemPromptRequest):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        HTTPValidationError | QuotaExceededError | RunTestsResponse | UnauthorizedError
+        HTTPValidationError | InternalServerErrorResponse | MultiTurnRunTestsResponse | NotFoundResponse | QuotaExceededResponse | UnauthorizedResponse
     """
 
     return (