Skip to content

Commit ffd28a4

Browse files
langfuse-botlangfuse-bot
andauthored
feat(api): update API spec from langfuse/langfuse 53433e8 (#1712)
Co-authored-by: langfuse-bot <langfuse-bot@langfuse.com>
1 parent f496fed commit ffd28a4

6 files changed

Lines changed: 532 additions & 0 deletions

File tree

‎langfuse/api/unstable/__init__.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@
9494
CreateEvaluatorRequest_Code,
9595
CreateEvaluatorRequest_LlmAsJudge,
9696
CreateLlmAsJudgeEvaluatorRequest,
97+
DeleteEvaluatorResponse,
9798
Evaluator,
9899
EvaluatorBase,
99100
Evaluator_Code,
@@ -121,6 +122,7 @@
121122
"CreateLlmAsJudgeEvaluatorRequest": ".evaluators",
122123
"DateTimeEvaluationRuleFilter": ".commons",
123124
"DeleteEvaluationRuleResponse": ".evaluation_rules",
125+
"DeleteEvaluatorResponse": ".evaluators",
124126
"EvaluationRule": ".evaluation_rules",
125127
"EvaluationRuleArrayOptionsFilterOperator": ".commons",
126128
"EvaluationRuleBooleanFilterOperator": ".commons",
@@ -242,6 +244,7 @@ def __dir__():
242244
"CreateLlmAsJudgeEvaluatorRequest",
243245
"DateTimeEvaluationRuleFilter",
244246
"DeleteEvaluationRuleResponse",
247+
"DeleteEvaluatorResponse",
245248
"EvaluationRule",
246249
"EvaluationRuleArrayOptionsFilterOperator",
247250
"EvaluationRuleBooleanFilterOperator",

‎langfuse/api/unstable/evaluators/__init__.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
CreateEvaluatorRequest_Code,
1414
CreateEvaluatorRequest_LlmAsJudge,
1515
CreateLlmAsJudgeEvaluatorRequest,
16+
DeleteEvaluatorResponse,
1617
Evaluator,
1718
EvaluatorBase,
1819
Evaluator_Code,
@@ -27,6 +28,7 @@
2728
"CreateEvaluatorRequest_Code": ".types",
2829
"CreateEvaluatorRequest_LlmAsJudge": ".types",
2930
"CreateLlmAsJudgeEvaluatorRequest": ".types",
31+
"DeleteEvaluatorResponse": ".types",
3032
"Evaluator": ".types",
3133
"EvaluatorBase": ".types",
3234
"Evaluator_Code": ".types",
@@ -70,6 +72,7 @@ def __dir__():
7072
"CreateEvaluatorRequest_Code",
7173
"CreateEvaluatorRequest_LlmAsJudge",
7274
"CreateLlmAsJudgeEvaluatorRequest",
75+
"DeleteEvaluatorResponse",
7376
"Evaluator",
7477
"EvaluatorBase",
7578
"Evaluator_Code",

‎langfuse/api/unstable/evaluators/client.py‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
from ...core.request_options import RequestOptions
77
from .raw_client import AsyncRawEvaluatorsClient, RawEvaluatorsClient
88
from .types.create_evaluator_request import CreateEvaluatorRequest
9+
from .types.delete_evaluator_response import DeleteEvaluatorResponse
910
from .types.evaluator import Evaluator
1011
from .types.evaluators import Evaluators
1112

@@ -211,6 +212,54 @@ def get(
211212
_response = self._raw_client.get(evaluator_id, request_options=request_options)
212213
return _response.data
213214

215+
def delete(
216+
self,
217+
evaluator_id: str,
218+
*,
219+
request_options: typing.Optional[RequestOptions] = None,
220+
) -> DeleteEvaluatorResponse:
221+
"""
222+
Delete an evaluator.
223+
224+
Important behavior:
225+
- This deletes the evaluator including all of its stored versions; `evaluatorId` may reference any version.
226+
- The API returns `409` while evaluation rules still reference the evaluator. Delete those evaluation rules first.
227+
- Langfuse-managed evaluators (`scope=managed`) cannot be deleted; the API returns `403`.
228+
- Scores already produced by the evaluator are not deleted.
229+
230+
Parameters
231+
----------
232+
evaluator_id : str
233+
Evaluator identifier returned by the evaluator endpoints.
234+
235+
request_options : typing.Optional[RequestOptions]
236+
Request-specific configuration.
237+
238+
Returns
239+
-------
240+
DeleteEvaluatorResponse
241+
242+
Examples
243+
--------
244+
from langfuse import LangfuseAPI
245+
246+
client = LangfuseAPI(
247+
x_langfuse_sdk_name="YOUR_X_LANGFUSE_SDK_NAME",
248+
x_langfuse_sdk_version="YOUR_X_LANGFUSE_SDK_VERSION",
249+
x_langfuse_public_key="YOUR_X_LANGFUSE_PUBLIC_KEY",
250+
username="YOUR_USERNAME",
251+
password="YOUR_PASSWORD",
252+
base_url="https://yourhost.com/path/to/api",
253+
)
254+
client.unstable.evaluators.delete(
255+
evaluator_id="evaluatorId",
256+
)
257+
"""
258+
_response = self._raw_client.delete(
259+
evaluator_id, request_options=request_options
260+
)
261+
return _response.data
262+
214263

215264
class AsyncEvaluatorsClient:
216265
def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -435,3 +484,59 @@ async def main() -> None:
435484
evaluator_id, request_options=request_options
436485
)
437486
return _response.data
487+
488+
async def delete(
489+
self,
490+
evaluator_id: str,
491+
*,
492+
request_options: typing.Optional[RequestOptions] = None,
493+
) -> DeleteEvaluatorResponse:
494+
"""
495+
Delete an evaluator.
496+
497+
Important behavior:
498+
- This deletes the evaluator including all of its stored versions; `evaluatorId` may reference any version.
499+
- The API returns `409` while evaluation rules still reference the evaluator. Delete those evaluation rules first.
500+
- Langfuse-managed evaluators (`scope=managed`) cannot be deleted; the API returns `403`.
501+
- Scores already produced by the evaluator are not deleted.
502+
503+
Parameters
504+
----------
505+
evaluator_id : str
506+
Evaluator identifier returned by the evaluator endpoints.
507+
508+
request_options : typing.Optional[RequestOptions]
509+
Request-specific configuration.
510+
511+
Returns
512+
-------
513+
DeleteEvaluatorResponse
514+
515+
Examples
516+
--------
517+
import asyncio
518+
519+
from langfuse import AsyncLangfuseAPI
520+
521+
client = AsyncLangfuseAPI(
522+
x_langfuse_sdk_name="YOUR_X_LANGFUSE_SDK_NAME",
523+
x_langfuse_sdk_version="YOUR_X_LANGFUSE_SDK_VERSION",
524+
x_langfuse_public_key="YOUR_X_LANGFUSE_PUBLIC_KEY",
525+
username="YOUR_USERNAME",
526+
password="YOUR_PASSWORD",
527+
base_url="https://yourhost.com/path/to/api",
528+
)
529+
530+
531+
async def main() -> None:
532+
await client.unstable.evaluators.delete(
533+
evaluator_id="evaluatorId",
534+
)
535+
536+
537+
asyncio.run(main())
538+
"""
539+
_response = await self._raw_client.delete(
540+
evaluator_id, request_options=request_options
541+
)
542+
return _response.data

0 commit comments

Comments
 (0)