feat(api): update API spec from langfuse/langfuse f588e62

langfuse/api/__init__.py

@@ -305,7 +305,6 @@
         IngestionEvent_ObservationCreate,
         IngestionEvent_ObservationUpdate,
         IngestionEvent_ScoreCreate,
-        IngestionEvent_SdkLog,
         IngestionEvent_SpanCreate,
         IngestionEvent_SpanUpdate,
         IngestionEvent_TraceCreate,
@@ -320,8 +319,6 @@
         OptionalObservationBody,
         ScoreBody,
         ScoreEvent,
-        SdkLogBody,
-        SdkLogEvent,
         TraceBody,
         TraceEvent,
         UpdateEventBody,
@@ -671,7 +668,6 @@
     "IngestionEvent_ObservationCreate": ".ingestion",
     "IngestionEvent_ObservationUpdate": ".ingestion",
     "IngestionEvent_ScoreCreate": ".ingestion",
-    "IngestionEvent_SdkLog": ".ingestion",
     "IngestionEvent_SpanCreate": ".ingestion",
     "IngestionEvent_SpanUpdate": ".ingestion",
     "IngestionEvent_TraceCreate": ".ingestion",
@@ -822,8 +818,6 @@
     "Score_Correction": ".commons",
     "Score_Numeric": ".commons",
     "Score_Text": ".commons",
-    "SdkLogBody": ".ingestion",
-    "SdkLogEvent": ".ingestion",
     "ServiceProviderConfig": ".scim",
     "ServiceUnavailableError": ".health",
     "Session": ".commons",
@@ -1127,7 +1121,6 @@ def __dir__():
     "IngestionEvent_ObservationCreate",
     "IngestionEvent_ObservationUpdate",
     "IngestionEvent_ScoreCreate",
-    "IngestionEvent_SdkLog",
     "IngestionEvent_SpanCreate",
     "IngestionEvent_SpanUpdate",
     "IngestionEvent_TraceCreate",
@@ -1278,8 +1271,6 @@ def __dir__():
     "Score_Correction",
     "Score_Numeric",
     "Score_Text",
-    "SdkLogBody",
-    "SdkLogEvent",
     "ServiceProviderConfig",
     "ServiceUnavailableError",
     "Session",

langfuse/api/commons/types/base_score.py

@@ -61,7 +61,9 @@ class BaseScore(UniversalBaseModel):
     Comment on the score
     """
 
-    metadata: typing.Any = pydantic.Field()
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(
+        default=None
+    )
     """
     Metadata associated with the score
     """

langfuse/api/commons/types/base_score_v1.py

@@ -41,7 +41,9 @@ class BaseScoreV1(UniversalBaseModel):
     Comment on the score
     """
 
-    metadata: typing.Any = pydantic.Field()
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(
+        default=None
+    )
     """
     Metadata associated with the score
     """

langfuse/api/commons/types/dataset.py

@@ -23,14 +23,16 @@ class Dataset(UniversalBaseModel):
     """
 
     input_schema: typing_extensions.Annotated[
-        typing.Optional[typing.Any], FieldMetadata(alias="inputSchema")
+        typing.Optional[typing.Dict[str, typing.Any]],
+        FieldMetadata(alias="inputSchema"),
     ] = pydantic.Field(default=None)
     """
     JSON Schema for validating dataset item inputs
     """
 
     expected_output_schema: typing_extensions.Annotated[
-        typing.Optional[typing.Any], FieldMetadata(alias="expectedOutputSchema")
+        typing.Optional[typing.Dict[str, typing.Any]],
+        FieldMetadata(alias="expectedOutputSchema"),
     ] = pydantic.Field(default=None)
     """
     JSON Schema for validating dataset item expected outputs

langfuse/api/commons/types/observation.py

@@ -77,7 +77,9 @@ class Observation(UniversalBaseModel):
     The version of the observation
     """
 
-    metadata: typing.Any = pydantic.Field()
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(
+        default=None
+    )
     """
     Additional metadata of the observation
     """

langfuse/api/commons/types/observation_v2.py

@@ -152,7 +152,9 @@ class ObservationV2(UniversalBaseModel):
     The output data of the observation
     """
 
-    metadata: typing.Optional[typing.Any] = pydantic.Field(default=None)
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(
+        default=None
+    )
     """
     Additional metadata of the observation
     """

langfuse/api/commons/types/score.py

@@ -54,7 +54,7 @@ class Score_Numeric(Base):
         typing.Optional[str], FieldMetadata(alias="authorUserId")
     ] = None
     comment: typing.Optional[str] = None
-    metadata: typing.Any
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = None
     config_id: typing_extensions.Annotated[
         typing.Optional[str], FieldMetadata(alias="configId")
     ] = None
@@ -100,7 +100,7 @@ class Score_Categorical(Base):
         typing.Optional[str], FieldMetadata(alias="authorUserId")
     ] = None
     comment: typing.Optional[str] = None
-    metadata: typing.Any
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = None
     config_id: typing_extensions.Annotated[
         typing.Optional[str], FieldMetadata(alias="configId")
     ] = None
