arize-phoenix 12.8.0__py3-none-any.whl → 12.9.0__py3-none-any.whl

phoenix/server/api/types/SpanAnnotation.py

@@ -1,7 +1,8 @@
-from typing import Optional
+from datetime import datetime
+from math import isfinite
+from typing import TYPE_CHECKING, Annotated, Optional
 
 import strawberry
-from strawberry import Private
 from strawberry.relay import GlobalID, Node, NodeID
 from strawberry.scalars import JSON
 from strawberry.types import Info
@@ -12,56 +13,202 @@ from phoenix.server.api.context import Context
 from .Annotation import Annotation
 from .AnnotationSource import AnnotationSource
 from .AnnotatorKind import AnnotatorKind
-from .User import User, to_gql_user
+
+if TYPE_CHECKING:
+    from .Span import Span
+    from .User import User
 
 
 @strawberry.type
 class SpanAnnotation(Node, Annotation):
-    id_attr: NodeID[int]
-    user_id: Private[Optional[int]]
-    annotator_kind: AnnotatorKind
-    metadata: JSON
-    span_rowid: Private[Optional[int]]
-    source: AnnotationSource
-    identifier: str
+    id: NodeID[int]
+    db_record: strawberry.Private[Optional[models.SpanAnnotation]] = None
+
+    def __post_init__(self) -> None:
+        if self.db_record and self.id != self.db_record.id:
+            raise ValueError("SpanAnnotation ID mismatch")
+
+    @strawberry.field(description="Name of the annotation, e.g. 'helpfulness' or 'relevance'.")  # type: ignore
+    async def name(
+        self,
+        info: Info[Context, None],
+    ) -> str:
+        if self.db_record:
+            val = self.db_record.name
+        else:
+            val = await info.context.data_loaders.span_annotation_fields.load(
+                (self.id, models.SpanAnnotation.name),
+            )
+        return val
+
+    @strawberry.field(description="The kind of annotator that produced the annotation.")  # type: ignore
+    async def annotator_kind(
+        self,
+        info: Info[Context, None],
+    ) -> AnnotatorKind:
+        if self.db_record:
+            val = self.db_record.annotator_kind
+        else:
+            val = await info.context.data_loaders.span_annotation_fields.load(
+                (self.id, models.SpanAnnotation.annotator_kind),
+            )
+        return AnnotatorKind(val)
+
+    @strawberry.field(
+        description="Value of the annotation in the form of a string, e.g. "
+        "'helpful' or 'not helpful'. Note that the label is not necessarily binary."
+    )  # type: ignore
+    async def label(
+        self,
+        info: Info[Context, None],
+    ) -> Optional[str]:
+        if self.db_record:
+            val = self.db_record.label
+        else:
+            val = await info.context.data_loaders.span_annotation_fields.load(
+                (self.id, models.SpanAnnotation.label),
+            )
+        return val
+
+    @strawberry.field(
+        description="Value of the annotation in the form of a numeric score.",
+    )  # type: ignore
+    async def score(
+        self,
+        info: Info[Context, None],
+    ) -> Optional[float]:
+        if self.db_record:
+            val = self.db_record.score
+        else:
+            val = await info.context.data_loaders.span_annotation_fields.load(
+                (self.id, models.SpanAnnotation.score),
+            )
+        return val if val is not None and isfinite(val) else None
+
+    @strawberry.field(
+        description="The annotator's explanation for the annotation result (i.e. "
+        "score or label, or both) given to the subject."
+    )  # type: ignore
+    async def explanation(
+        self,
+        info: Info[Context, None],
+    ) -> Optional[str]:
+        if self.db_record:
+            val = self.db_record.explanation
+        else:
+            val = await info.context.data_loaders.span_annotation_fields.load(
+                (self.id, models.SpanAnnotation.explanation),
+            )
+        return val
+
+    @strawberry.field(description="Metadata about the annotation.")  # type: ignore
+    async def metadata(
+        self,
+        info: Info[Context, None],
+    ) -> JSON:
+        if self.db_record:
+            val = self.db_record.metadata_
+        else:
+            val = await info.context.data_loaders.span_annotation_fields.load(
+                (self.id, models.SpanAnnotation.metadata_),
+            )
+        return val
+
+    @strawberry.field(description="The source of the annotation.")  # type: ignore
+    async def source(
+        self,
+        info: Info[Context, None],
+    ) -> AnnotationSource:
+        if self.db_record:
+            val = self.db_record.source
+        else:
+            val = await info.context.data_loaders.span_annotation_fields.load(
+                (self.id, models.SpanAnnotation.source),
+            )
+        return AnnotationSource(val)
+
+    @strawberry.field(description="The identifier of the annotation.")  # type: ignore
+    async def identifier(
+        self,
+        info: Info[Context, None],
+    ) -> str:
+        if self.db_record:
+            val = self.db_record.identifier
+        else:
+            val = await info.context.data_loaders.span_annotation_fields.load(
+                (self.id, models.SpanAnnotation.identifier),
+            )
+        return val
+
+    @strawberry.field(description="The date and time when the annotation was created.")  # type: ignore
+    async def created_at(
+        self,
+        info: Info[Context, None],
+    ) -> datetime:
+        if self.db_record:
+            val = self.db_record.created_at
+        else:
+            val = await info.context.data_loaders.span_annotation_fields.load(
+                (self.id, models.SpanAnnotation.created_at),
+            )
+        return val
+
+    @strawberry.field(description="The date and time when the annotation was last updated.")  # type: ignore
+    async def updated_at(
+        self,
+        info: Info[Context, None],
+    ) -> datetime:
+        if self.db_record:
+            val = self.db_record.updated_at
+        else:
+            val = await info.context.data_loaders.span_annotation_fields.load(
+                (self.id, models.SpanAnnotation.updated_at),
+            )
+        return val
 
     @strawberry.field
