feat(api): update API spec from langfuse/langfuse 7955a3e

langfuse/api/__init__.py

@@ -95,6 +95,7 @@
         DatasetRunItem,
         DatasetRunWithItems,
         DatasetStatus,
+        Deprecation,
         Error,
         MapValue,
         MethodNotAllowedError,
@@ -108,6 +109,7 @@
         ObservationLevel,
         ObservationV2,
         ObservationsView,
+        ObservationsViewSingle,
         PricingTier,
         PricingTierCondition,
         PricingTierInput,
@@ -423,6 +425,7 @@
     "DeleteLlmConnectionResponse": ".llm_connections",
     "DeleteMembershipRequest": ".organizations",
     "DeleteTraceResponse": ".trace",
+    "Deprecation": ".commons",
     "EmptyResponse": ".scim",
     "Error": ".commons",
     "Experiment": ".experiments",
@@ -493,6 +496,7 @@
     "ObservationsV2Meta": ".observations",
     "ObservationsV2Response": ".observations",
     "ObservationsView": ".commons",
+    "ObservationsViewSingle": ".commons",
     "OpenAiCompletionUsageSchema": ".ingestion",
     "OpenAiResponseUsageSchema": ".ingestion",
     "OpenAiUsage": ".ingestion",
@@ -754,6 +758,7 @@ def __dir__():
     "DeleteLlmConnectionResponse",
     "DeleteMembershipRequest",
     "DeleteTraceResponse",
+    "Deprecation",
     "EmptyResponse",
     "Error",
     "Experiment",
@@ -824,6 +829,7 @@ def __dir__():
     "ObservationsV2Meta",
     "ObservationsV2Response",
     "ObservationsView",
+    "ObservationsViewSingle",
     "OpenAiCompletionUsageSchema",
     "OpenAiResponseUsageSchema",
     "OpenAiUsage",

langfuse/api/commons/__init__.py

@@ -27,6 +27,7 @@
         DatasetRunItem,
         DatasetRunWithItems,
         DatasetStatus,
+        Deprecation,
         MapValue,
         Model,
         ModelPrice,
@@ -37,6 +38,7 @@
         ObservationLevel,
         ObservationV2,
         ObservationsView,
+        ObservationsViewSingle,
         PricingTier,
         PricingTierCondition,
         PricingTierInput,
@@ -94,6 +96,7 @@
     "DatasetRunItem": ".types",
     "DatasetRunWithItems": ".types",
     "DatasetStatus": ".types",
+    "Deprecation": ".types",
     "Error": ".errors",
     "MapValue": ".types",
     "MethodNotAllowedError": ".errors",
@@ -107,6 +110,7 @@
     "ObservationLevel": ".types",
     "ObservationV2": ".types",
     "ObservationsView": ".types",
+    "ObservationsViewSingle": ".types",
     "PricingTier": ".types",
     "PricingTierCondition": ".types",
     "PricingTierInput": ".types",
@@ -187,6 +191,7 @@ def __dir__():
     "DatasetRunItem",
     "DatasetRunWithItems",
     "DatasetStatus",
+    "Deprecation",
     "Error",
     "MapValue",
     "MethodNotAllowedError",
@@ -200,6 +205,7 @@ def __dir__():
     "ObservationLevel",
     "ObservationV2",
     "ObservationsView",
+    "ObservationsViewSingle",
     "PricingTier",
     "PricingTierCondition",
     "PricingTierInput",

langfuse/api/commons/types/__init__.py

@@ -26,6 +26,7 @@
     from .dataset_run_item import DatasetRunItem
     from .dataset_run_with_items import DatasetRunWithItems
     from .dataset_status import DatasetStatus
+    from .deprecation import Deprecation
     from .map_value import MapValue
     from .model import Model
     from .model_price import ModelPrice
@@ -36,6 +37,7 @@
     from .observation_level import ObservationLevel
     from .observation_v2 import ObservationV2
     from .observations_view import ObservationsView
+    from .observations_view_single import ObservationsViewSingle
     from .pricing_tier import PricingTier
     from .pricing_tier_condition import PricingTierCondition
     from .pricing_tier_input import PricingTierInput
@@ -88,6 +90,7 @@
     "DatasetRunItem": ".dataset_run_item",
     "DatasetRunWithItems": ".dataset_run_with_items",
     "DatasetStatus": ".dataset_status",
