Skip to content

Commit fdfa5e6

Browse files
langfuse-botlangfuse-botwochinge
authored
feat(api): update API spec from langfuse/langfuse 8cdf8a4 (#1720)
* feat(api): update API spec from langfuse/langfuse 8cdf8a4 * test: update dataset item fixture --------- Co-authored-by: langfuse-bot <langfuse-bot@langfuse.com> Co-authored-by: Tobias Wochinger <tobias.wochinger@clickhouse.com>
1 parent 2791fda commit fdfa5e6

13 files changed

Lines changed: 281 additions & 37 deletions

‎langfuse/api/__init__.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,9 @@
8686
CreateScoreValue,
8787
Dataset,
8888
DatasetItem,
89+
DatasetItemMediaReference,
90+
DatasetItemMediaReferenceField,
91+
DatasetItemMediaReferenceMedia,
8992
DatasetRun,
9093
DatasetRunItem,
9194
DatasetRunWithItems,
@@ -396,6 +399,9 @@
396399
"CreateTextPromptType": ".prompts",
397400
"Dataset": ".commons",
398401
"DatasetItem": ".commons",
402+
"DatasetItemMediaReference": ".commons",
403+
"DatasetItemMediaReferenceField": ".commons",
404+
"DatasetItemMediaReferenceMedia": ".commons",
399405
"DatasetRun": ".commons",
400406
"DatasetRunItem": ".commons",
401407
"DatasetRunWithItems": ".commons",
@@ -717,6 +723,9 @@ def __dir__():
717723
"CreateTextPromptType",
718724
"Dataset",
719725
"DatasetItem",
726+
"DatasetItemMediaReference",
727+
"DatasetItemMediaReferenceField",
728+
"DatasetItemMediaReferenceMedia",
720729
"DatasetRun",
721730
"DatasetRunItem",
722731
"DatasetRunWithItems",

‎langfuse/api/commons/__init__.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020
CreateScoreValue,
2121
Dataset,
2222
DatasetItem,
23+
DatasetItemMediaReference,
24+
DatasetItemMediaReferenceField,
25+
DatasetItemMediaReferenceMedia,
2326
DatasetRun,
2427
DatasetRunItem,
2528
DatasetRunWithItems,
@@ -84,6 +87,9 @@
8487
"CreateScoreValue": ".types",
8588
"Dataset": ".types",
8689
"DatasetItem": ".types",
90+
"DatasetItemMediaReference": ".types",
91+
"DatasetItemMediaReferenceField": ".types",
92+
"DatasetItemMediaReferenceMedia": ".types",
8793
"DatasetRun": ".types",
8894
"DatasetRunItem": ".types",
8995
"DatasetRunWithItems": ".types",
@@ -174,6 +180,9 @@ def __dir__():
174180
"CreateScoreValue",
175181
"Dataset",
176182
"DatasetItem",
183+
"DatasetItemMediaReference",
184+
"DatasetItemMediaReferenceField",
185+
"DatasetItemMediaReferenceMedia",
177186
"DatasetRun",
178187
"DatasetRunItem",
179188
"DatasetRunWithItems",

‎langfuse/api/commons/types/__init__.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
from .create_score_value import CreateScoreValue
2020
from .dataset import Dataset
2121
from .dataset_item import DatasetItem
22+
from .dataset_item_media_reference import DatasetItemMediaReference
23+
from .dataset_item_media_reference_field import DatasetItemMediaReferenceField
24+
from .dataset_item_media_reference_media import DatasetItemMediaReferenceMedia
2225
from .dataset_run import DatasetRun
2326
from .dataset_run_item import DatasetRunItem
2427
from .dataset_run_with_items import DatasetRunWithItems
@@ -78,6 +81,9 @@
7881
"CreateScoreValue": ".create_score_value",
7982
"Dataset": ".dataset",
8083
"DatasetItem": ".dataset_item",
84+
"DatasetItemMediaReference": ".dataset_item_media_reference",
85+
"DatasetItemMediaReferenceField": ".dataset_item_media_reference_field",
86+
"DatasetItemMediaReferenceMedia": ".dataset_item_media_reference_media",
8187
"DatasetRun": ".dataset_run",
8288
"DatasetRunItem": ".dataset_run_item",
8389
"DatasetRunWithItems": ".dataset_run_with_items",
@@ -163,6 +169,9 @@ def __dir__():
163169
"CreateScoreValue",
164170
"Dataset",
165171
"DatasetItem",
172+
"DatasetItemMediaReference",
173+
"DatasetItemMediaReferenceField",
174+
"DatasetItemMediaReferenceMedia",
166175
"DatasetRun",
167176
"DatasetRunItem",
168177
"DatasetRunWithItems",

‎langfuse/api/commons/types/dataset_item.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
import typing_extensions
88
from ...core.pydantic_utilities import UniversalBaseModel
99
from ...core.serialization import FieldMetadata
10+
from .dataset_item_media_reference import DatasetItemMediaReference
1011
from .dataset_status import DatasetStatus
1112

1213

@@ -52,6 +53,12 @@ class DatasetItem(UniversalBaseModel):
5253
updated_at: typing_extensions.Annotated[
5354
dt.datetime, FieldMetadata(alias="updatedAt")
5455
]
56+
media_references: typing_extensions.Annotated[
57+
typing.List[DatasetItemMediaReference], FieldMetadata(alias="mediaReferences")
58+
] = pydantic.Field()
59+
"""
60+
Resolved Langfuse media references found in input, expectedOutput, and metadata.
61+
"""
5562

5663
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
5764
extra="allow", frozen=True
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# This file was auto-generated by Fern from our API Definition.
2+
3+
import typing
4+
5+
import pydantic
6+
import typing_extensions
7+
from ...core.pydantic_utilities import UniversalBaseModel
8+
from ...core.serialization import FieldMetadata
9+
from .dataset_item_media_reference_field import DatasetItemMediaReferenceField
10+
from .dataset_item_media_reference_media import DatasetItemMediaReferenceMedia
11+
12+
13+
class DatasetItemMediaReference(UniversalBaseModel):
14+
field: DatasetItemMediaReferenceField = pydantic.Field()
15+
"""
16+
The dataset item field containing the reference
17+
"""
18+
19+
reference_string: typing_extensions.Annotated[
20+
str, FieldMetadata(alias="referenceString")
21+
] = pydantic.Field()
22+
"""
23+
The Langfuse media reference string, e.g. `@@@langfuseMedia:type=image/png|id=...|source=bytes@@@`
24+
"""
25+
26+
json_path: typing_extensions.Annotated[str, FieldMetadata(alias="jsonPath")] = (
27+
pydantic.Field()
28+
)
29+
"""
30+
JSONPath of the string holding the reference within the field, e.g. `$['image']`
31+
"""
32+
33+
media: DatasetItemMediaReferenceMedia = pydantic.Field()
34+
"""
35+
The resolved media record.
36+
"""
37+
38+
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
39+
extra="allow", frozen=True
40+
)
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# This file was auto-generated by Fern from our API Definition.
2+
3+
import typing
4+
5+
from ...core import enum
6+
7+
T_Result = typing.TypeVar("T_Result")
8+
9+
10+
class DatasetItemMediaReferenceField(enum.StrEnum):
11+
INPUT = "input"
12+
EXPECTED_OUTPUT = "expectedOutput"
13+
METADATA = "metadata"
14+
15+
def visit(
16+
self,
17+
input: typing.Callable[[], T_Result],
18+
expected_output: typing.Callable[[], T_Result],
19+
metadata: typing.Callable[[], T_Result],
20+
) -> T_Result:
21+
if self is DatasetItemMediaReferenceField.INPUT:
22+
return input()
23+
if self is DatasetItemMediaReferenceField.EXPECTED_OUTPUT:
24+
return expected_output()
25+
if self is DatasetItemMediaReferenceField.METADATA:
26+
return metadata()
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# This file was auto-generated by Fern from our API Definition.
2+
3+
import typing
4+
5+
import pydantic
6+
import typing_extensions
7+
from ...core.pydantic_utilities import UniversalBaseModel
8+
from ...core.serialization import FieldMetadata
9+
10+
11+
class DatasetItemMediaReferenceMedia(UniversalBaseModel):
12+
media_id: typing_extensions.Annotated[str, FieldMetadata(alias="mediaId")] = (
13+
pydantic.Field()
14+
)
15+
"""
16+
The unique langfuse identifier of the media record
17+
"""
18+
19+
content_type: typing_extensions.Annotated[
20+
str, FieldMetadata(alias="contentType")
21+
] = pydantic.Field()
22+
"""
23+
The MIME type of the media record
24+
"""
25+
26+
content_length: typing_extensions.Annotated[
27+
int, FieldMetadata(alias="contentLength")
28+
] = pydantic.Field()
29+
"""
30+
The size of the media record in bytes
31+
"""
32+
33+
url: str = pydantic.Field()
34+
"""
35+
The signed download URL of the media record
36+
"""
37+
38+
url_expiry: typing_extensions.Annotated[str, FieldMetadata(alias="urlExpiry")] = (
39+
pydantic.Field()
40+
)
41+
"""
42+
The expiry date and time of the download URL
43+
"""
44+
45+
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
46+
extra="allow", frozen=True
47+
)