-    async def span_id(self) -> GlobalID:
+    async def span_id(
+        self,
+        info: Info[Context, None],
+    ) -> GlobalID:
         from phoenix.server.api.types.Span import Span
 
-        return GlobalID(type_name=Span.__name__, node_id=str(self.span_rowid))
+        if self.db_record:
+            span_rowid = self.db_record.span_rowid
+        else:
+            span_rowid = await info.context.data_loaders.span_annotation_fields.load(
+                (self.id, models.SpanAnnotation.span_rowid),
+            )
+        return GlobalID(type_name=Span.__name__, node_id=str(span_rowid))
 
-    @strawberry.field
+    @strawberry.field(description="The span associated with the annotation.")  # type: ignore
+    async def span(
+        self,
+        info: Info[Context, None],
+    ) -> Annotated["Span", strawberry.lazy(".Span")]:
+        if self.db_record:
+            span_rowid = self.db_record.span_rowid
+        else:
+            span_rowid = await info.context.data_loaders.span_annotation_fields.load(
+                (self.id, models.SpanAnnotation.span_rowid),
+            )
+        from .Span import Span
+
+        return Span(id=span_rowid)
+
+    @strawberry.field(description="The user that produced the annotation.")  # type: ignore
     async def user(
         self,
         info: Info[Context, None],
-    ) -> Optional[User]:
-        if self.user_id is None:
+    ) -> Optional[Annotated["User", strawberry.lazy(".User")]]:
+        if self.db_record:
+            user_id = self.db_record.user_id
+        else:
+            user_id = await info.context.data_loaders.span_annotation_fields.load(
+                (self.id, models.SpanAnnotation.user_id),
+            )
+        if user_id is None:
             return None
-        user = await info.context.data_loaders.users.load(self.user_id)
-        if user is None:
-            return None
-        return to_gql_user(user)
-
-
-def to_gql_span_annotation(
-    annotation: models.SpanAnnotation,
-) -> SpanAnnotation:
-    """
-    Converts an ORM span annotation to a GraphQL SpanAnnotation.
-    """
-    return SpanAnnotation(
-        id_attr=annotation.id,
-        user_id=annotation.user_id,
-        span_rowid=annotation.span_rowid,
-        name=annotation.name,
-        annotator_kind=AnnotatorKind(annotation.annotator_kind),
-        label=annotation.label,
-        score=annotation.score,
-        explanation=annotation.explanation,
-        metadata=annotation.metadata_,
-        source=AnnotationSource(annotation.source),
-        identifier=annotation.identifier,
-        created_at=annotation.created_at,
-        updated_at=annotation.updated_at,
-    )
+        from .User import User
+
+        return User(id=user_id)

