Skip to content

fix(dataset-run-items): correctly typ datasetRunItems.list #1242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hassiebp merged 1 commit into from
Jul 4, 2025
Merged

fix(dataset-run-items): correctly typ datasetRunItems.list #1242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 0 additions & 48 deletions langfuse/api/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1308,11 +1308,7 @@ List dataset run items
<dd>

```python
import datetime

from langfuse import DatasetRunItem, PaginatedDatasetRunItems
from langfuse.client import FernLangfuse
from langfuse.resources.utils import MetaResponse

client = FernLangfuse(
x_langfuse_sdk_name="YOUR_X_LANGFUSE_SDK_NAME",
Expand All @@ -1325,42 +1321,6 @@ client = FernLangfuse(
client.dataset_run_items.list(
dataset_id="datasetId",
run_name="runName",
response=PaginatedDatasetRunItems(
data=[
DatasetRunItem(
id="id",
dataset_run_id="datasetRunId",
dataset_run_name="datasetRunName",
dataset_item_id="datasetItemId",
trace_id="traceId",
created_at=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
updated_at=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
),
DatasetRunItem(
id="id",
dataset_run_id="datasetRunId",
dataset_run_name="datasetRunName",
dataset_item_id="datasetItemId",
trace_id="traceId",
created_at=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
updated_at=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
),
],
meta=MetaResponse(
page=1,
limit=1,
total_items=1,
total_pages=1,
),
),
)

```
Expand Down Expand Up @@ -1393,14 +1353,6 @@ client.dataset_run_items.list(
<dl>
<dd>

**response:** `PaginatedDatasetRunItems`

</dd>
</dl>

<dl>
<dd>

**page:** `typing.Optional[int]` — page number, starts at 1

</dd>
Expand Down
104 changes: 10 additions & 94 deletions langfuse/api/resources/dataset_run_items/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

from ...core.api_error import ApiError
from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ...core.jsonable_encoder import jsonable_encoder
from ...core.pydantic_utilities import pydantic_v1
from ...core.request_options import RequestOptions
from ..commons.errors.access_denied_error import AccessDeniedError
Expand Down Expand Up @@ -103,11 +102,10 @@ def list(
*,
dataset_id: str,
run_name: str,
response: PaginatedDatasetRunItems,
page: typing.Optional[int] = None,
limit: typing.Optional[int] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> None:
) -> PaginatedDatasetRunItems:
"""
List dataset run items

Expand All @@ -117,8 +115,6 @@ def list(

run_name : str

response : PaginatedDatasetRunItems

page : typing.Optional[int]
page number, starts at 1

Expand All @@ -130,15 +126,11 @@ def list(

Returns
-------
None
PaginatedDatasetRunItems

Examples
--------
import datetime

from langfuse import DatasetRunItem, PaginatedDatasetRunItems
from langfuse.client import FernLangfuse
from langfuse.resources.utils import MetaResponse

client = FernLangfuse(
x_langfuse_sdk_name="YOUR_X_LANGFUSE_SDK_NAME",
Expand All @@ -151,42 +143,6 @@ def list(
client.dataset_run_items.list(
dataset_id="datasetId",
run_name="runName",
response=PaginatedDatasetRunItems(
data=[
DatasetRunItem(
id="id",
dataset_run_id="datasetRunId",
dataset_run_name="datasetRunName",
dataset_item_id="datasetItemId",
trace_id="traceId",
created_at=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
updated_at=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
),
DatasetRunItem(
id="id",
dataset_run_id="datasetRunId",
dataset_run_name="datasetRunName",
dataset_item_id="datasetItemId",
trace_id="traceId",
created_at=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
updated_at=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
),
],
meta=MetaResponse(
page=1,
limit=1,
total_items=1,
total_pages=1,
),
),
)
"""
_response = self._client_wrapper.httpx_client.request(
Expand All @@ -197,13 +153,14 @@ def list(
"runName": run_name,
"page": page,
"limit": limit,
"response": jsonable_encoder(response),
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return
return pydantic_v1.parse_obj_as(
PaginatedDatasetRunItems, _response.json()
) # type: ignore
if _response.status_code == 400:
raise Error(pydantic_v1.parse_obj_as(typing.Any, _response.json())) # type: ignore
if _response.status_code == 401:
Expand Down Expand Up @@ -318,11 +275,10 @@ async def list(
*,
dataset_id: str,
run_name: str,
response: PaginatedDatasetRunItems,
page: typing.Optional[int] = None,
limit: typing.Optional[int] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> None:
) -> PaginatedDatasetRunItems:
"""
List dataset run items

Expand All @@ -332,8 +288,6 @@ async def list(

run_name : str

response : PaginatedDatasetRunItems

page : typing.Optional[int]
page number, starts at 1

Expand All @@ -345,16 +299,13 @@ async def list(

Returns
-------
None
PaginatedDatasetRunItems

Examples
--------
import asyncio
import datetime

from langfuse import DatasetRunItem, PaginatedDatasetRunItems
from langfuse.client import AsyncFernLangfuse
from langfuse.resources.utils import MetaResponse

client = AsyncFernLangfuse(
x_langfuse_sdk_name="YOUR_X_LANGFUSE_SDK_NAME",
Expand All @@ -370,42 +321,6 @@ async def main() -> None:
await client.dataset_run_items.list(
dataset_id="datasetId",
run_name="runName",
response=PaginatedDatasetRunItems(
data=[
DatasetRunItem(
id="id",
dataset_run_id="datasetRunId",
dataset_run_name="datasetRunName",
dataset_item_id="datasetItemId",
trace_id="traceId",
created_at=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
updated_at=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
),
DatasetRunItem(
id="id",
dataset_run_id="datasetRunId",
dataset_run_name="datasetRunName",
dataset_item_id="datasetItemId",
trace_id="traceId",
created_at=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
updated_at=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
),
],
meta=MetaResponse(
page=1,
limit=1,
total_items=1,
total_pages=1,
),
),
)


Expand All @@ -419,13 +334,14 @@ async def main() -> None:
"runName": run_name,
"page": page,
"limit": limit,
"response": jsonable_encoder(response),
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return
return pydantic_v1.parse_obj_as(
PaginatedDatasetRunItems, _response.json()
) # type: ignore
if _response.status_code == 400:
raise Error(pydantic_v1.parse_obj_as(typing.Any, _response.json())) # type: ignore
if _response.status_code == 401:
Expand Down