arize-phoenix 4.10.2rc2__py3-none-any.whl → 4.11.0__py3-none-any.whl

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

@@ -1,10 +1,9 @@
 import gzip
 from itertools import chain
-from typing import AsyncContextManager, Callable, Iterator, Optional, Tuple
+from typing import AsyncContextManager, Callable, Iterator, Tuple
 
 import pandas as pd
 import pyarrow as pa
-from fastapi import APIRouter, Header, HTTPException, Query
 from google.protobuf.message import DecodeError
 from pandas import DataFrame
 from sqlalchemy import select
@@ -17,7 +16,7 @@ from starlette.datastructures import State
 from starlette.requests import Request
 from starlette.responses import Response, StreamingResponse
 from starlette.status import (
-    HTTP_204_NO_CONTENT,
+    HTTP_403_FORBIDDEN,
     HTTP_404_NOT_FOUND,
     HTTP_415_UNSUPPORTED_MEDIA_TYPE,
     HTTP_422_UNPROCESSABLE_ENTITY,
@@ -37,92 +36,86 @@ from phoenix.trace.span_evaluations import (
     TraceEvaluations,
 )
 
-from .utils import add_errors_to_responses
-
 EvaluationName: TypeAlias = str
 
-router = APIRouter(tags=["traces"], include_in_schema=False)
-
 
-@router.post(
-    "/evaluations",
-    operation_id="addEvaluations",
-    summary="Add span, trace, or document evaluations",
-    status_code=HTTP_204_NO_CONTENT,
-    responses=add_errors_to_responses(
-        [
-            {
-                "status_code": HTTP_415_UNSUPPORTED_MEDIA_TYPE,
-                "description": (
-                    "Unsupported content type, "
-                    "only gzipped protobuf and pandas-arrow are supported"
-                ),
-            },
-            HTTP_422_UNPROCESSABLE_ENTITY,
-        ]
-    ),
-    openapi_extra={
-        "requestBody": {
-            "required": True,
-            "content": {
-                "application/x-protobuf": {"schema": {"type": "string", "format": "binary"}},
-                "application/x-pandas-arrow": {"schema": {"type": "string", "format": "binary"}},
-            },
-        },
-    },
-)
-async def post_evaluations(
-    request: Request,
-    content_type: Optional[str] = Header(default=None),
-    content_encoding: Optional[str] = Header(default=None),
-) -> Response:
+async def post_evaluations(request: Request) -> Response:
+    """
+    summary: Add evaluations to a span, trace, or document
+    operationId: addEvaluations
+    tags:
+      - private
+    requestBody:
+      required: true
+      content:
+        application/x-protobuf:
+          schema:
+            type: string
+            format: binary
+        application/x-pandas-arrow:
+          schema:
+            type: string
+            format: binary
+    responses:
+      200:
+        description: Success
+      403:
+        description: Forbidden
+      415:
+        description: Unsupported content type, only gzipped protobuf and pandas-arrow are supported
+      422:
+        description: Request body is invalid
+    """
+    if request.app.state.read_only:
+        return Response(status_code=HTTP_403_FORBIDDEN)
+    content_type = request.headers.get("content-type")
     if content_type == "application/x-pandas-arrow":
         return await _process_pyarrow(request)
     if content_type != "application/x-protobuf":
-        raise HTTPException(
-            detail="Unsupported content type", status_code=HTTP_415_UNSUPPORTED_MEDIA_TYPE
-        )
+        return Response("Unsupported content type", status_code=HTTP_415_UNSUPPORTED_MEDIA_TYPE)
     body = await request.body()
+    content_encoding = request.headers.get("content-encoding")
     if content_encoding == "gzip":
         body = gzip.decompress(body)
     elif content_encoding:
-        raise HTTPException(
-            detail="Unsupported content encoding", status_code=HTTP_415_UNSUPPORTED_MEDIA_TYPE
-        )
+        return Response("Unsupported content encoding", status_code=HTTP_415_UNSUPPORTED_MEDIA_TYPE)
     evaluation = pb.Evaluation()
     try:
         evaluation.ParseFromString(body)
     except DecodeError:
-        raise HTTPException(
-            detail="Request body is invalid", status_code=HTTP_422_UNPROCESSABLE_ENTITY
-        )
+        return Response("Request body is invalid", status_code=HTTP_422_UNPROCESSABLE_ENTITY)
     if not evaluation.name.strip():
-        raise HTTPException(
-            detail="Evaluation name must not be blank/empty",
+        return Response(
+            "Evaluation name must not be blank/empty",
             status_code=HTTP_422_UNPROCESSABLE_ENTITY,
         )
     await request.state.queue_evaluation_for_bulk_insert(evaluation)
     return Response()
 
 
-@router.get(
-    "/evaluations",
-    operation_id="getEvaluations",
-    summary="Get span, trace, or document evaluations from a project",
-    responses=add_errors_to_responses([HTTP_404_NOT_FOUND]),
-)
-async def get_evaluations(
-    request: Request,
-    project_name: Optional[str] = Query(
-        default=None,
-        description=(
-            "The name of the project to get evaluations from (if omitted, "
-            f"evaluations will be drawn from the `{DEFAULT_PROJECT_NAME}` project)"
-        ),
-    ),
-) -> Response:
+async def get_evaluations(request: Request) -> Response:
+    """
+    summary: Get evaluations from Phoenix
+    operationId: getEvaluation
+    tags:
+      - private
+    parameters:
+      - name: project_name
+        in: query
+        schema:
+          type: string
+          default: default
+        description: The project name to get evaluations from
+    responses:
+      200:
+        description: Success
+      403:
+        description: Forbidden
+      404:
+        description: Not found
+    """
     project_name = (
-        project_name
+        request.query_params.get("project_name")
         or request.query_params.get("project-name")  # for backward compatibility
         or request.headers.get("project-name")  # read from headers for backwards compatibility
         or DEFAULT_PROJECT_NAME
@@ -176,20 +169,20 @@ async def _process_pyarrow(request: Request) -> Response:
     try:
         reader = pa.ipc.open_stream(body)
     except pa.ArrowInvalid:
-        raise HTTPException(
-            detail="Request body is not valid pyarrow",
+        return Response(
+            content="Request body is not valid pyarrow",
             status_code=HTTP_422_UNPROCESSABLE_ENTITY,
         )
     try:
         evaluations = Evaluations.from_pyarrow_reader(reader)
     except Exception as e:
         if isinstance(e, PhoenixEvaluationNameIsMissing):
-            raise HTTPException(
-                detail="Evaluation name must not be blank/empty",
+            return Response(
+                "Evaluation name must not be blank/empty",
                 status_code=HTTP_422_UNPROCESSABLE_ENTITY,
             )
-        raise HTTPException(
-            detail="Invalid data in request body",
+        return Response(
+            content="Invalid data in request body",
             status_code=HTTP_422_UNPROCESSABLE_ENTITY,
         )
     return Response(background=BackgroundTask(_add_evaluations, request.state, evaluations))

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

@@ -1,9 +1,7 @@
 from datetime import datetime
-from typing import Any, Dict, Literal, Optional
 
-from fastapi import APIRouter, HTTPException
-from pydantic import BaseModel, Field
 from starlette.requests import Request
+from starlette.responses import JSONResponse, Response
 from starlette.status import HTTP_404_NOT_FOUND
 from strawberry.relay import GlobalID
 
@@ -12,75 +10,103 @@ from phoenix.db.helpers import SupportedSQLDialect
 from phoenix.db.insertion.helpers import insert_on_conflict
 from phoenix.server.api.types.node import from_global_id_with_expected_type
 
-from .utils import ResponseBody, add_errors_to_responses
 
-router = APIRouter(tags=["experiments"], include_in_schema=False)
-
-
-class ExperimentEvaluationResult(BaseModel):
-    label: Optional[str] = Field(default=None, description="The label assigned by the evaluation")
-    score: Optional[float] = Field(default=None, description="The score assigned by the evaluation")
-    explanation: Optional[str] = Field(
-        default=None, description="Explanation of the evaluation result"
-    )
-
-
-class UpsertExperimentEvaluationRequestBody(BaseModel):
-    experiment_run_id: str = Field(description="The ID of the experiment run being evaluated")
-    name: str = Field(description="The name of the evaluation")
-    annotator_kind: Literal["LLM", "CODE", "HUMAN"] = Field(
-        description="The kind of annotator used for the evaluation"
-    )
-    start_time: datetime = Field(description="The start time of the evaluation in ISO format")
-    end_time: datetime = Field(description="The end time of the evaluation in ISO format")
-    result: ExperimentEvaluationResult = Field(description="The result of the evaluation")
-    error: Optional[str] = Field(
-        None, description="Optional error message if the evaluation encountered an error"
-    )
-    metadata: Optional[Dict[str, Any]] = Field(
-        default=None, description="Metadata for the evaluation"
-    )
-    trace_id: Optional[str] = Field(default=None, description="Optional trace ID for tracking")
-
-
-class UpsertExperimentEvaluationResponseBodyData(BaseModel):
-    id: str = Field(description="The ID of the upserted experiment evaluation")
-
-
-class UpsertExperimentEvaluationResponseBody(
-    ResponseBody[UpsertExperimentEvaluationResponseBodyData]
-):
-    pass
-
-
-@router.post(
-    "/experiment_evaluations",
-    operation_id="upsertExperimentEvaluation",
-    summary="Create or update evaluation for an experiment run",
-    responses=add_errors_to_responses(
-        [{"status_code": HTTP_404_NOT_FOUND, "description": "Experiment run not found"}]
-    ),
-)
-async def upsert_experiment_evaluation(
-    request: Request, request_body: UpsertExperimentEvaluationRequestBody
-) -> UpsertExperimentEvaluationResponseBody:
+async def upsert_experiment_evaluation(request: Request) -> Response:
+    """
+    summary: Create an evaluation for a specific experiment run
+    operationId: upsertExperimentEvaluation
+    tags:
+      - private
+    requestBody:
+      description: Details of the experiment evaluation to be upserted
+      required: true
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              experiment_run_id:
+                type: string
+                description: The ID of the experiment run being evaluated
+              name:
+                type: string
+                description: The name of the evaluation
+              annotator_kind:
+                type: string
+                description: The kind of annotator used for the evaluation
+              result:
+                type: object
+                description: The result of the evaluation
+                properties:
+                  label:
+                    type: string
+                    description: The label assigned by the evaluation
+                  score:
+                    type: number
+                    format: float
+                    description: The score assigned by the evaluation
+                  explanation:
+                    type: string
+                    description: Explanation of the evaluation result
+              error:
+                type: string
+                description: Optional error message if the evaluation encountered an error
+              metadata:
+                type: object
+                description: Metadata for the evaluation
+                additionalProperties:
+                  type: string
+              start_time:
+                type: string
+                format: date-time
+                description: The start time of the evaluation in ISO format
+              end_time:
+                type: string
+                format: date-time
+                description: The end time of the evaluation in ISO format
+              trace_id:
+                type: string
+                description: Optional trace ID for tracking
+            required:
+              - experiment_run_id
+              - name
+              - annotator_kind
+              - start_time
+              - end_time
+    responses:
+      200:
+        description: Experiment evaluation upserted successfully
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                data:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                      description: The ID of the upserted experiment evaluation
+      404:
+        description: ExperimentRun not found
+    """
     payload = await request.json()
     experiment_run_gid = GlobalID.from_id(payload["experiment_run_id"])
     try:
         experiment_run_id = from_global_id_with_expected_type(experiment_run_gid, "ExperimentRun")
     except ValueError:
-        raise HTTPException(
-            detail=f"ExperimentRun with ID {experiment_run_gid} does not exist",
+        return Response(
+            content=f"ExperimentRun with ID {experiment_run_gid} does not exist",
             status_code=HTTP_404_NOT_FOUND,
         )
-    name = request_body.name
-    annotator_kind = request_body.annotator_kind
-    result = request_body.result
-    label = result.label if result else None
-    score = result.score if result else None
-    explanation = result.explanation if result else None
-    error = request_body.error
-    metadata = request_body.metadata or {}
+    name = payload["name"]
+    annotator_kind = payload["annotator_kind"]
+    result = payload.get("result")
+    label = result.get("label") if result else None
+    score = result.get("score") if result else None
+    explanation = result.get("explanation") if result else None
+    error = payload.get("error")
+    metadata = payload.get("metadata") or {}
     start_time = payload["start_time"]
     end_time = payload["end_time"]
     async with request.app.state.db() as session:
@@ -107,6 +133,4 @@ async def upsert_experiment_evaluation(
             ).returning(models.ExperimentRunAnnotation)
         )
     evaluation_gid = GlobalID("ExperimentEvaluation", str(exp_eval_run.id))
-    return UpsertExperimentEvaluationResponseBody(
-        data=UpsertExperimentEvaluationResponseBodyData(id=str(evaluation_gid))
-    )
+    return JSONResponse(content={"data": {"id": str(evaluation_gid)}})