langfuse-client-base 0.12.0

Auto-generated Langfuse API client from OpenAPI specification
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

# \DatasetItemsApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**dataset_items_create**](DatasetItemsApi.md#dataset_items_create) | **POST** /api/public/dataset-items | 
[**dataset_items_delete**](DatasetItemsApi.md#dataset_items_delete) | **DELETE** /api/public/dataset-items/{id} | 
[**dataset_items_get**](DatasetItemsApi.md#dataset_items_get) | **GET** /api/public/dataset-items/{id} | 
[**dataset_items_list**](DatasetItemsApi.md#dataset_items_list) | **GET** /api/public/dataset-items | 



## dataset_items_create

> models::DatasetItem dataset_items_create(create_dataset_item_request)


Create a dataset item

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_dataset_item_request** | [**CreateDatasetItemRequest**](CreateDatasetItemRequest.md) |  | [required] |

### Return type

[**models::DatasetItem**](DatasetItem.md)

### Authorization

[BasicAuth](../README.md#BasicAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## dataset_items_delete

> models::DeleteDatasetItemResponse dataset_items_delete(id)


Delete a dataset item and all its run items. This action is irreversible.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** |  | [required] |

### Return type

[**models::DeleteDatasetItemResponse**](DeleteDatasetItemResponse.md)

### Authorization

[BasicAuth](../README.md#BasicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## dataset_items_get

> models::DatasetItem dataset_items_get(id)


Get a dataset item

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** |  | [required] |

### Return type

[**models::DatasetItem**](DatasetItem.md)

### Authorization

[BasicAuth](../README.md#BasicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## dataset_items_list

> models::PaginatedDatasetItems dataset_items_list(dataset_name, source_trace_id, source_observation_id, version, page, limit)


Get dataset items. Optionally specify a version to get the items as they existed at that point in time. Note: If version parameter is provided, datasetName must also be provided.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**dataset_name** | Option<**String**> |  |  |
**source_trace_id** | Option<**String**> |  |  |
**source_observation_id** | Option<**String**> |  |  |
**version** | Option<**String**> | ISO 8601 timestamp (RFC 3339, Section 5.6) in UTC (e.g., \"2026-01-21T14:35:42Z\"). If provided, returns state of dataset at this timestamp. If not provided, returns the latest version. Requires datasetName to be specified. |  |
**page** | Option<**i32**> | page number, starts at 1 |  |
**limit** | Option<**i32**> | limit of items per page |  |

### Return type

[**models::PaginatedDatasetItems**](PaginatedDatasetItems.md)

### Authorization

[BasicAuth](../README.md#BasicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)