@@ -146,7 +146,7 @@ class Score_Boolean(Base):
         typing.Optional[str], FieldMetadata(alias="authorUserId")
     ] = None
     comment: typing.Optional[str] = None
-    metadata: typing.Any
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = None
     config_id: typing_extensions.Annotated[
         typing.Optional[str], FieldMetadata(alias="configId")
     ] = None
@@ -192,7 +192,7 @@ class Score_Correction(Base):
         typing.Optional[str], FieldMetadata(alias="authorUserId")
     ] = None
     comment: typing.Optional[str] = None
-    metadata: typing.Any
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = None
     config_id: typing_extensions.Annotated[
         typing.Optional[str], FieldMetadata(alias="configId")
     ] = None
@@ -237,7 +237,7 @@ class Score_Text(Base):
         typing.Optional[str], FieldMetadata(alias="authorUserId")
     ] = None
     comment: typing.Optional[str] = None
-    metadata: typing.Any
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = None
     config_id: typing_extensions.Annotated[
         typing.Optional[str], FieldMetadata(alias="configId")
     ] = None

langfuse/api/commons/types/score_v1.py

@@ -35,7 +35,7 @@ class ScoreV1_Numeric(UniversalBaseModel):
         typing.Optional[str], FieldMetadata(alias="authorUserId")
     ] = None
     comment: typing.Optional[str] = None
-    metadata: typing.Any
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = None
     config_id: typing_extensions.Annotated[
         typing.Optional[str], FieldMetadata(alias="configId")
     ] = None
@@ -73,7 +73,7 @@ class ScoreV1_Categorical(UniversalBaseModel):
         typing.Optional[str], FieldMetadata(alias="authorUserId")
     ] = None
     comment: typing.Optional[str] = None
-    metadata: typing.Any
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = None
     config_id: typing_extensions.Annotated[
         typing.Optional[str], FieldMetadata(alias="configId")
     ] = None
@@ -111,7 +111,7 @@ class ScoreV1_Boolean(UniversalBaseModel):
         typing.Optional[str], FieldMetadata(alias="authorUserId")
     ] = None
     comment: typing.Optional[str] = None
-    metadata: typing.Any
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = None
     config_id: typing_extensions.Annotated[
         typing.Optional[str], FieldMetadata(alias="configId")
     ] = None
@@ -148,7 +148,7 @@ class ScoreV1_Text(UniversalBaseModel):
         typing.Optional[str], FieldMetadata(alias="authorUserId")
     ] = None
     comment: typing.Optional[str] = None
-    metadata: typing.Any
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = None
     config_id: typing_extensions.Annotated[
         typing.Optional[str], FieldMetadata(alias="configId")
     ] = None

langfuse/api/commons/types/trace.py

@@ -59,9 +59,11 @@ class Trace(UniversalBaseModel):
     The user identifier associated with the trace
     """
 
-    metadata: typing.Optional[typing.Any] = pydantic.Field(default=None)
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(
+        default=None
+    )
     """
-    The metadata associated with the trace. Can be any JSON.
+    The metadata associated with the trace. Values can be any JSON; non-object metadata sent at ingestion is returned under the `metadata` key.
     """
 
     tags: typing.List[str] = pydantic.Field()

langfuse/api/evaluators/types/cursor_meta.py

@@ -3,13 +3,12 @@
 import typing
 
 import pydantic
-from ...core.pydantic_utilities import UniversalBaseModel
+from ...utils.pagination.types.cursor_meta_response import CursorMetaResponse
 
 
-class CursorMeta(UniversalBaseModel):
-    cursor: typing.Optional[str] = pydantic.Field(default=None)
+class CursorMeta(CursorMetaResponse):
     """
