feat(scores): add support for TEXT scores

Author: wochinge

langfuse/api/.fern/metadata.json

@@ -1,5 +1,5 @@
 {
-  "cliVersion": "3.30.3",
+  "cliVersion": "3.88.0",
   "generatorName": "fernapi/fern-python-sdk",
   "generatorVersion": "4.46.2",
   "generatorConfig": {

langfuse/api/__init__.py

@@ -79,6 +79,7 @@
         CommentObjectType,
         ConfigCategory,
         CorrectionScore,
+        CreateScoreDataTypeV1,
         CreateScoreValue,
         Dataset,
         DatasetItem,
@@ -116,8 +117,10 @@
         Score_Categorical,
         Score_Correction,
         Score_Numeric,
+        Score_Text,
         Session,
         SessionWithTraces,
+        TextScore,
         Trace,
         TraceWithDetails,
         TraceWithFullDetails,
@@ -281,10 +284,12 @@
         GetScoresResponseDataCategorical,
         GetScoresResponseDataCorrection,
         GetScoresResponseDataNumeric,
+        GetScoresResponseDataText,
         GetScoresResponseData_Boolean,
         GetScoresResponseData_Categorical,
         GetScoresResponseData_Correction,
         GetScoresResponseData_Numeric,
+        GetScoresResponseData_Text,
         GetScoresResponseTraceData,
     )
     from .sessions import PaginatedSessions
@@ -347,6 +352,7 @@
     "CreateObservationEvent": ".ingestion",
     "CreatePromptRequest": ".prompts",
     "CreateScoreConfigRequest": ".score_configs",
+    "CreateScoreDataTypeV1": ".commons",
     "CreateScoreValue": ".commons",
     "CreateSpanBody": ".ingestion",
     "CreateSpanEvent": ".ingestion",
@@ -377,10 +383,12 @@
     "GetScoresResponseDataCategorical": ".scores",
     "GetScoresResponseDataCorrection": ".scores",
     "GetScoresResponseDataNumeric": ".scores",
+    "GetScoresResponseDataText": ".scores",
     "GetScoresResponseData_Boolean": ".scores",
     "GetScoresResponseData_Categorical": ".scores",
     "GetScoresResponseData_Correction": ".scores",
     "GetScoresResponseData_Numeric": ".scores",
+    "GetScoresResponseData_Text": ".scores",
     "GetScoresResponseTraceData": ".scores",
     "HealthResponse": ".health",
     "IngestionError": ".ingestion",
@@ -493,6 +501,7 @@
     "Score_Categorical": ".commons",
     "Score_Correction": ".commons",
     "Score_Numeric": ".commons",
+    "Score_Text": ".commons",
     "SdkLogBody": ".ingestion",
     "SdkLogEvent": ".ingestion",
     "ServiceProviderConfig": ".scim",
@@ -501,6 +510,7 @@
     "SessionWithTraces": ".commons",
     "Sort": ".trace",
     "TextPrompt": ".prompts",
+    "TextScore": ".commons",
     "Trace": ".commons",
     "TraceBody": ".ingestion",
     "TraceEvent": ".ingestion",
@@ -634,6 +644,7 @@ def __dir__():
     "CreateObservationEvent",
     "CreatePromptRequest",
     "CreateScoreConfigRequest",
+    "CreateScoreDataTypeV1",
     "CreateScoreValue",
     "CreateSpanBody",
     "CreateSpanEvent",
@@ -664,10 +675,12 @@ def __dir__():
     "GetScoresResponseDataCategorical",
     "GetScoresResponseDataCorrection",
     "GetScoresResponseDataNumeric",
+    "GetScoresResponseDataText",
     "GetScoresResponseData_Boolean",
     "GetScoresResponseData_Categorical",
     "GetScoresResponseData_Correction",
     "GetScoresResponseData_Numeric",
+    "GetScoresResponseData_Text",
     "GetScoresResponseTraceData",
     "HealthResponse",
     "IngestionError",
@@ -780,6 +793,7 @@ def __dir__():
     "Score_Categorical",
     "Score_Correction",
     "Score_Numeric",
+    "Score_Text",
     "SdkLogBody",
     "SdkLogEvent",
     "ServiceProviderConfig",
@@ -788,6 +802,7 @@ def __dir__():
     "SessionWithTraces",
     "Sort",
     "TextPrompt",
+    "TextScore",
     "Trace",
     "TraceBody",
     "TraceEvent",

langfuse/api/commons/__init__.py

@@ -17,6 +17,7 @@
         CommentObjectType,
         ConfigCategory,
         CorrectionScore,
+        CreateScoreDataTypeV1,
         CreateScoreValue,
         Dataset,
         DatasetItem,
@@ -51,8 +52,10 @@
         Score_Categorical,
         Score_Correction,
         Score_Numeric,
+        Score_Text,
         Session,
         SessionWithTraces,
+        TextScore,
         Trace,
         TraceWithDetails,
         TraceWithFullDetails,
@@ -77,6 +80,7 @@
     "CommentObjectType": ".types",
     "ConfigCategory": ".types",
     "CorrectionScore": ".types",
+    "CreateScoreDataTypeV1": ".types",
     "CreateScoreValue": ".types",
     "Dataset": ".types",
     "DatasetItem": ".types",
@@ -114,8 +118,10 @@
     "Score_Categorical": ".types",
     "Score_Correction": ".types",
     "Score_Numeric": ".types",
+    "Score_Text": ".types",
     "Session": ".types",
     "SessionWithTraces": ".types",
+    "TextScore": ".types",
     "Trace": ".types",
     "TraceWithDetails": ".types",
     "TraceWithFullDetails": ".types",
@@ -163,6 +169,7 @@ def __dir__():
     "CommentObjectType",
     "ConfigCategory",
     "CorrectionScore",
+    "CreateScoreDataTypeV1",
     "CreateScoreValue",
     "Dataset",
     "DatasetItem",
@@ -200,8 +207,10 @@ def __dir__():
     "Score_Categorical",
     "Score_Correction",
     "Score_Numeric",
+    "Score_Text",
     "Session",
     "SessionWithTraces",
+    "TextScore",
     "Trace",
     "TraceWithDetails",
     "TraceWithFullDetails",

langfuse/api/commons/types/__init__.py

@@ -16,6 +16,7 @@
     from .comment_object_type import CommentObjectType
     from .config_category import ConfigCategory
     from .correction_score import CorrectionScore
+    from .create_score_data_type_v1 import CreateScoreDataTypeV1
     from .create_score_value import CreateScoreValue
     from .dataset import Dataset
     from .dataset_item import DatasetItem
@@ -43,6 +44,7 @@
         Score_Categorical,
         Score_Correction,
         Score_Numeric,
+        Score_Text,
     )
     from .score_config import ScoreConfig
     from .score_config_data_type import ScoreConfigDataType