‎langfuse/api/media/client.py‎

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -138,22 +138,21 @@ def patch(
138138
def get_upload_url(
139139
self,
140140
*,
141-
trace_id: str,
142141
content_type: MediaContentType,
143142
content_length: int,
144143
sha256hash: str,
145144
field: str,
145+
trace_id: typing.Optional[str] = OMIT,
146146
observation_id: typing.Optional[str] = OMIT,
147+
dataset_id: typing.Optional[str] = OMIT,
148+
dataset_item_id: typing.Optional[str] = OMIT,
147149
request_options: typing.Optional[RequestOptions] = None,
148150
) -> GetMediaUploadUrlResponse:
149151
"""
150152
Get a presigned upload URL for a media record
151153
152154
Parameters
153155
----------
154-
trace_id : str
155-
The trace ID associated with the media record
156-
157156
content_type : MediaContentType
158157
159158
content_length : int
@@ -163,11 +162,20 @@ def get_upload_url(
163162
The SHA-256 hash of the media record
164163
165164
field : str
166-
The trace / observation field the media record is associated with. This can be one of `input`, `output`, `metadata`
165+
The item field the media is in: `input`/`output`/`metadata` (trace) or `input`/`expectedOutput`/`metadata` (dataset item).
166+
167+
trace_id : typing.Optional[str]
168+
The trace the media is associated with. Null for dataset item media uploads.
167169
168170
observation_id : typing.Optional[str]
169171
The observation ID associated with the media record. If the media record is associated directly with a trace, this will be null.
170172
173+
dataset_id : typing.Optional[str]
174+
The dataset the media belongs to. Null for trace/observation media uploads.
175+
176+
dataset_item_id : typing.Optional[str]
177+
The dataset item the media is associated with (need not exist yet). Null for trace/observation media uploads.
178+
171179
request_options : typing.Optional[RequestOptions]
172180
Request-specific configuration.
173181
@@ -189,20 +197,21 @@ def get_upload_url(
189197
base_url="https://yourhost.com/path/to/api",
190198
)
191199
client.media.get_upload_url(
192-
trace_id="traceId",
193200
content_type=MediaContentType.IMAGE_PNG,
194201
content_length=1,
195202
sha256hash="sha256Hash",
196203
field="field",
197204
)
198205
"""
199206
_response = self._raw_client.get_upload_url(
200-
trace_id=trace_id,
201207
content_type=content_type,
202208
content_length=content_length,
203209
sha256hash=sha256hash,
204210
field=field,
211+
trace_id=trace_id,
205212
observation_id=observation_id,
213+
dataset_id=dataset_id,
214+
dataset_item_id=dataset_item_id,
206215
request_options=request_options,
207216
)
208217
return _response.data
@@ -349,22 +358,21 @@ async def main() -> None:
349358
async def get_upload_url(
350359
self,
351360
*,
352-
trace_id: str,
353361
content_type: MediaContentType,
354362
content_length: int,
355363
sha256hash: str,
356364
field: str,
365+
trace_id: typing.Optional[str] = OMIT,
357366
observation_id: typing.Optional[str] = OMIT,
367+
dataset_id: typing.Optional[str] = OMIT,
368+
dataset_item_id: typing.Optional[str] = OMIT,
358369
request_options: typing.Optional[RequestOptions] = None,
359370
) -> GetMediaUploadUrlResponse:
360371
"""
361372
Get a presigned upload URL for a media record
362373
363374
Parameters
364375
----------
365-
trace_id : str
366-
The trace ID associated with the media record
367-
368376
content_type : MediaContentType
369377
370378
content_length : int
@@ -374,11 +382,20 @@ async def get_upload_url(
374382
The SHA-256 hash of the media record
375383
376384
field : str
377-
The trace / observation field the media record is associated with. This can be one of `input`, `output`, `metadata`
385+
The item field the media is in: `input`/`output`/`metadata` (trace) or `input`/`expectedOutput`/`metadata` (dataset item).
386+
387+
trace_id : typing.Optional[str]
388+
The trace the media is associated with. Null for dataset item media uploads.
378389
379390
observation_id : typing.Optional[str]
380391
The observation ID associated with the media record. If the media record is associated directly with a trace, this will be null.
381392
393+
dataset_id : typing.Optional[str]
394+
The dataset the media belongs to. Null for trace/observation media uploads.
395+
396+
dataset_item_id : typing.Optional[str]
397+
The dataset item the media is associated with (need not exist yet). Null for trace/observation media uploads.
398+
382399
request_options : typing.Optional[RequestOptions]
383400
Request-specific configuration.
384401
@@ -405,7 +422,6 @@ async def get_upload_url(
405422
406423
async def main() -> None:
407424
await client.media.get_upload_url(
408-
trace_id="traceId",
409425
content_type=MediaContentType.IMAGE_PNG,
410426
content_length=1,
411427
sha256hash="sha256Hash",
@@ -416,12 +432,14 @@ async def main() -> None:
416432
asyncio.run(main())
417433
"""
418434
_response = await self._raw_client.get_upload_url(
419-
trace_id=trace_id,
420435
content_type=content_type,
421436
content_length=content_length,
422437
sha256hash=sha256hash,
423438
field=field,
439+
trace_id=trace_id,
424440
observation_id=observation_id,
441+
dataset_id=dataset_id,
442+
dataset_item_id=dataset_item_id,
425443
request_options=request_options,
426444
)
427445
return _response.data

0 commit comments

Comments
 (0)