-    Opaque cursor for the next page. Omitted when there is no next page.
+    Cursor pagination metadata.
     """
 
     model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(

langfuse/api/experiments/client.py

@@ -47,7 +47,10 @@ def list(
         Parameters
         ----------
         from_start_time : dt.datetime
-            Retrieve only experiments on or after this datetime.
+            Required. Retrieve only experiments with events on or after this
+            datetime. A lower bound is required so the query stays fast on
+            large projects; pair it with `toStartTime` to select a specific
+            window.
 
         fields : typing.Optional[str]
             Comma-separated list of field groups to include. Available groups:
@@ -145,7 +148,10 @@ def list_items(
         Parameters
         ----------
         from_start_time : dt.datetime
-            Retrieve only experiment items started on or after this datetime.
+            Required. Retrieve only experiment items started on or after this
+            datetime. A lower bound is required so the query stays fast on
+            large projects; pair it with `toStartTime` to select a specific
+            window.
 
         fields : typing.Optional[str]
             Comma-separated list of field groups to include. Available groups:
@@ -263,7 +269,10 @@ async def list(
         Parameters
         ----------
         from_start_time : dt.datetime
-            Retrieve only experiments on or after this datetime.
+            Required. Retrieve only experiments with events on or after this
+            datetime. A lower bound is required so the query stays fast on
+            large projects; pair it with `toStartTime` to select a specific
+            window.
 
         fields : typing.Optional[str]
             Comma-separated list of field groups to include. Available groups:
@@ -368,7 +377,10 @@ async def list_items(
         Parameters
         ----------
         from_start_time : dt.datetime
-            Retrieve only experiment items started on or after this datetime.
+            Required. Retrieve only experiment items started on or after this
+            datetime. A lower bound is required so the query stays fast on
+            large projects; pair it with `toStartTime` to select a specific
+            window.
 
         fields : typing.Optional[str]
             Comma-separated list of field groups to include. Available groups:

langfuse/api/experiments/raw_client.py

@@ -45,7 +45,10 @@ def list(
         Parameters
         ----------
         from_start_time : dt.datetime
-            Retrieve only experiments on or after this datetime.
+            Required. Retrieve only experiments with events on or after this
+            datetime. A lower bound is required so the query stays fast on
+            large projects; pair it with `toStartTime` to select a specific
+            window.
 
         fields : typing.Optional[str]
             Comma-separated list of field groups to include. Available groups:
@@ -205,7 +208,10 @@ def list_items(
         Parameters
         ----------
         from_start_time : dt.datetime
-            Retrieve only experiment items started on or after this datetime.
+            Required. Retrieve only experiment items started on or after this
+            datetime. A lower bound is required so the query stays fast on
+            large projects; pair it with `toStartTime` to select a specific
+            window.
 
         fields : typing.Optional[str]
             Comma-separated list of field groups to include. Available groups:
@@ -374,7 +380,10 @@ async def list(
         Parameters
         ----------
         from_start_time : dt.datetime
-            Retrieve only experiments on or after this datetime.
+            Required. Retrieve only experiments with events on or after this
+            datetime. A lower bound is required so the query stays fast on
+            large projects; pair it with `toStartTime` to select a specific
+            window.
 
         fields : typing.Optional[str]
             Comma-separated list of field groups to include. Available groups:
@@ -534,7 +543,10 @@ async def list_items(
         Parameters
         ----------
         from_start_time : dt.datetime
-            Retrieve only experiment items started on or after this datetime.
+            Required. Retrieve only experiment items started on or after this
+            datetime. A lower bound is required so the query stays fast on
+            large projects; pair it with `toStartTime` to select a specific
+            window.
 
         fields : typing.Optional[str]
             Comma-separated list of field groups to include. Available groups:

langfuse/api/experiments/types/experiments_response_meta.py

@@ -3,13 +3,12 @@
 import typing
 
 import pydantic
-from ...core.pydantic_utilities import UniversalBaseModel
+from ...utils.pagination.types.cursor_meta_response import CursorMetaResponse
 
 
-class ExperimentsResponseMeta(UniversalBaseModel):
-    cursor: typing.Optional[str] = pydantic.Field(default=None)
+class ExperimentsResponseMeta(CursorMetaResponse):
     """
-    Versioned base64url cursor for retrieving the next page. Absent when there are no more results.
+    Metadata for cursor-based pagination.
     """
 
     model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(

langfuse/api/ingestion/__init__.py

@@ -23,7 +23,6 @@
         IngestionEvent_ObservationCreate,
         IngestionEvent_ObservationUpdate,
         IngestionEvent_ScoreCreate,
-        IngestionEvent_SdkLog,
         IngestionEvent_SpanCreate,
         IngestionEvent_SpanUpdate,
         IngestionEvent_TraceCreate,
@@ -38,8 +37,6 @@
         OptionalObservationBody,
         ScoreBody,
         ScoreEvent,
-        SdkLogBody,
-        SdkLogEvent,
         TraceBody,
         TraceEvent,
         UpdateEventBody,
@@ -67,7 +64,6 @@
     "IngestionEvent_ObservationCreate": ".types",
     "IngestionEvent_ObservationUpdate": ".types",
     "IngestionEvent_ScoreCreate": ".types",
-    "IngestionEvent_SdkLog": ".types",
     "IngestionEvent_SpanCreate": ".types",
     "IngestionEvent_SpanUpdate": ".types",
     "IngestionEvent_TraceCreate": ".types",
@@ -82,8 +78,6 @@
     "OptionalObservationBody": ".types",
     "ScoreBody": ".types",
     "ScoreEvent": ".types",
-    "SdkLogBody": ".types",
-    "SdkLogEvent": ".types",
     "TraceBody": ".types",
     "TraceEvent": ".types",
     "UpdateEventBody": ".types",
@@ -140,7 +134,6 @@ def __dir__():
     "IngestionEvent_ObservationCreate",
     "IngestionEvent_ObservationUpdate",
     "IngestionEvent_ScoreCreate",
-    "IngestionEvent_SdkLog",
     "IngestionEvent_SpanCreate",
     "IngestionEvent_SpanUpdate",
     "IngestionEvent_TraceCreate",
@@ -155,8 +148,6 @@ def __dir__():
     "OptionalObservationBody",
     "ScoreBody",
     "ScoreEvent",
-    "SdkLogBody",
-    "SdkLogEvent",
     "TraceBody",
     "TraceEvent",
     "UpdateEventBody",