arize-phoenix 4.14.1__py3-none-any.whl → 4.15.0__py3-none-any.whl

phoenix/server/api/routers/v1/__init__.py

@@ -1,89 +1,42 @@
-from typing import Any, Awaitable, Callable, Mapping, Tuple
-
-import wrapt
-from starlette import routing
-from starlette.requests import Request
-from starlette.responses import Response
+from fastapi import APIRouter, Depends, HTTPException, Request
 from starlette.status import HTTP_403_FORBIDDEN
 
-from . import (
-    datasets,
-    evaluations,
-    experiment_evaluations,
-    experiment_runs,
-    experiments,
-    spans,
-    traces,
-)
-from .dataset_examples import list_dataset_examples
-
+from .datasets import router as datasets_router
+from .evaluations import router as evaluations_router
+from .experiment_evaluations import router as experiment_evaluations_router
+from .experiment_runs import router as experiment_runs_router
+from .experiments import router as experiments_router
+from .spans import router as spans_router
+from .traces import router as traces_router
+from .utils import add_errors_to_responses
 
-@wrapt.decorator  # type: ignore
-async def forbid_if_readonly(
-    wrapped: Callable[[Request], Awaitable[Response]],
-    _: Any,
-    args: Tuple[Request],
-    kwargs: Mapping[str, Any],
-) -> Response:
-    request, *_ = args
-    if request.app.state.read_only:
-        return Response(status_code=HTTP_403_FORBIDDEN)
-    return await wrapped(*args, **kwargs)
+REST_API_VERSION = "1.0"
 
 
-class Route(routing.Route):
-    def __init__(self, path: str, endpoint: Callable[..., Any], **kwargs: Any) -> None:
-        super().__init__(path, forbid_if_readonly(endpoint), **kwargs)
-
-
-V1_ROUTES = [
-    Route("/v1/evaluations", evaluations.post_evaluations, methods=["POST"]),
-    Route("/v1/evaluations", evaluations.get_evaluations, methods=["GET"]),
-    Route("/v1/traces", traces.post_traces, methods=["POST"]),
-    Route("/v1/trace_annotations", traces.annotate_traces, methods=["POST"]),
-    Route("/v1/spans", spans.query_spans_handler, methods=["POST"]),
-    Route("/v1/spans", spans.get_spans_handler, methods=["GET"]),
-    Route("/v1/span_annotations", spans.annotate_spans, methods=["POST"]),
-    Route("/v1/datasets/upload", datasets.post_datasets_upload, methods=["POST"]),
-    Route("/v1/datasets", datasets.list_datasets, methods=["GET"]),
-    Route("/v1/datasets/{id:str}", datasets.delete_dataset_by_id, methods=["DELETE"]),
-    Route("/v1/datasets/{id:str}", datasets.get_dataset_by_id, methods=["GET"]),
-    Route("/v1/datasets/{id:str}/csv", datasets.get_dataset_csv, methods=["GET"]),
-    Route(
-        "/v1/datasets/{id:str}/jsonl/openai_ft",
-        datasets.get_dataset_jsonl_openai_ft,
-        methods=["GET"],
-    ),
-    Route(
-        "/v1/datasets/{id:str}/jsonl/openai_evals",
-        datasets.get_dataset_jsonl_openai_evals,
-        methods=["GET"],
-    ),
-    Route("/v1/datasets/{id:str}/examples", list_dataset_examples, methods=["GET"]),
-    Route("/v1/datasets/{id:str}/versions", datasets.get_dataset_versions, methods=["GET"]),
-    Route(
-        "/v1/datasets/{dataset_id:str}/experiments",
-        experiments.create_experiment,
-        methods=["POST"],
-    ),
-    Route(
-        "/v1/experiments/{experiment_id:str}",
-        experiments.read_experiment,
-        methods=["GET"],
-    ),
-    Route(
-        "/v1/experiments/{experiment_id:str}/runs",
-        experiment_runs.create_experiment_run,
-        methods=["POST"],
-    ),
-    Route(
-        "/v1/experiments/{experiment_id:str}/runs",
-        experiment_runs.list_experiment_runs,
-        methods=["GET"],
-    ),
-    Route(
-        "/v1/experiment_evaluations",
-        experiment_evaluations.upsert_experiment_evaluation,
-        methods=["POST"],
+async def prevent_access_in_read_only_mode(request: Request) -> None:
+    """
+    Prevents access to the REST API in read-only mode.
+    """
+    if request.app.state.read_only:
+        raise HTTPException(
+            detail="The Phoenix REST API is disabled in read-only mode.",
+            status_code=HTTP_403_FORBIDDEN,
+        )
+
+
+router = APIRouter(
+    prefix="/v1",
+    dependencies=[Depends(prevent_access_in_read_only_mode)],
+    responses=add_errors_to_responses(
+        [
+            HTTP_403_FORBIDDEN  # adds a 403 response to each route in the generated OpenAPI schema
+        ]
     ),
-]
+)
+router.include_router(datasets_router)
+router.include_router(experiments_router)
+router.include_router(experiment_runs_router)
+router.include_router(experiment_evaluations_router)
+router.include_router(traces_router)
+router.include_router(spans_router)
+router.include_router(evaluations_router)