# This file was auto-generated by Fern from our API Definition. import typing from json.decoder import JSONDecodeError from ..commons.errors.access_denied_error import AccessDeniedError from ..commons.errors.error import Error from ..commons.errors.method_not_allowed_error import MethodNotAllowedError from ..commons.errors.not_found_error import NotFoundError from ..commons.errors.unauthorized_error import UnauthorizedError from ..commons.types.config_category import ConfigCategory from ..commons.types.score_config import ScoreConfig from ..commons.types.score_config_data_type import ScoreConfigDataType from ..core.api_error import ApiError from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ..core.http_response import AsyncHttpResponse, HttpResponse from ..core.jsonable_encoder import jsonable_encoder from ..core.pydantic_utilities import parse_obj_as from ..core.request_options import RequestOptions from ..core.serialization import convert_and_respect_annotation_metadata from .types.score_configs import ScoreConfigs # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) class RawScoreConfigsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): self._client_wrapper = client_wrapper def create( self, *, name: str, data_type: ScoreConfigDataType, categories: typing.Optional[typing.Sequence[ConfigCategory]] = OMIT, min_value: typing.Optional[float] = OMIT, max_value: typing.Optional[float] = OMIT, description: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[ScoreConfig]: """ Create a score configuration (config). Score configs are used to define the structure of scores Parameters ---------- name : str data_type : ScoreConfigDataType categories : typing.Optional[typing.Sequence[ConfigCategory]] Configure custom categories for categorical scores. Pass a list of objects with `label` and `value` properties. Categories are autogenerated for boolean configs and cannot be passed min_value : typing.Optional[float] Configure a minimum value for numerical scores. If not set, the minimum value defaults to -∞ max_value : typing.Optional[float] Configure a maximum value for numerical scores. If not set, the maximum value defaults to +∞ description : typing.Optional[str] Description is shown across the Langfuse UI and can be used to e.g. explain the config categories in detail, why a numeric range was set, or provide additional context on config name or usage request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[ScoreConfig] """ _response = self._client_wrapper.httpx_client.request( "api/public/score-configs", method="POST", json={ "name": name, "dataType": data_type, "categories": convert_and_respect_annotation_metadata( object_=categories, annotation=typing.Sequence[ConfigCategory], direction="write", ), "minValue": min_value, "maxValue": max_value, "description": description, }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( ScoreConfig, parse_obj_as( type_=ScoreConfig, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 400: raise Error( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 401: raise UnauthorizedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 403: raise AccessDeniedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 405: raise MethodNotAllowedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.text, ) raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response_json, ) def get( self, *, page: typing.Optional[int] = None, limit: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[ScoreConfigs]: """ Get all score configs Parameters ---------- page : typing.Optional[int] Page number, starts at 1. limit : typing.Optional[int] Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[ScoreConfigs] """ _response = self._client_wrapper.httpx_client.request( "api/public/score-configs", method="GET", params={ "page": page, "limit": limit, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( ScoreConfigs, parse_obj_as( type_=ScoreConfigs, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 400: raise Error( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 401: raise UnauthorizedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 403: raise AccessDeniedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 405: raise MethodNotAllowedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.text, ) raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response_json, ) def get_by_id( self, config_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[ScoreConfig]: """ Get a score config Parameters ---------- config_id : str The unique langfuse identifier of a score config request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[ScoreConfig] """ _response = self._client_wrapper.httpx_client.request( f"api/public/score-configs/{jsonable_encoder(config_id)}", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( ScoreConfig, parse_obj_as( type_=ScoreConfig, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 400: raise Error( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 401: raise UnauthorizedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 403: raise AccessDeniedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 405: raise MethodNotAllowedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.text, ) raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response_json, ) def update( self, config_id: str, *, is_archived: typing.Optional[bool] = OMIT, name: typing.Optional[str] = OMIT, categories: typing.Optional[typing.Sequence[ConfigCategory]] = OMIT, min_value: typing.Optional[float] = OMIT, max_value: typing.Optional[float] = OMIT, description: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[ScoreConfig]: """ Update a score config Parameters ---------- config_id : str The unique langfuse identifier of a score config is_archived : typing.Optional[bool] The status of the score config showing if it is archived or not name : typing.Optional[str] The name of the score config categories : typing.Optional[typing.Sequence[ConfigCategory]] Configure custom categories for categorical scores. Pass a list of objects with `label` and `value` properties. Categories are autogenerated for boolean configs and cannot be passed min_value : typing.Optional[float] Configure a minimum value for numerical scores. If not set, the minimum value defaults to -∞ max_value : typing.Optional[float] Configure a maximum value for numerical scores. If not set, the maximum value defaults to +∞ description : typing.Optional[str] Description is shown across the Langfuse UI and can be used to e.g. explain the config categories in detail, why a numeric range was set, or provide additional context on config name or usage request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[ScoreConfig] """ _response = self._client_wrapper.httpx_client.request( f"api/public/score-configs/{jsonable_encoder(config_id)}", method="PATCH", json={ "isArchived": is_archived, "name": name, "categories": convert_and_respect_annotation_metadata( object_=categories, annotation=typing.Sequence[ConfigCategory], direction="write", ), "minValue": min_value, "maxValue": max_value, "description": description, }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( ScoreConfig, parse_obj_as( type_=ScoreConfig, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 400: raise Error( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 401: raise UnauthorizedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 403: raise AccessDeniedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 405: raise MethodNotAllowedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.text, ) raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response_json, ) class AsyncRawScoreConfigsClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): self._client_wrapper = client_wrapper async def create( self, *, name: str, data_type: ScoreConfigDataType, categories: typing.Optional[typing.Sequence[ConfigCategory]] = OMIT, min_value: typing.Optional[float] = OMIT, max_value: typing.Optional[float] = OMIT, description: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[ScoreConfig]: """ Create a score configuration (config). Score configs are used to define the structure of scores Parameters ---------- name : str data_type : ScoreConfigDataType categories : typing.Optional[typing.Sequence[ConfigCategory]] Configure custom categories for categorical scores. Pass a list of objects with `label` and `value` properties. Categories are autogenerated for boolean configs and cannot be passed min_value : typing.Optional[float] Configure a minimum value for numerical scores. If not set, the minimum value defaults to -∞ max_value : typing.Optional[float] Configure a maximum value for numerical scores. If not set, the maximum value defaults to +∞ description : typing.Optional[str] Description is shown across the Langfuse UI and can be used to e.g. explain the config categories in detail, why a numeric range was set, or provide additional context on config name or usage request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[ScoreConfig] """ _response = await self._client_wrapper.httpx_client.request( "api/public/score-configs", method="POST", json={ "name": name, "dataType": data_type, "categories": convert_and_respect_annotation_metadata( object_=categories, annotation=typing.Sequence[ConfigCategory], direction="write", ), "minValue": min_value, "maxValue": max_value, "description": description, }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( ScoreConfig, parse_obj_as( type_=ScoreConfig, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 400: raise Error( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 401: raise UnauthorizedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 403: raise AccessDeniedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 405: raise MethodNotAllowedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.text, ) raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response_json, ) async def get( self, *, page: typing.Optional[int] = None, limit: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[ScoreConfigs]: """ Get all score configs Parameters ---------- page : typing.Optional[int] Page number, starts at 1. limit : typing.Optional[int] Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[ScoreConfigs] """ _response = await self._client_wrapper.httpx_client.request( "api/public/score-configs", method="GET", params={ "page": page, "limit": limit, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( ScoreConfigs, parse_obj_as( type_=ScoreConfigs, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 400: raise Error( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 401: raise UnauthorizedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 403: raise AccessDeniedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 405: raise MethodNotAllowedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.text, ) raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response_json, ) async def get_by_id( self, config_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[ScoreConfig]: """ Get a score config Parameters ---------- config_id : str The unique langfuse identifier of a score config request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[ScoreConfig] """ _response = await self._client_wrapper.httpx_client.request( f"api/public/score-configs/{jsonable_encoder(config_id)}", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( ScoreConfig, parse_obj_as( type_=ScoreConfig, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 400: raise Error( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 401: raise UnauthorizedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 403: raise AccessDeniedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 405: raise MethodNotAllowedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.text, ) raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response_json, ) async def update( self, config_id: str, *, is_archived: typing.Optional[bool] = OMIT, name: typing.Optional[str] = OMIT, categories: typing.Optional[typing.Sequence[ConfigCategory]] = OMIT, min_value: typing.Optional[float] = OMIT, max_value: typing.Optional[float] = OMIT, description: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[ScoreConfig]: """ Update a score config Parameters ---------- config_id : str The unique langfuse identifier of a score config is_archived : typing.Optional[bool] The status of the score config showing if it is archived or not name : typing.Optional[str] The name of the score config categories : typing.Optional[typing.Sequence[ConfigCategory]] Configure custom categories for categorical scores. Pass a list of objects with `label` and `value` properties. Categories are autogenerated for boolean configs and cannot be passed min_value : typing.Optional[float] Configure a minimum value for numerical scores. If not set, the minimum value defaults to -∞ max_value : typing.Optional[float] Configure a maximum value for numerical scores. If not set, the maximum value defaults to +∞ description : typing.Optional[str] Description is shown across the Langfuse UI and can be used to e.g. explain the config categories in detail, why a numeric range was set, or provide additional context on config name or usage request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[ScoreConfig] """ _response = await self._client_wrapper.httpx_client.request( f"api/public/score-configs/{jsonable_encoder(config_id)}", method="PATCH", json={ "isArchived": is_archived, "name": name, "categories": convert_and_respect_annotation_metadata( object_=categories, annotation=typing.Sequence[ConfigCategory], direction="write", ), "minValue": min_value, "maxValue": max_value, "description": description, }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( ScoreConfig, parse_obj_as( type_=ScoreConfig, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 400: raise Error( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 401: raise UnauthorizedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 403: raise AccessDeniedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 405: raise MethodNotAllowedError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Any, parse_obj_as( type_=typing.Any, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response.text, ) raise ApiError( status_code=_response.status_code, headers=dict(_response.headers), body=_response_json, )