circuit-breaker-labs 1.0.5__tar.gz → 1.0.7__tar.gz

{circuit_breaker_labs-1.0.5 → circuit_breaker_labs-1.0.7}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.3
 Name: circuit-breaker-labs
-Version: 1.0.5
+Version: 1.0.7
 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
 Requires-Dist: python-dateutil>=2.8.0,<3
-Requires-Dist: types-python-dateutil>=2.9.0.20251115
+Requires-Dist: types-python-dateutil>=2.9.0.20260124
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 
@@ -20,7 +20,7 @@ Description-Content-Type: text/markdown
 <!-- 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
@@ -48,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,
@@ -72,19 +72,51 @@ 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,
+    )
+```
+
+Want to test multi-turn conversations instead? Use the multi-turn endpoint (async version also available):
+
+```python
+import os
+
+from circuit_breaker_labs.api.evaluations import multi_turn_evaluate_system_prompt_post
+from circuit_breaker_labs.models import (
+    MultiTurnEvaluateSystemPromptRequest,
+    MultiTurnTestType,
+    TestCasePack,
+)
+
+with client as client:
+    request = MultiTurnEvaluateSystemPromptRequest(
+        threshold=0.6,
+        max_turns=6,
+        test_types=[
+            MultiTurnTestType.SEMANTIC_CHUNKS,
+            MultiTurnTestType.USER_PERSONA,
+        ],
+        system_prompt=os.getenv("SYSTEM_PROMPT"),
+        openrouter_model_name="anthropic/claude-3.7-sonnet",
+        test_case_packs=[TestCasePack.SUICIDAL_IDEATION],
+    )
+
+    run_tests_response = multi_turn_evaluate_system_prompt_post.sync(
         client=client,
         cbl_api_key=os.getenv("CBL_API_KEY"),
         body=request,

{circuit_breaker_labs-1.0.5 → circuit_breaker_labs-1.0.7}/README.md

@@ -9,7 +9,7 @@
 <!-- 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
@@ -37,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,
@@ -61,19 +61,51 @@ 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,
+    )
+```
+
+Want to test multi-turn conversations instead? Use the multi-turn endpoint (async version also available):
+
+```python
+import os
+
+from circuit_breaker_labs.api.evaluations import multi_turn_evaluate_system_prompt_post
+from circuit_breaker_labs.models import (
+    MultiTurnEvaluateSystemPromptRequest,
+    MultiTurnTestType,
+    TestCasePack,
+)
+
+with client as client:
+    request = MultiTurnEvaluateSystemPromptRequest(
+        threshold=0.6,
+        max_turns=6,
+        test_types=[
+            MultiTurnTestType.SEMANTIC_CHUNKS,
+            MultiTurnTestType.USER_PERSONA,
+        ],
+        system_prompt=os.getenv("SYSTEM_PROMPT"),
+        openrouter_model_name="anthropic/claude-3.7-sonnet",
+        test_case_packs=[TestCasePack.SUICIDAL_IDEATION],
+    )
+
+    run_tests_response = multi_turn_evaluate_system_prompt_post.sync(
         client=client,
         cbl_api_key=os.getenv("CBL_API_KEY"),
         body=request,

circuit_breaker_labs-1.0.7/circuit_breaker_labs/api/evaluations/multi_turn_evaluate_system_prompt_post.py

@@ -0,0 +1,257 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.http_validation_error import HTTPValidationError
+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: MultiTurnEvaluateSystemPromptRequest,
+    cbl_api_key: str,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+    headers["cbl-api-key"] = cbl_api_key
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/multiturn_evaluate_system_prompt",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> (
+    HTTPValidationError
+    | InternalServerErrorResponse
+    | MultiTurnRunTestsResponse
+    | NotFoundResponse
+    | QuotaExceededResponse
+    | UnauthorizedResponse
+    | None
+):
+    if response.status_code == 200:
+        response_200 = MultiTurnRunTestsResponse.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = UnauthorizedResponse.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 403:
+        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:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[
+    HTTPValidationError
+    | InternalServerErrorResponse
+    | MultiTurnRunTestsResponse
+    | NotFoundResponse
+    | QuotaExceededResponse
+    | UnauthorizedResponse
+]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: MultiTurnEvaluateSystemPromptRequest,
+    cbl_api_key: str,
+) -> 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 (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 | InternalServerErrorResponse | MultiTurnRunTestsResponse | NotFoundResponse | QuotaExceededResponse | UnauthorizedResponse]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+        cbl_api_key=cbl_api_key,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    body: MultiTurnEvaluateSystemPromptRequest,
+    cbl_api_key: str,
+) -> (
+    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 (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 | InternalServerErrorResponse | MultiTurnRunTestsResponse | NotFoundResponse | QuotaExceededResponse | UnauthorizedResponse
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+        cbl_api_key=cbl_api_key,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: MultiTurnEvaluateSystemPromptRequest,
+    cbl_api_key: str,
+) -> 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 (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 | InternalServerErrorResponse | MultiTurnRunTestsResponse | NotFoundResponse | QuotaExceededResponse | UnauthorizedResponse]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+        cbl_api_key=cbl_api_key,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    body: MultiTurnEvaluateSystemPromptRequest,
+    cbl_api_key: str,
+) -> (
+    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 (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 | InternalServerErrorResponse | MultiTurnRunTestsResponse | NotFoundResponse | QuotaExceededResponse | UnauthorizedResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+            cbl_api_key=cbl_api_key,
+        )
+    ).parsed