phoenix/server/api/types/SystemApiKey.py

@@ -1,9 +1,73 @@
+from datetime import datetime
+from typing import Optional
+
 import strawberry
 from strawberry.relay import Node, NodeID
+from strawberry.types import Info
+
+from phoenix.db.models import ApiKey as OrmApiKey
+from phoenix.server.api.context import Context
 
 from .ApiKey import ApiKey
 
 
 @strawberry.type
 class SystemApiKey(ApiKey, Node):
-    id_attr: NodeID[int]
+    id: NodeID[int]
+    db_record: strawberry.Private[Optional[OrmApiKey]] = None
+
+    def __post_init__(self) -> None:
+        if self.db_record and self.id != self.db_record.id:
+            raise ValueError("SystemApiKey ID mismatch")
+
+    @strawberry.field(description="Name of the API key.")  # type: ignore
+    async def name(
+        self,
+        info: Info[Context, None],
+    ) -> str:
+        if self.db_record:
+            val = self.db_record.name
+        else:
+            val = await info.context.data_loaders.user_api_key_fields.load(
+                (self.id, OrmApiKey.name),
+            )
+        return val
+
+    @strawberry.field(description="Description of the API key.")  # type: ignore
+    async def description(
+        self,
+        info: Info[Context, None],
+    ) -> Optional[str]:
+        if self.db_record:
+            val = self.db_record.description
+        else:
+            val = await info.context.data_loaders.user_api_key_fields.load(
+                (self.id, OrmApiKey.description),
+            )
+        return val
+
+    @strawberry.field(description="The date and time the API key was created.")  # type: ignore
+    async def created_at(
+        self,
+        info: Info[Context, None],
+    ) -> datetime:
+        if self.db_record:
+            val = self.db_record.created_at
+        else:
+            val = await info.context.data_loaders.user_api_key_fields.load(
+                (self.id, OrmApiKey.created_at),
+            )
+        return val
+
+    @strawberry.field(description="The date and time the API key will expire.")  # type: ignore
+    async def expires_at(
+        self,
+        info: Info[Context, None],
+    ) -> Optional[datetime]:
+        if self.db_record:
+            val = self.db_record.expires_at
+        else:
+            val = await info.context.data_loaders.user_api_key_fields.load(
+                (self.id, OrmApiKey.expires_at),
+            )
+        return val

phoenix/server/api/types/Trace.py

@@ -9,7 +9,7 @@ import pandas as pd
 import strawberry
 from openinference.semconv.trace import SpanAttributes
 from sqlalchemy import desc, select
-from strawberry import ID, UNSET, Private, lazy
+from strawberry import ID, UNSET, lazy
 from strawberry.relay import Connection, GlobalID, Node, NodeID
 from strawberry.types import Info
 from typing_extensions import TypeAlias
@@ -29,7 +29,7 @@ from phoenix.server.api.types.SortDir import SortDir
 from phoenix.server.api.types.Span import Span
 from phoenix.server.api.types.SpanCostDetailSummaryEntry import SpanCostDetailSummaryEntry
 from phoenix.server.api.types.SpanCostSummary import SpanCostSummary
-from phoenix.server.api.types.TraceAnnotation import TraceAnnotation, to_gql_trace_annotation
+from phoenix.server.api.types.TraceAnnotation import TraceAnnotation
 
 if TYPE_CHECKING:
     from phoenix.server.api.types.Project import Project
@@ -41,11 +41,11 @@ TraceRowId: TypeAlias = int
 
 @strawberry.type
 class Trace(Node):
-    trace_rowid: NodeID[TraceRowId]
-    db_trace: Private[models.Trace] = UNSET
+    id: NodeID[TraceRowId]
+    db_record: strawberry.Private[Optional[models.Trace]] = None
 
     def __post_init__(self) -> None:
-        if self.db_trace and self.trace_rowid != self.db_trace.id:
+        if self.db_record and self.id != self.db_record.id:
             raise ValueError("Trace ID mismatch")
 
     @strawberry.field
@@ -53,11 +53,11 @@ class Trace(Node):
         self,
         info: Info[Context, None],
     ) -> ID:
-        if self.db_trace:
-            trace_id = self.db_trace.trace_id
+        if self.db_record:
+            trace_id = self.db_record.trace_id
         else:
             trace_id = await info.context.data_loaders.trace_fields.load(
-                (self.trace_rowid, models.Trace.trace_id),
+                (self.id, models.Trace.trace_id),
             )
         return ID(trace_id)
 
@@ -66,11 +66,11 @@ class Trace(Node):
         self,
         info: Info[Context, None],
     ) -> datetime:
-        if self.db_trace:
-            start_time = self.db_trace.start_time
+        if self.db_record:
+            start_time = self.db_record.start_time
         else:
             start_time = await info.context.data_loaders.trace_fields.load(
-                (self.trace_rowid, models.Trace.start_time),
+                (self.id, models.Trace.start_time),
             )
         return start_time
 
@@ -79,11 +79,11 @@ class Trace(Node):
         self,
         info: Info[Context, None],
     ) -> datetime:
-        if self.db_trace:
-            end_time = self.db_trace.end_time
+        if self.db_record:
+            end_time = self.db_record.end_time
         else:
             end_time = await info.context.data_loaders.trace_fields.load(
-                (self.trace_rowid, models.Trace.end_time),
+                (self.id, models.Trace.end_time),
             )
         return end_time
 
@@ -92,11 +92,11 @@ class Trace(Node):
         self,
         info: Info[Context, None],
     ) -> Optional[float]:
-        if self.db_trace:
-            latency_ms = self.db_trace.latency_ms
+        if self.db_record:
+            latency_ms = self.db_record.latency_ms
         else:
             latency_ms = await info.context.data_loaders.trace_fields.load(
-                (self.trace_rowid, models.Trace.latency_ms),
+                (self.id, models.Trace.latency_ms),
             )
         return latency_ms
 
@@ -105,26 +105,26 @@ class Trace(Node):
         self,
         info: Info[Context, None],
     ) -> Annotated["Project", strawberry.lazy(".Project")]:
-        if self.db_trace:
-            project_rowid = self.db_trace.project_rowid
+        if self.db_record:
+            project_rowid = self.db_record.project_rowid
         else:
             project_rowid = await info.context.data_loaders.trace_fields.load(
-                (self.trace_rowid, models.Trace.project_rowid),
+                (self.id, models.Trace.project_rowid),
             )
         from phoenix.server.api.types.Project import Project
 
-        return Project(project_rowid=project_rowid)
+        return Project(id=project_rowid)
 
     @strawberry.field
     async def project_id(
         self,
         info: Info[Context, None],
     ) -> GlobalID:
-        if self.db_trace:
-            project_rowid = self.db_trace.project_rowid
+        if self.db_record:
+            project_rowid = self.db_record.project_rowid
         else:
             project_rowid = await info.context.data_loaders.trace_fields.load(
-                (self.trace_rowid, models.Trace.project_rowid),
+                (self.id, models.Trace.project_rowid),
             )
         from phoenix.server.api.types.Project import Project
 
@@ -135,11 +135,11 @@ class Trace(Node):
         self,
         info: Info[Context, None],
     ) -> Optional[GlobalID]:
-        if self.db_trace:
-            project_session_rowid = self.db_trace.project_session_rowid
+        if self.db_record:
+            project_session_rowid = self.db_record.project_session_rowid
         else:
             project_session_rowid = await info.context.data_loaders.trace_fields.load(
-                (self.trace_rowid, models.Trace.project_session_rowid),
+                (self.id, models.Trace.project_session_rowid),
             )
         if project_session_rowid is None:
             return None
@@ -152,39 +152,40 @@ class Trace(Node):
         self,
         info: Info[Context, None],
     ) -> Union[Annotated["ProjectSession", lazy(".ProjectSession")], None]:
-        if self.db_trace:
-            project_session_rowid = self.db_trace.project_session_rowid
+        if self.db_record:
+            project_session_rowid = self.db_record.project_session_rowid
         else:
             project_session_rowid = await info.context.data_loaders.trace_fields.load(
-                (self.trace_rowid, models.Trace.project_session_rowid),
+                (self.id, models.Trace.project_session_rowid),
             )
         if project_session_rowid is None:
             return None