@@ -51,6 +53,7 @@
     from .score_v1 import ScoreV1, ScoreV1_Boolean, ScoreV1_Categorical, ScoreV1_Numeric
     from .session import Session
     from .session_with_traces import SessionWithTraces
+    from .text_score import TextScore
     from .trace import Trace
     from .trace_with_details import TraceWithDetails
     from .trace_with_full_details import TraceWithFullDetails
@@ -66,6 +69,7 @@
     "CommentObjectType": ".comment_object_type",
     "ConfigCategory": ".config_category",
     "CorrectionScore": ".correction_score",
+    "CreateScoreDataTypeV1": ".create_score_data_type_v1",
     "CreateScoreValue": ".create_score_value",
     "Dataset": ".dataset",
     "DatasetItem": ".dataset_item",
@@ -100,8 +104,10 @@
     "Score_Categorical": ".score",
     "Score_Correction": ".score",
     "Score_Numeric": ".score",
+    "Score_Text": ".score",
     "Session": ".session",
     "SessionWithTraces": ".session_with_traces",
+    "TextScore": ".text_score",
     "Trace": ".trace",
     "TraceWithDetails": ".trace_with_details",
     "TraceWithFullDetails": ".trace_with_full_details",
@@ -147,6 +153,7 @@ def __dir__():
     "CommentObjectType",
     "ConfigCategory",
     "CorrectionScore",
+    "CreateScoreDataTypeV1",
     "CreateScoreValue",
     "Dataset",
     "DatasetItem",
@@ -181,8 +188,10 @@ def __dir__():
     "Score_Categorical",
     "Score_Correction",
     "Score_Numeric",
+    "Score_Text",
     "Session",
     "SessionWithTraces",
+    "TextScore",
     "Trace",
     "TraceWithDetails",
     "TraceWithFullDetails",