+    "Deprecation": ".deprecation",
     "MapValue": ".map_value",
     "Model": ".model",
     "ModelPrice": ".model_price",
@@ -98,6 +101,7 @@
     "ObservationLevel": ".observation_level",
     "ObservationV2": ".observation_v2",
     "ObservationsView": ".observations_view",
+    "ObservationsViewSingle": ".observations_view_single",
     "PricingTier": ".pricing_tier",
     "PricingTierCondition": ".pricing_tier_condition",
     "PricingTierInput": ".pricing_tier_input",
@@ -176,6 +180,7 @@ def __dir__():
     "DatasetRunItem",
     "DatasetRunWithItems",
     "DatasetStatus",
+    "Deprecation",
     "MapValue",
     "Model",
     "ModelPrice",
@@ -186,6 +191,7 @@ def __dir__():
     "ObservationLevel",
     "ObservationV2",
     "ObservationsView",
+    "ObservationsViewSingle",
     "PricingTier",
     "PricingTierCondition",
     "PricingTierInput",

langfuse/api/commons/types/dataset_run_with_items.py

@@ -7,12 +7,16 @@
 from ...core.serialization import FieldMetadata
 from .dataset_run import DatasetRun
 from .dataset_run_item import DatasetRunItem
+from .deprecation import Deprecation
 
 
 class DatasetRunWithItems(DatasetRun):
     dataset_run_items: typing_extensions.Annotated[
         typing.List[DatasetRunItem], FieldMetadata(alias="datasetRunItems")
     ]
+    deprecation: typing_extensions.Annotated[
+        typing.Optional[Deprecation], FieldMetadata(alias="_deprecation")
+    ] = None
 
     model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
         extra="allow", frozen=True

langfuse/api/commons/types/deprecation.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class Deprecation(UniversalBaseModel):
+    """
+    Migration signal returned by deprecated endpoints. Optional fields are omitted when they have no value.
+    """
+
+    message: str = pydantic.Field()
+    """
+    Human- and agent-readable summary of the deprecation and its replacement.
+    """
+
+    replacement: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The replacement endpoint, e.g. "GET /api/public/v2/observations". Omitted when the endpoint is being removed without a direct replacement.
+    """
+
+    docs_url: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="docsUrl")
+    ] = pydantic.Field(default=None)
+    """
+    Link to the migration documentation (markdown), when available.
+    """
+
+    sunset_at: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="sunsetAt")
+    ] = pydantic.Field(default=None)
+    """
+    ISO date after which the endpoint may stop working, when a removal date is committed.
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
+        extra="allow", frozen=True
+    )

langfuse/api/commons/types/observations_view_single.py

@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.serialization import FieldMetadata
+from .deprecation import Deprecation
+from .observations_view import ObservationsView
+
+
+class ObservationsViewSingle(ObservationsView):
+    deprecation: typing_extensions.Annotated[
+        typing.Optional[Deprecation], FieldMetadata(alias="_deprecation")
+    ] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
+        extra="allow", frozen=True
+    )

langfuse/api/commons/types/score.py

@@ -9,10 +9,21 @@
 import typing_extensions
 from ...core.pydantic_utilities import UniversalBaseModel
 from ...core.serialization import FieldMetadata
+from .deprecation import Deprecation
 from .score_source import ScoreSource
 
 
-class Score_Numeric(UniversalBaseModel):
+class Base(UniversalBaseModel):
+    deprecation: typing_extensions.Annotated[
+        typing.Optional[Deprecation], FieldMetadata(alias="_deprecation")
+    ] = None
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
+        extra="allow", frozen=True
+    )
+
+
+class Score_Numeric(Base):
     data_type: typing_extensions.Annotated[
         typing.Literal["NUMERIC"], FieldMetadata(alias="dataType")
     ] = "NUMERIC"
@@ -57,7 +68,7 @@ class Score_Numeric(UniversalBaseModel):
     )
 
 
-class Score_Categorical(UniversalBaseModel):
+class Score_Categorical(Base):
     data_type: typing_extensions.Annotated[
         typing.Literal["CATEGORICAL"], FieldMetadata(alias="dataType")
     ] = "CATEGORICAL"
@@ -103,7 +114,7 @@ class Score_Categorical(UniversalBaseModel):
     )
 
 
