# 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.agreement_annotator_stats_response import AgreementAnnotatorStatsResponse
from .types.agreement_annotators_stats_response import AgreementAnnotatorsStatsResponse
from .types.data_filters_stats_response import DataFiltersStatsResponse
from .types.finished_tasks_stats_response import FinishedTasksStatsResponse
from .types.iaa_stats_response import IaaStatsResponse
from .types.lead_time_stats_response import LeadTimeStatsResponse
from .types.model_version_annotator_agreement_stats_response import ModelVersionAnnotatorAgreementStatsResponse
from .types.model_version_ground_truth_agreement_stats_response import ModelVersionGroundTruthAgreementStatsResponse
from .types.model_version_prediction_agreement_stats_response import ModelVersionPredictionAgreementStatsResponse
from .types.total_agreement_stats_response import TotalAgreementStatsResponse
from .types.user_ground_truth_agreement_stats_response import UserGroundTruthAgreementStatsResponse
from .types.user_prediction_agreement_stats_response import UserPredictionAgreementStatsResponse
from .types.user_review_score_stats_response import UserReviewScoreStatsResponse
from .types.users_ground_truth_agreement_stats_response import UsersGroundTruthAgreementStatsResponse
from .types.users_prediction_agreement_stats_response import UsersPredictionAgreementStatsResponse
from .types.users_review_score_stats_response import UsersReviewScoreStatsResponse
class RawStatsClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._client_wrapper = client_wrapper
def model_version_annotator_agreement(
self, id: int, model_version: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[ModelVersionAnnotatorAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get agreement between a given model version and all annotators in the project for overlapping tasks.
Parameters
----------
id : int
model_version : str
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[ModelVersionAnnotatorAgreementStatsResponse]
Model-version overall agreement vs annotators
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/model-stats/{jsonable_encoder(model_version)}/agreement",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
ModelVersionAnnotatorAgreementStatsResponse,
construct_type(
type_=ModelVersionAnnotatorAgreementStatsResponse, # 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 model_version_ground_truth_agreement(
self,
id: int,
model_version: str,
*,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[ModelVersionGroundTruthAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get agreement between a given model version and ground truth annotations in the project for overlapping tasks.
Parameters
----------
id : int
model_version : str
per_label : typing.Optional[bool]
Calculate agreement per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[ModelVersionGroundTruthAgreementStatsResponse]
Model-version ground truth agreement
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/model-stats/{jsonable_encoder(model_version)}/agreement-groundtruth",
method="GET",
params={
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
ModelVersionGroundTruthAgreementStatsResponse,
construct_type(
type_=ModelVersionGroundTruthAgreementStatsResponse, # 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 model_version_prediction_agreement(
self,
id: int,
model_version: str,
*,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[ModelVersionPredictionAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get agreement between a given model version and all other model versions in the project for overlapping tasks.
Parameters
----------
id : int
model_version : str
per_label : typing.Optional[bool]
Calculate agreement per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[ModelVersionPredictionAgreementStatsResponse]
Model-version prediction agreement
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/model-stats/{jsonable_encoder(model_version)}/prediction",
method="GET",
params={
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
ModelVersionPredictionAgreementStatsResponse,
construct_type(
type_=ModelVersionPredictionAgreementStatsResponse, # 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 iaa(
self,
id: int,
*,
expand: typing.Optional[str] = None,
per_label: typing.Optional[bool] = None,
std: typing.Optional[bool] = None,
task: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[IaaStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get Inter-Annotator Agreement (IAA) matrix for a project, showing agreement between all annotators.
Parameters
----------
id : int
expand : typing.Optional[str]
Comma-separated list of fields to expand
per_label : typing.Optional[bool]
Calculate IAA per label
std : typing.Optional[bool]
Include standard deviation in results
task : typing.Optional[str]
Comma-separated list of task IDs to filter by
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[IaaStatsResponse]
Inter-Annotator Agreement matrix
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/IAA",
method="GET",
params={
"expand": expand,
"per_label": per_label,
"std": std,
"task": task,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
IaaStatsResponse,
construct_type(
type_=IaaStatsResponse, # 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 users_ground_truth_agreement(
self,
id: int,
*,
ids: str,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[UsersGroundTruthAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get ground truth agreement statistics for multiple users within a project.
Parameters
----------
id : int
ids : str
Comma separated list of user IDs to get ground truth agreement for
per_label : typing.Optional[bool]
Per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[UsersGroundTruthAgreementStatsResponse]
Ground truth agreement statistics for multiple users
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/agreement-groundtruth",
method="GET",
params={
"ids": ids,
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
UsersGroundTruthAgreementStatsResponse,
construct_type(
type_=UsersGroundTruthAgreementStatsResponse, # 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 agreement_annotator(
self, id: int, user_id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[AgreementAnnotatorStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get agreement statistics for a specific annotator within a project.
Parameters
----------
id : int
user_id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[AgreementAnnotatorStatsResponse]
Individual annotator agreement statistics
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/agreement_annotator/{jsonable_encoder(user_id)}",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
AgreementAnnotatorStatsResponse,
construct_type(
type_=AgreementAnnotatorStatsResponse, # 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 agreement_annotators(
self, id: int, *, ids: str, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[AgreementAnnotatorsStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get agreement statistics for multiple annotators within a project.
Parameters
----------
id : int
ids : str
Comma separated list of annotator user IDs to get agreement scores for
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[AgreementAnnotatorsStatsResponse]
Multiple annotator agreement statistics
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/agreement_annotators",
method="GET",
params={
"ids": ids,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
AgreementAnnotatorsStatsResponse,
construct_type(
type_=AgreementAnnotatorsStatsResponse, # 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 data_filters(
self, id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[DataFiltersStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get statistics about user data filters and their usage within a project.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[DataFiltersStatsResponse]
User data filter statistics
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/data_filter",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
DataFiltersStatsResponse,
construct_type(
type_=DataFiltersStatsResponse, # 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 finished_tasks(
self, id: int, *, user_pk: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[FinishedTasksStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get statistics about finished tasks for a project.
Parameters
----------
id : int
user_pk : typing.Optional[int]
User ID to filter statistics by (optional)
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[FinishedTasksStatsResponse]
Finished tasks statistics
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/finished",
method="GET",
params={
"user_pk": user_pk,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
FinishedTasksStatsResponse,
construct_type(
type_=FinishedTasksStatsResponse, # 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 lead_time(
self, id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[LeadTimeStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get lead time statistics across the project, including average annotation time.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[LeadTimeStatsResponse]
Lead time statistics
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/lead_time",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
LeadTimeStatsResponse,
construct_type(
type_=LeadTimeStatsResponse, # 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 total_agreement(
self,
id: int,
*,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[TotalAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Overall or per-label total agreement across the project.
NOTE: due to an open issue in Fern, SDK clients will raise ApiError upon handling a 204 response. As a workaround, wrap call to this function in a try-except block.
Parameters
----------
id : int
per_label : typing.Optional[bool]
Return agreement per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[TotalAgreementStatsResponse]
Total agreement
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/total_agreement",
method="GET",
params={
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
TotalAgreementStatsResponse,
construct_type(
type_=TotalAgreementStatsResponse, # 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_stats(
self,
id: int,
*,
stat_type: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[typing.Dict[str, typing.Any]]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Start stats recalculation for given project
Parameters
----------
id : int
stat_type : typing.Optional[str]
Stat type to recalculate. Possible values: label, stats
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[typing.Dict[str, typing.Any]]
Successful response returns job id
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/update-stats",
method="GET",
params={
"stat_type": stat_type,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
typing.Dict[str, typing.Any],
construct_type(
type_=typing.Dict[str, typing.Any], # 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 users_prediction_agreement(
self,
id: int,
*,
ids: str,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[UsersPredictionAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get prediction agreement statistics for multiple annotators within a project.
Parameters
----------
id : int
ids : str
Comma separated list of annotator user IDs to get agreement scores for
per_label : typing.Optional[bool]
Per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[UsersPredictionAgreementStatsResponse]
Prediction agreement statistics for multiple annotators
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/user-stats/prediction",
method="GET",
params={
"ids": ids,
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
UsersPredictionAgreementStatsResponse,
construct_type(
type_=UsersPredictionAgreementStatsResponse, # 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 users_review_score(
self,
id: int,
*,
ids: str,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[UsersReviewScoreStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get review score and performance score statistics for multiple annotators within a project. Only allowed for accounts with reviewing features enabled.
Parameters
----------
id : int
ids : str
Comma separated list of annotator user IDs to get review scores for
per_label : typing.Optional[bool]
Per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[UsersReviewScoreStatsResponse]
Review scores and performance scores for multiple annotators
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/user-stats/review_score",
method="GET",
params={
"ids": ids,
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
UsersReviewScoreStatsResponse,
construct_type(
type_=UsersReviewScoreStatsResponse, # 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 user_prediction_agreement(
self,
id: int,
user_pk: int,
*,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[UserPredictionAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get prediction agreement statistics for a specific user within a project.
Parameters
----------
id : int
user_pk : int
per_label : typing.Optional[bool]
Calculate agreement per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[UserPredictionAgreementStatsResponse]
Individual user prediction agreement statistics
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/user-stats/{jsonable_encoder(user_pk)}/prediction",
method="GET",
params={
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
UserPredictionAgreementStatsResponse,
construct_type(
type_=UserPredictionAgreementStatsResponse, # 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 user_review_score(
self,
id: int,
user_pk: int,
*,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[UserReviewScoreStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get review score statistics for a specific user within a project. Only allowed for accounts with reviewing features enabled.
Parameters
----------
id : int
user_pk : int
per_label : typing.Optional[bool]
Calculate agreement per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[UserReviewScoreStatsResponse]
Individual user review score statistics
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/user-stats/{jsonable_encoder(user_pk)}/review_score",
method="GET",
params={
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
UserReviewScoreStatsResponse,
construct_type(
type_=UserReviewScoreStatsResponse, # 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 user_ground_truth_agreement(
self,
id: int,
user_pk: int,
*,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[UserGroundTruthAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get ground truth agreement statistics for a specific user within a project.
Parameters
----------
id : int
user_pk : int
per_label : typing.Optional[bool]
Calculate agreement per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[UserGroundTruthAgreementStatsResponse]
Individual user ground truth agreement statistics
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/users/{jsonable_encoder(user_pk)}/stats/agreement-groundtruth",
method="GET",
params={
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
UserGroundTruthAgreementStatsResponse,
construct_type(
type_=UserGroundTruthAgreementStatsResponse, # 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 AsyncRawStatsClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._client_wrapper = client_wrapper
async def model_version_annotator_agreement(
self, id: int, model_version: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[ModelVersionAnnotatorAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get agreement between a given model version and all annotators in the project for overlapping tasks.
Parameters
----------
id : int
model_version : str
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[ModelVersionAnnotatorAgreementStatsResponse]
Model-version overall agreement vs annotators
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/model-stats/{jsonable_encoder(model_version)}/agreement",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
ModelVersionAnnotatorAgreementStatsResponse,
construct_type(
type_=ModelVersionAnnotatorAgreementStatsResponse, # 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 model_version_ground_truth_agreement(
self,
id: int,
model_version: str,
*,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[ModelVersionGroundTruthAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get agreement between a given model version and ground truth annotations in the project for overlapping tasks.
Parameters
----------
id : int
model_version : str
per_label : typing.Optional[bool]
Calculate agreement per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[ModelVersionGroundTruthAgreementStatsResponse]
Model-version ground truth agreement
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/model-stats/{jsonable_encoder(model_version)}/agreement-groundtruth",
method="GET",
params={
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
ModelVersionGroundTruthAgreementStatsResponse,
construct_type(
type_=ModelVersionGroundTruthAgreementStatsResponse, # 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 model_version_prediction_agreement(
self,
id: int,
model_version: str,
*,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[ModelVersionPredictionAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get agreement between a given model version and all other model versions in the project for overlapping tasks.
Parameters
----------
id : int
model_version : str
per_label : typing.Optional[bool]
Calculate agreement per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[ModelVersionPredictionAgreementStatsResponse]
Model-version prediction agreement
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/model-stats/{jsonable_encoder(model_version)}/prediction",
method="GET",
params={
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
ModelVersionPredictionAgreementStatsResponse,
construct_type(
type_=ModelVersionPredictionAgreementStatsResponse, # 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 iaa(
self,
id: int,
*,
expand: typing.Optional[str] = None,
per_label: typing.Optional[bool] = None,
std: typing.Optional[bool] = None,
task: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[IaaStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get Inter-Annotator Agreement (IAA) matrix for a project, showing agreement between all annotators.
Parameters
----------
id : int
expand : typing.Optional[str]
Comma-separated list of fields to expand
per_label : typing.Optional[bool]
Calculate IAA per label
std : typing.Optional[bool]
Include standard deviation in results
task : typing.Optional[str]
Comma-separated list of task IDs to filter by
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[IaaStatsResponse]
Inter-Annotator Agreement matrix
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/IAA",
method="GET",
params={
"expand": expand,
"per_label": per_label,
"std": std,
"task": task,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
IaaStatsResponse,
construct_type(
type_=IaaStatsResponse, # 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 users_ground_truth_agreement(
self,
id: int,
*,
ids: str,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[UsersGroundTruthAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get ground truth agreement statistics for multiple users within a project.
Parameters
----------
id : int
ids : str
Comma separated list of user IDs to get ground truth agreement for
per_label : typing.Optional[bool]
Per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[UsersGroundTruthAgreementStatsResponse]
Ground truth agreement statistics for multiple users
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/agreement-groundtruth",
method="GET",
params={
"ids": ids,
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
UsersGroundTruthAgreementStatsResponse,
construct_type(
type_=UsersGroundTruthAgreementStatsResponse, # 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 agreement_annotator(
self, id: int, user_id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[AgreementAnnotatorStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get agreement statistics for a specific annotator within a project.
Parameters
----------
id : int
user_id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[AgreementAnnotatorStatsResponse]
Individual annotator agreement statistics
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/agreement_annotator/{jsonable_encoder(user_id)}",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
AgreementAnnotatorStatsResponse,
construct_type(
type_=AgreementAnnotatorStatsResponse, # 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 agreement_annotators(
self, id: int, *, ids: str, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[AgreementAnnotatorsStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get agreement statistics for multiple annotators within a project.
Parameters
----------
id : int
ids : str
Comma separated list of annotator user IDs to get agreement scores for
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[AgreementAnnotatorsStatsResponse]
Multiple annotator agreement statistics
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/agreement_annotators",
method="GET",
params={
"ids": ids,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
AgreementAnnotatorsStatsResponse,
construct_type(
type_=AgreementAnnotatorsStatsResponse, # 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 data_filters(
self, id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[DataFiltersStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get statistics about user data filters and their usage within a project.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[DataFiltersStatsResponse]
User data filter statistics
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/data_filter",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
DataFiltersStatsResponse,
construct_type(
type_=DataFiltersStatsResponse, # 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 finished_tasks(
self, id: int, *, user_pk: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[FinishedTasksStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get statistics about finished tasks for a project.
Parameters
----------
id : int
user_pk : typing.Optional[int]
User ID to filter statistics by (optional)
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[FinishedTasksStatsResponse]
Finished tasks statistics
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/finished",
method="GET",
params={
"user_pk": user_pk,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
FinishedTasksStatsResponse,
construct_type(
type_=FinishedTasksStatsResponse, # 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 lead_time(
self, id: int, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[LeadTimeStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get lead time statistics across the project, including average annotation time.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[LeadTimeStatsResponse]
Lead time statistics
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/lead_time",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
LeadTimeStatsResponse,
construct_type(
type_=LeadTimeStatsResponse, # 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 total_agreement(
self,
id: int,
*,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[TotalAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Overall or per-label total agreement across the project.
NOTE: due to an open issue in Fern, SDK clients will raise ApiError upon handling a 204 response. As a workaround, wrap call to this function in a try-except block.
Parameters
----------
id : int
per_label : typing.Optional[bool]
Return agreement per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[TotalAgreementStatsResponse]
Total agreement
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/stats/total_agreement",
method="GET",
params={
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
TotalAgreementStatsResponse,
construct_type(
type_=TotalAgreementStatsResponse, # 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_stats(
self,
id: int,
*,
stat_type: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[typing.Dict[str, typing.Any]]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Start stats recalculation for given project
Parameters
----------
id : int
stat_type : typing.Optional[str]
Stat type to recalculate. Possible values: label, stats
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[typing.Dict[str, typing.Any]]
Successful response returns job id
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/update-stats",
method="GET",
params={
"stat_type": stat_type,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
typing.Dict[str, typing.Any],
construct_type(
type_=typing.Dict[str, typing.Any], # 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 users_prediction_agreement(
self,
id: int,
*,
ids: str,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[UsersPredictionAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get prediction agreement statistics for multiple annotators within a project.
Parameters
----------
id : int
ids : str
Comma separated list of annotator user IDs to get agreement scores for
per_label : typing.Optional[bool]
Per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[UsersPredictionAgreementStatsResponse]
Prediction agreement statistics for multiple annotators
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/user-stats/prediction",
method="GET",
params={
"ids": ids,
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
UsersPredictionAgreementStatsResponse,
construct_type(
type_=UsersPredictionAgreementStatsResponse, # 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 users_review_score(
self,
id: int,
*,
ids: str,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[UsersReviewScoreStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get review score and performance score statistics for multiple annotators within a project. Only allowed for accounts with reviewing features enabled.
Parameters
----------
id : int
ids : str
Comma separated list of annotator user IDs to get review scores for
per_label : typing.Optional[bool]
Per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[UsersReviewScoreStatsResponse]
Review scores and performance scores for multiple annotators
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/user-stats/review_score",
method="GET",
params={
"ids": ids,
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
UsersReviewScoreStatsResponse,
construct_type(
type_=UsersReviewScoreStatsResponse, # 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 user_prediction_agreement(
self,
id: int,
user_pk: int,
*,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[UserPredictionAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get prediction agreement statistics for a specific user within a project.
Parameters
----------
id : int
user_pk : int
per_label : typing.Optional[bool]
Calculate agreement per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[UserPredictionAgreementStatsResponse]
Individual user prediction agreement statistics
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/user-stats/{jsonable_encoder(user_pk)}/prediction",
method="GET",
params={
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
UserPredictionAgreementStatsResponse,
construct_type(
type_=UserPredictionAgreementStatsResponse, # 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 user_review_score(
self,
id: int,
user_pk: int,
*,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[UserReviewScoreStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get review score statistics for a specific user within a project. Only allowed for accounts with reviewing features enabled.
Parameters
----------
id : int
user_pk : int
per_label : typing.Optional[bool]
Calculate agreement per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[UserReviewScoreStatsResponse]
Individual user review score statistics
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/user-stats/{jsonable_encoder(user_pk)}/review_score",
method="GET",
params={
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
UserReviewScoreStatsResponse,
construct_type(
type_=UserReviewScoreStatsResponse, # 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 user_ground_truth_agreement(
self,
id: int,
user_pk: int,
*,
per_label: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[UserGroundTruthAgreementStatsResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Get ground truth agreement statistics for a specific user within a project.
Parameters
----------
id : int
user_pk : int
per_label : typing.Optional[bool]
Calculate agreement per label
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[UserGroundTruthAgreementStatsResponse]
Individual user ground truth agreement statistics
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/users/{jsonable_encoder(user_pk)}/stats/agreement-groundtruth",
method="GET",
params={
"per_label": per_label,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
UserGroundTruthAgreementStatsResponse,
construct_type(
type_=UserGroundTruthAgreementStatsResponse, # 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)