# This file was auto-generated by Fern from our API Definition.
from __future__ import annotations
import typing
from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ..core.request_options import RequestOptions
from ..types.workspace import Workspace
from .raw_client import AsyncRawWorkspacesClient, RawWorkspacesClient
if typing.TYPE_CHECKING:
from .members.client import AsyncMembersClient, MembersClient
from .projects.client import AsyncProjectsClient, ProjectsClient
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class WorkspacesClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawWorkspacesClient(client_wrapper=client_wrapper)
self._client_wrapper = client_wrapper
self._members: typing.Optional[MembersClient] = None
self._projects: typing.Optional[ProjectsClient] = None
@property
def with_raw_response(self) -> RawWorkspacesClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawWorkspacesClient
"""
return self._raw_client
def list(
self,
*,
include_all_workspaces: typing.Optional[bool] = None,
is_personal: typing.Optional[bool] = None,
ordering: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[Workspace]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List all workspaces for your organization. Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization. For more information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces).
Parameters
----------
include_all_workspaces : typing.Optional[bool]
Include all workspaces in the organization, including other users' personal workspaces. Only effective for users with Administrator or Owner role. When enabled, the response includes created_by_user info for personal workspaces.
is_personal : typing.Optional[bool]
Workspace is a personal user workspace.
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[Workspace]
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.workspaces.list()
"""
_response = self._raw_client.list(
include_all_workspaces=include_all_workspaces,
is_personal=is_personal,
ordering=ordering,
request_options=request_options,
)
return _response.data
def create(
self,
*,
title: str,
color: typing.Optional[str] = OMIT,
description: typing.Optional[str] = OMIT,
is_archived: typing.Optional[bool] = OMIT,
is_personal: typing.Optional[bool] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> Workspace:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a new workspace. Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization. For more information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces).
Parameters
----------
title : str
Workspace Name
color : typing.Optional[str]
Color
description : typing.Optional[str]
Workspace description
is_archived : typing.Optional[bool]
Workspace is archived
is_personal : typing.Optional[bool]
Workspace is a personal user workspace
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Workspace
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.workspaces.create(
title="title",
)
"""
_response = self._raw_client.create(
title=title,
color=color,
description=description,
is_archived=is_archived,
is_personal=is_personal,
request_options=request_options,
)
return _response.data
def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Workspace:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve details for a specific workspace by ID.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Workspace
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.workspaces.get(
id=1,
)
"""
_response = self._raw_client.get(id, request_options=request_options)
return _response.data
def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific workspace by ID.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.workspaces.delete(
id=1,
)
"""
_response = self._raw_client.delete(id, request_options=request_options)
return _response.data
def update(
self,
id: int,
*,
color: typing.Optional[str] = OMIT,
description: typing.Optional[str] = OMIT,
is_archived: typing.Optional[bool] = OMIT,
is_personal: typing.Optional[bool] = OMIT,
title: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> Workspace:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update settings for a specific workspace by ID.
Parameters
----------
id : int
color : typing.Optional[str]
Color
description : typing.Optional[str]
Workspace description
is_archived : typing.Optional[bool]
Workspace is archived
is_personal : typing.Optional[bool]
Workspace is a personal user workspace
title : typing.Optional[str]
Workspace Name
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Workspace
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.workspaces.update(
id=1,
)
"""
_response = self._raw_client.update(
id,
color=color,
description=description,
is_archived=is_archived,
is_personal=is_personal,
title=title,
request_options=request_options,
)
return _response.data
@property
def members(self):
if self._members is None:
from .members.client import MembersClient # noqa: E402
self._members = MembersClient(client_wrapper=self._client_wrapper)
return self._members
@property
def projects(self):
if self._projects is None:
from .projects.client import ProjectsClient # noqa: E402
self._projects = ProjectsClient(client_wrapper=self._client_wrapper)
return self._projects
class AsyncWorkspacesClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawWorkspacesClient(client_wrapper=client_wrapper)
self._client_wrapper = client_wrapper
self._members: typing.Optional[AsyncMembersClient] = None
self._projects: typing.Optional[AsyncProjectsClient] = None
@property
def with_raw_response(self) -> AsyncRawWorkspacesClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawWorkspacesClient
"""
return self._raw_client
async def list(
self,
*,
include_all_workspaces: typing.Optional[bool] = None,
is_personal: typing.Optional[bool] = None,
ordering: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[Workspace]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
List all workspaces for your organization. Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization. For more information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces).
Parameters
----------
include_all_workspaces : typing.Optional[bool]
Include all workspaces in the organization, including other users' personal workspaces. Only effective for users with Administrator or Owner role. When enabled, the response includes created_by_user info for personal workspaces.
is_personal : typing.Optional[bool]
Workspace is a personal user workspace.
ordering : typing.Optional[str]
Which field to use when ordering the results.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[Workspace]
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.workspaces.list()
asyncio.run(main())
"""
_response = await self._raw_client.list(
include_all_workspaces=include_all_workspaces,
is_personal=is_personal,
ordering=ordering,
request_options=request_options,
)
return _response.data
async def create(
self,
*,
title: str,
color: typing.Optional[str] = OMIT,
description: typing.Optional[str] = OMIT,
is_archived: typing.Optional[bool] = OMIT,
is_personal: typing.Optional[bool] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> Workspace:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Create a new workspace. Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization. For more information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces).
Parameters
----------
title : str
Workspace Name
color : typing.Optional[str]
Color
description : typing.Optional[str]
Workspace description
is_archived : typing.Optional[bool]
Workspace is archived
is_personal : typing.Optional[bool]
Workspace is a personal user workspace
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Workspace
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.workspaces.create(
title="title",
)
asyncio.run(main())
"""
_response = await self._raw_client.create(
title=title,
color=color,
description=description,
is_archived=is_archived,
is_personal=is_personal,
request_options=request_options,
)
return _response.data
async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Workspace:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve details for a specific workspace by ID.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Workspace
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.workspaces.get(
id=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.get(id, request_options=request_options)
return _response.data
async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Delete a specific workspace by ID.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.workspaces.delete(
id=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.delete(id, request_options=request_options)
return _response.data
async def update(
self,
id: int,
*,
color: typing.Optional[str] = OMIT,
description: typing.Optional[str] = OMIT,
is_archived: typing.Optional[bool] = OMIT,
is_personal: typing.Optional[bool] = OMIT,
title: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> Workspace:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update settings for a specific workspace by ID.
Parameters
----------
id : int
color : typing.Optional[str]
Color
description : typing.Optional[str]
Workspace description
is_archived : typing.Optional[bool]
Workspace is archived
is_personal : typing.Optional[bool]
Workspace is a personal user workspace
title : typing.Optional[str]
Workspace Name
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
Workspace
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.workspaces.update(
id=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.update(
id,
color=color,
description=description,
is_archived=is_archived,
is_personal=is_personal,
title=title,
request_options=request_options,
)
return _response.data
@property
def members(self):
if self._members is None:
from .members.client import AsyncMembersClient # noqa: E402
self._members = AsyncMembersClient(client_wrapper=self._client_wrapper)
return self._members
@property
def projects(self):
if self._projects is None:
from .projects.client import AsyncProjectsClient # noqa: E402
self._projects = AsyncProjectsClient(client_wrapper=self._client_wrapper)
return self._projects