-class Score_Boolean(UniversalBaseModel):
+class Score_Boolean(Base):
     data_type: typing_extensions.Annotated[
         typing.Literal["BOOLEAN"], FieldMetadata(alias="dataType")
     ] = "BOOLEAN"
@@ -149,7 +160,7 @@ class Score_Boolean(UniversalBaseModel):
     )
 
 
-class Score_Correction(UniversalBaseModel):
+class Score_Correction(Base):
     data_type: typing_extensions.Annotated[
         typing.Literal["CORRECTION"], FieldMetadata(alias="dataType")
     ] = "CORRECTION"
@@ -195,7 +206,7 @@ class Score_Correction(UniversalBaseModel):
     )
 
 
-class Score_Text(UniversalBaseModel):
+class Score_Text(Base):
     data_type: typing_extensions.Annotated[
         typing.Literal["TEXT"], FieldMetadata(alias="dataType")
     ] = "TEXT"

langfuse/api/commons/types/session_with_traces.py

@@ -3,12 +3,18 @@
 import typing
 
 import pydantic
+import typing_extensions
+from ...core.serialization import FieldMetadata
+from .deprecation import Deprecation
 from .session import Session
 from .trace import Trace
 
 
 class SessionWithTraces(Session):
     traces: typing.List[Trace]
+    deprecation: typing_extensions.Annotated[
+        typing.Optional[Deprecation], FieldMetadata(alias="_deprecation")
+    ] = None
 
     model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
         extra="allow", frozen=True

langfuse/api/commons/types/trace_with_full_details.py

@@ -5,6 +5,7 @@
 import pydantic
 import typing_extensions
 from ...core.serialization import FieldMetadata
+from .deprecation import Deprecation
 from .observations_view import ObservationsView
 from .score_v1 import ScoreV1
 from .trace import Trace
@@ -40,6 +41,10 @@ class TraceWithFullDetails(Trace):
     List of scores
     """
 
+    deprecation: typing_extensions.Annotated[
+        typing.Optional[Deprecation], FieldMetadata(alias="_deprecation")
+    ] = None
+
     model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
         extra="allow", frozen=True
     )

langfuse/api/dataset_run_items/types/paginated_dataset_run_items.py

@@ -3,14 +3,20 @@
 import typing
 
 import pydantic
+import typing_extensions
 from ...commons.types.dataset_run_item import DatasetRunItem
+from ...commons.types.deprecation import Deprecation
 from ...core.pydantic_utilities import UniversalBaseModel
+from ...core.serialization import FieldMetadata
 from ...utils.pagination.types.meta_response import MetaResponse
 
 
 class PaginatedDatasetRunItems(UniversalBaseModel):
     data: typing.List[DatasetRunItem]
     meta: MetaResponse
+    deprecation: typing_extensions.Annotated[
+        typing.Optional[Deprecation], FieldMetadata(alias="_deprecation")
+    ] = None
 
     model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
         extra="allow", frozen=True

langfuse/api/datasets/types/paginated_dataset_runs.py

@@ -3,14 +3,20 @@
 import typing
 
 import pydantic
+import typing_extensions
 from ...commons.types.dataset_run import DatasetRun
+from ...commons.types.deprecation import Deprecation
 from ...core.pydantic_utilities import UniversalBaseModel
+from ...core.serialization import FieldMetadata
 from ...utils.pagination.types.meta_response import MetaResponse
 
 
 class PaginatedDatasetRuns(UniversalBaseModel):
     data: typing.List[DatasetRun]
     meta: MetaResponse
+    deprecation: typing_extensions.Annotated[
+        typing.Optional[Deprecation], FieldMetadata(alias="_deprecation")
+    ] = None
 
     model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
         extra="allow", frozen=True

langfuse/api/legacy/metrics_v1/types/metrics_response.py

@@ -3,7 +3,10 @@
 import typing
 
 import pydantic
+import typing_extensions
+from ....commons.types.deprecation import Deprecation
 from ....core.pydantic_utilities import UniversalBaseModel
+from ....core.serialization import FieldMetadata
 
 
 class MetricsResponse(UniversalBaseModel):
@@ -14,6 +17,10 @@ class MetricsResponse(UniversalBaseModel):
     Histograms will return an array with [lower, upper, height] tuples.
     """
 
+    deprecation: typing_extensions.Annotated[
+        typing.Optional[Deprecation], FieldMetadata(alias="_deprecation")
+    ] = None
+
     model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
         extra="allow", frozen=True
     )