Skip to content

Commit 32ee150

Browse files
authored
fix(client): add metadata parameter to score_current_span and score_current_trace (#1501)
Added optional metadata parameter to both score_current_span and score_current_trace methods to allow attaching additional context to scores. This brings these convenience methods to feature parity with the underlying create_score method which already supports metadata. Changes: - Added metadata parameter to all overloads of score_current_span - Added metadata parameter to all overloads of score_current_trace - Updated docstrings with metadata parameter documentation - Updated examples to demonstrate metadata usage - Passed metadata parameter through to create_score calls
1 parent 4caab4b commit 32ee150

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

langfuse/_client/client.py

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2108,6 +2108,7 @@ def score_current_span(
21082108
data_type: Optional[Literal["NUMERIC", "BOOLEAN"]] = None,
21092109
comment: Optional[str] = None,
21102110
config_id: Optional[str] = None,
2111+
metadata: Optional[Any] = None,
21112112
) -> None: ...
21122113

21132114
@overload
@@ -2120,6 +2121,7 @@ def score_current_span(
21202121
data_type: Optional[Literal["CATEGORICAL"]] = "CATEGORICAL",
21212122
comment: Optional[str] = None,
21222123
config_id: Optional[str] = None,
2124+
metadata: Optional[Any] = None,
21232125
) -> None: ...
21242126

21252127
def score_current_span(
@@ -2131,6 +2133,7 @@ def score_current_span(
21312133
data_type: Optional[ScoreDataType] = None,
21322134
comment: Optional[str] = None,
21332135
config_id: Optional[str] = None,
2136+
metadata: Optional[Any] = None,
21342137
) -> None:
21352138
"""Create a score for the current active span.
21362139
@@ -2144,6 +2147,7 @@ def score_current_span(
21442147
data_type: Type of score (NUMERIC, BOOLEAN, or CATEGORICAL)
21452148
comment: Optional comment or explanation for the score
21462149
config_id: Optional ID of a score config defined in Langfuse
2150+
metadata: Optional metadata to be attached to the score
21472151
21482152
Example:
21492153
```python
@@ -2157,7 +2161,8 @@ def score_current_span(
21572161
name="relevance",
21582162
value=0.85,
21592163
data_type="NUMERIC",
2160-
comment="Mostly relevant but contains some tangential information"
2164+
comment="Mostly relevant but contains some tangential information",
2165+
metadata={"model": "gpt-4", "prompt_version": "v2"}
21612166
)
21622167
```
21632168
"""
@@ -2180,6 +2185,7 @@ def score_current_span(
21802185
data_type=cast(Literal["CATEGORICAL"], data_type),
21812186
comment=comment,
21822187
config_id=config_id,
2188+
metadata=metadata,
21832189
)
21842190

21852191
@overload
@@ -2192,6 +2198,7 @@ def score_current_trace(
21922198
data_type: Optional[Literal["NUMERIC", "BOOLEAN"]] = None,
21932199
comment: Optional[str] = None,
21942200
config_id: Optional[str] = None,
2201+
metadata: Optional[Any] = None,
21952202
) -> None: ...
21962203

21972204
@overload
@@ -2204,6 +2211,7 @@ def score_current_trace(
22042211
data_type: Optional[Literal["CATEGORICAL"]] = "CATEGORICAL",
22052212
comment: Optional[str] = None,
22062213
config_id: Optional[str] = None,
2214+
metadata: Optional[Any] = None,
22072215
) -> None: ...
22082216

22092217
def score_current_trace(
@@ -2215,6 +2223,7 @@ def score_current_trace(
22152223
data_type: Optional[ScoreDataType] = None,
22162224
comment: Optional[str] = None,
22172225
config_id: Optional[str] = None,
2226+
metadata: Optional[Any] = None,
22182227
) -> None:
22192228
"""Create a score for the current trace.
22202229
@@ -2229,6 +2238,7 @@ def score_current_trace(
22292238
data_type: Type of score (NUMERIC, BOOLEAN, or CATEGORICAL)
22302239
comment: Optional comment or explanation for the score
22312240
config_id: Optional ID of a score config defined in Langfuse
2241+
metadata: Optional metadata to be attached to the score
22322242
22332243
Example:
22342244
```python
@@ -2242,7 +2252,8 @@ def score_current_trace(
22422252
name="overall_quality",
22432253
value=0.95,
22442254
data_type="NUMERIC",
2245-
comment="High quality end-to-end response"
2255+
comment="High quality end-to-end response",
2256+
metadata={"evaluator": "gpt-4", "criteria": "comprehensive"}
22462257
)
22472258
```
22482259
"""
@@ -2263,6 +2274,7 @@ def score_current_trace(
22632274
data_type=cast(Literal["CATEGORICAL"], data_type),
22642275
comment=comment,
22652276
config_id=config_id,
2277+
metadata=metadata,
22662278
)
22672279

22682280
def flush(self) -> None:

0 commit comments

Comments
 (0)