langfuse/api/commons/types/create_score_data_type_v1.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...core import enum
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class CreateScoreDataTypeV1(enum.StrEnum):
+    NUMERIC = "NUMERIC"
+    BOOLEAN = "BOOLEAN"
+    CATEGORICAL = "CATEGORICAL"
+    CORRECTION = "CORRECTION"
+
+    def visit(
+        self,
+        numeric: typing.Callable[[], T_Result],
+        boolean: typing.Callable[[], T_Result],
+        categorical: typing.Callable[[], T_Result],
+        correction: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is CreateScoreDataTypeV1.NUMERIC:
+            return numeric()
+        if self is CreateScoreDataTypeV1.BOOLEAN:
+            return boolean()
+        if self is CreateScoreDataTypeV1.CATEGORICAL:
+            return categorical()
+        if self is CreateScoreDataTypeV1.CORRECTION:
+            return correction()

langfuse/api/commons/types/score.py

@@ -195,7 +195,54 @@ class Score_Correction(UniversalBaseModel):
     )
 
 
+class Score_Text(UniversalBaseModel):
+    data_type: typing_extensions.Annotated[
+        typing.Literal["TEXT"], FieldMetadata(alias="dataType")
+    ] = "TEXT"
+    string_value: typing_extensions.Annotated[str, FieldMetadata(alias="stringValue")]
+    id: str
+    trace_id: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="traceId")
+    ] = None
+    session_id: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="sessionId")
+    ] = None
+    observation_id: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="observationId")
+    ] = None
+    dataset_run_id: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="datasetRunId")
+    ] = None
+    name: str
+    source: ScoreSource
+    timestamp: dt.datetime
+    created_at: typing_extensions.Annotated[
+        dt.datetime, FieldMetadata(alias="createdAt")
+    ]
+    updated_at: typing_extensions.Annotated[
+        dt.datetime, FieldMetadata(alias="updatedAt")
+    ]
+    author_user_id: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="authorUserId")
+    ] = None
+    comment: typing.Optional[str] = None
+    metadata: typing.Any
+    config_id: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="configId")
+    ] = None
+    queue_id: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="queueId")
+    ] = None
+    environment: str
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
+        extra="allow", frozen=True
+    )
+
+
 Score = typing_extensions.Annotated[
-    typing.Union[Score_Numeric, Score_Categorical, Score_Boolean, Score_Correction],
+    typing.Union[
+        Score_Numeric, Score_Categorical, Score_Boolean, Score_Correction, Score_Text
+    ],
     pydantic.Field(discriminator="data_type"),
 ]

langfuse/api/commons/types/score_config_data_type.py

@@ -11,16 +11,20 @@ class ScoreConfigDataType(enum.StrEnum):
     NUMERIC = "NUMERIC"
     BOOLEAN = "BOOLEAN"
     CATEGORICAL = "CATEGORICAL"
+    TEXT = "TEXT"
 
     def visit(
         self,
         numeric: typing.Callable[[], T_Result],
         boolean: typing.Callable[[], T_Result],
         categorical: typing.Callable[[], T_Result],
+        text: typing.Callable[[], T_Result],
     ) -> T_Result:
         if self is ScoreConfigDataType.NUMERIC:
             return numeric()
         if self is ScoreConfigDataType.BOOLEAN:
             return boolean()
         if self is ScoreConfigDataType.CATEGORICAL:
             return categorical()
+        if self is ScoreConfigDataType.TEXT:
+            return text()

langfuse/api/commons/types/score_data_type.py

@@ -12,13 +12,15 @@ class ScoreDataType(enum.StrEnum):
     BOOLEAN = "BOOLEAN"
     CATEGORICAL = "CATEGORICAL"
     CORRECTION = "CORRECTION"
+    TEXT = "TEXT"
 
     def visit(
         self,
         numeric: typing.Callable[[], T_Result],
         boolean: typing.Callable[[], T_Result],
         categorical: typing.Callable[[], T_Result],
         correction: typing.Callable[[], T_Result],
+        text: typing.Callable[[], T_Result],
     ) -> T_Result:
         if self is ScoreDataType.NUMERIC:
             return numeric()
@@ -28,3 +30,5 @@ def visit(
             return categorical()
         if self is ScoreDataType.CORRECTION:
             return correction()
+        if self is ScoreDataType.TEXT:
+            return text()

langfuse/api/commons/types/text_score.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.serialization import FieldMetadata
+from .base_score import BaseScore
+
+
+class TextScore(BaseScore):
+    string_value: typing_extensions.Annotated[
+        str, FieldMetadata(alias="stringValue")
+    ] = pydantic.Field()
+    """
+    The text content of the score (1-500 characters)
+    """
+
+    model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
+        extra="allow", frozen=True
+    )