-        from phoenix.server.api.types.ProjectSession import to_gql_project_session
 
         stmt = select(models.ProjectSession).filter_by(id=project_session_rowid)
         async with info.context.db() as session:
             project_session = await session.scalar(stmt)
         if project_session is None:
             return None
-        return to_gql_project_session(project_session)
+        from .ProjectSession import ProjectSession
+
+        return ProjectSession(id=project_session.id, db_record=project_session)
 
     @strawberry.field
     async def root_span(
         self,
         info: Info[Context, None],
     ) -> Optional[Span]:
-        span_rowid = await info.context.data_loaders.trace_root_spans.load(self.trace_rowid)
+        span_rowid = await info.context.data_loaders.trace_root_spans.load(self.id)
         if span_rowid is None:
             return None
-        return Span(span_rowid=span_rowid)
+        return Span(id=span_rowid)
 
     @strawberry.field
     async def num_spans(
         self,
         info: Info[Context, None],
     ) -> int:
-        return await info.context.data_loaders.num_spans_per_trace.load(self.trace_rowid)
+        return await info.context.data_loaders.num_spans_per_trace.load(self.id)
 
     @strawberry.field
     async def spans(
@@ -204,7 +205,7 @@ class Trace(Node):
         stmt = (
             select(models.Span.id)
             .join(models.Trace)
-            .where(models.Trace.id == self.trace_rowid)
+            .where(models.Trace.id == self.id)
             # Sort descending because the root span tends to show up later
             # in the ingestion process.
             .order_by(desc(models.Span.id))
@@ -212,7 +213,7 @@ class Trace(Node):
         )
         async with info.context.db() as session:
             span_rowids = await session.stream_scalars(stmt)
-            data = [Span(span_rowid=span_rowid) async for span_rowid in span_rowids]
+            data = [Span(id=span_rowid) async for span_rowid in span_rowids]
         return connection_from_list(data=data, args=args)
 
     @strawberry.field(description="Annotations associated with the trace.")  # type: ignore
@@ -222,7 +223,7 @@ class Trace(Node):
         sort: Optional[TraceAnnotationSort] = None,
     ) -> list[TraceAnnotation]:
         async with info.context.db() as session:
-            stmt = select(models.TraceAnnotation).filter_by(trace_rowid=self.trace_rowid)
+            stmt = select(models.TraceAnnotation).filter_by(trace_rowid=self.id)
             if sort:
                 sort_col = getattr(models.TraceAnnotation, sort.col.value)
                 if sort.dir is SortDir.desc:
@@ -232,7 +233,9 @@ class Trace(Node):
             else:
                 stmt = stmt.order_by(models.TraceAnnotation.created_at.desc())
             annotations = await session.scalars(stmt)
-        return [to_gql_trace_annotation(annotation) for annotation in annotations]
+        return [
+            TraceAnnotation(id=annotation.id, db_record=annotation) for annotation in annotations
+        ]
 
     @strawberry.field(description="Summarizes each annotation (by name) associated with the trace")  # type: ignore
     async def trace_annotation_summaries(
@@ -257,9 +260,7 @@ class Trace(Node):
             - data: A list of dictionaries with label statistics
         """
         # Load all annotations for this span from the data loader
-        annotations = await info.context.data_loaders.trace_annotations_by_trace.load(
-            self.trace_rowid
-        )
+        annotations = await info.context.data_loaders.trace_annotations_by_trace.load(self.id)
 
         # Apply filter if provided to narrow down the annotations
         if filter:
@@ -296,7 +297,7 @@ class Trace(Node):
         info: Info[Context, None],
     ) -> SpanCostSummary:
         loader = info.context.data_loaders.span_cost_summary_by_trace
-        summary = await loader.load(self.trace_rowid)
+        summary = await loader.load(self.id)
         return SpanCostSummary(
             prompt=CostBreakdown(
                 tokens=summary.prompt.tokens,
@@ -318,7 +319,7 @@ class Trace(Node):
         info: Info[Context, None],
     ) -> list[SpanCostDetailSummaryEntry]:
         loader = info.context.data_loaders.span_cost_detail_summary_entries_by_trace
-        entries = await loader.load(self.trace_rowid)
+        entries = await loader.load(self.id)
         return [
             SpanCostDetailSummaryEntry(
                 token_type=entry.token_type,