# This file was auto-generated by Fern from our API Definition.
import typing
from json.decoder import JSONDecodeError
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.request_options import RequestOptions
from ...core.unchecked_base_model import construct_type
from ...types.metric_param import MetricParam
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class RawMetricsClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._client_wrapper = client_wrapper
def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[MetricParam]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get the current metrics configuration for a project.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[MetricParam]
Current metrics configuration
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/metricparam/",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
MetricParam,
construct_type(
type_=MetricParam, # type: ignore
object_=_response.json(),
),
)
return HttpResponse(response=_response, data=_data)
_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,
id: int,
*,
additional_params: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
agreement_threshold: typing.Optional[int] = OMIT,
max_additional_annotators_assignable: typing.Optional[int] = OMIT,
metric_name: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[MetricParam]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update metrics strategy and parameters for a project.
Parameters
----------
id : int
additional_params : typing.Optional[typing.Dict[str, typing.Any]]
Agreement metric parameters
agreement_threshold : typing.Optional[int]
max_additional_annotators_assignable : typing.Optional[int]
metric_name : typing.Optional[str]
Agreement metric
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[MetricParam]
Updated metrics configuration
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/metricparam/",
method="POST",
json={
"additional_params": additional_params,
"agreement_threshold": agreement_threshold,
"max_additional_annotators_assignable": max_additional_annotators_assignable,
"metric_name": metric_name,
},
headers={
"content-type": "application/json",
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
MetricParam,
construct_type(
type_=MetricParam, # type: ignore
object_=_response.json(),
),
)
return HttpResponse(response=_response, data=_data)
_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 AsyncRawMetricsClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._client_wrapper = client_wrapper
async def get(
self, id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[MetricParam]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get the current metrics configuration for a project.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[MetricParam]
Current metrics configuration
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/metricparam/",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
MetricParam,
construct_type(
type_=MetricParam, # type: ignore
object_=_response.json(),
),
)
return AsyncHttpResponse(response=_response, data=_data)
_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,
id: int,
*,
additional_params: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
agreement_threshold: typing.Optional[int] = OMIT,
max_additional_annotators_assignable: typing.Optional[int] = OMIT,
metric_name: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[MetricParam]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update metrics strategy and parameters for a project.
Parameters
----------
id : int
additional_params : typing.Optional[typing.Dict[str, typing.Any]]
Agreement metric parameters
agreement_threshold : typing.Optional[int]
max_additional_annotators_assignable : typing.Optional[int]
metric_name : typing.Optional[str]
Agreement metric
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[MetricParam]
Updated metrics configuration
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/metricparam/",
method="POST",
json={
"additional_params": additional_params,
"agreement_threshold": agreement_threshold,
"max_additional_annotators_assignable": max_additional_annotators_assignable,
"metric_name": metric_name,
},
headers={
"content-type": "application/json",
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
MetricParam,
construct_type(
type_=MetricParam, # type: ignore
object_=_response.json(),
),
)
return AsyncHttpResponse(response=_response, data=_data)
_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)