# 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.annotation_history import AnnotationHistory
from ..types.paginated_annotation_history_list import PaginatedAnnotationHistoryList
from .types.delete_annotation_history_response import DeleteAnnotationHistoryResponse
class RawAnnotationHistoryClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._client_wrapper = client_wrapper
def list(
self,
*,
annotation: typing.Optional[int] = None,
ordering: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[typing.List[AnnotationHistory]]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List annotation history items for an annotation. Annotation history logs all actions performed with annotations, such as: imports, submits, updates, reviews, and more. Users can view annotation history items in the Annotation History panel during labeling.
Parameters
----------
annotation : typing.Optional[int]
Annotation ID to get annotation history items for.
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[typing.List[AnnotationHistory]]
"""
_response = self._client_wrapper.httpx_client.request(
"api/annotation-history/",
method="GET",
params={
"annotation": annotation,
"ordering": ordering,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
typing.List[AnnotationHistory],
construct_type(
type_=typing.List[AnnotationHistory], # 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 delete(
self,
*,
annotation: typing.Optional[int] = None,
project: typing.Optional[int] = None,
task: typing.Optional[int] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[DeleteAnnotationHistoryResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete all annotation history items for a specific annotation, task or project. This method is available only for users with administrator roles.
Parameters
----------
annotation : typing.Optional[int]
Annotation ID to delete annotation history items for.
project : typing.Optional[int]
Project ID to delete annotation history items for.
task : typing.Optional[int]
Task ID to delete annotation history items for.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[DeleteAnnotationHistoryResponse]
Returns a dict containing the count of removed items.
"""
_response = self._client_wrapper.httpx_client.request(
"api/annotation-history/",
method="DELETE",
params={
"annotation": annotation,
"project": project,
"task": task,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
DeleteAnnotationHistoryResponse,
construct_type(
type_=DeleteAnnotationHistoryResponse, # 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 list_for_project(
self,
id: int,
*,
page: typing.Optional[int] = None,
page_size: typing.Optional[int] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[PaginatedAnnotationHistoryList]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List all annotation history items for the project with pagination.
Parameters
----------
id : int
page : typing.Optional[int]
A page number within the paginated result set.
page_size : typing.Optional[int]
Number of results to return per page.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[PaginatedAnnotationHistoryList]
"""
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/annotation-history/",
method="GET",
params={
"page": page,
"page_size": page_size,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
PaginatedAnnotationHistoryList,
construct_type(
type_=PaginatedAnnotationHistoryList, # 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 AsyncRawAnnotationHistoryClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._client_wrapper = client_wrapper
async def list(
self,
*,
annotation: typing.Optional[int] = None,
ordering: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[typing.List[AnnotationHistory]]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List annotation history items for an annotation. Annotation history logs all actions performed with annotations, such as: imports, submits, updates, reviews, and more. Users can view annotation history items in the Annotation History panel during labeling.
Parameters
----------
annotation : typing.Optional[int]
Annotation ID to get annotation history items for.
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[typing.List[AnnotationHistory]]
"""
_response = await self._client_wrapper.httpx_client.request(
"api/annotation-history/",
method="GET",
params={
"annotation": annotation,
"ordering": ordering,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
typing.List[AnnotationHistory],
construct_type(
type_=typing.List[AnnotationHistory], # 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 delete(
self,
*,
annotation: typing.Optional[int] = None,
project: typing.Optional[int] = None,
task: typing.Optional[int] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[DeleteAnnotationHistoryResponse]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete all annotation history items for a specific annotation, task or project. This method is available only for users with administrator roles.
Parameters
----------
annotation : typing.Optional[int]
Annotation ID to delete annotation history items for.
project : typing.Optional[int]
Project ID to delete annotation history items for.
task : typing.Optional[int]
Task ID to delete annotation history items for.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[DeleteAnnotationHistoryResponse]
Returns a dict containing the count of removed items.
"""
_response = await self._client_wrapper.httpx_client.request(
"api/annotation-history/",
method="DELETE",
params={
"annotation": annotation,
"project": project,
"task": task,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
DeleteAnnotationHistoryResponse,
construct_type(
type_=DeleteAnnotationHistoryResponse, # 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 list_for_project(
self,
id: int,
*,
page: typing.Optional[int] = None,
page_size: typing.Optional[int] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[PaginatedAnnotationHistoryList]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List all annotation history items for the project with pagination.
Parameters
----------
id : int
page : typing.Optional[int]
A page number within the paginated result set.
page_size : typing.Optional[int]
Number of results to return per page.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[PaginatedAnnotationHistoryList]
"""
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/annotation-history/",
method="GET",
params={
"page": page,
"page_size": page_size,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
PaginatedAnnotationHistoryList,
construct_type(
type_=PaginatedAnnotationHistoryList, # 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)