langfuse-rs 0.0.1

Langfuse Rust SDK
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
138
139
140
141
142
143
144
145

# \ScoreApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**score_create**](ScoreApi.md#score_create) | **POST** /api/public/scores | 
[**score_delete**](ScoreApi.md#score_delete) | **DELETE** /api/public/scores/{scoreId} | 
[**score_get**](ScoreApi.md#score_get) | **GET** /api/public/scores | 
[**score_get_by_id**](ScoreApi.md#score_get_by_id) | **GET** /api/public/scores/{scoreId} | 



## score_create

> models::CreateScoreResponse score_create(create_score_request)


Create a score

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_score_request** | [**CreateScoreRequest**](CreateScoreRequest.md) |  | [required] |

### Return type

[**models::CreateScoreResponse**](CreateScoreResponse.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)


## score_delete

> score_delete(score_id)


Delete a score

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**score_id** | **String** | The unique langfuse identifier of a score | [required] |

### Return type

 (empty response body)

### 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)


## score_get

> models::GetScoresResponse score_get(page, limit, user_id, name, from_timestamp, to_timestamp, source, operator, value, score_ids, config_id, queue_id, data_type, trace_tags)


Get a list of scores

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page** | Option<**i32**> | Page number, starts at 1. |  |
**limit** | Option<**i32**> | Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit. |  |
**user_id** | Option<**String**> | Retrieve only scores with this userId associated to the trace. |  |
**name** | Option<**String**> | Retrieve only scores with this name. |  |
**from_timestamp** | Option<**String**> | Optional filter to only include scores created on or after a certain datetime (ISO 8601) |  |
**to_timestamp** | Option<**String**> | Optional filter to only include scores created before a certain datetime (ISO 8601) |  |
**source** | Option<[**ScoreSource**](.md)> | Retrieve only scores from a specific source. |  |
**operator** | Option<**String**> | Retrieve only scores with <operator> value. |  |
**value** | Option<**f64**> | Retrieve only scores with <operator> value. |  |
**score_ids** | Option<**String**> | Comma-separated list of score IDs to limit the results to. |  |
**config_id** | Option<**String**> | Retrieve only scores with a specific configId. |  |
**queue_id** | Option<**String**> | Retrieve only scores with a specific annotation queueId. |  |
**data_type** | Option<[**ScoreDataType**](.md)> | Retrieve only scores with a specific dataType. |  |
**trace_tags** | Option<[**Vec<String>**](String.md)> | Only scores linked to traces that include all of these tags will be returned. |  |

### Return type

[**models::GetScoresResponse**](GetScoresResponse.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)


## score_get_by_id

> models::Score score_get_by_id(score_id)


Get a score

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**score_id** | **String** | The unique langfuse identifier of a score | [required] |

### Return type

[**models::Score**](Score.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)