Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

78 changes: 71 additions & 7 deletions reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -430,7 +430,7 @@ client.annotation_history.list_for_project(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
List all reviews for a specific annotation ID.
List all reviews for a specific annotation ID. Only allowed for organizations with reviewing features enabled.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -520,7 +520,7 @@ client.annotation_reviews.list()
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Create a review for a specific annotation ID.
Create a review for a specific annotation ID. Only allowed for organizations with reviewing features enabled.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -652,7 +652,7 @@ client.annotation_reviews.create(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Retrieve a specific review by ID for an annotation.
Retrieve a specific review by ID for an annotation. Only allowed for organizations with reviewing features enabled.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -728,7 +728,7 @@ client.annotation_reviews.get(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Delete a review by ID
Delete a review by ID. Only allowed for organizations with reviewing features enabled.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -804,7 +804,7 @@ client.annotation_reviews.delete(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Update a specific review by ID.
Update a specific review by ID. Only allowed for organizations with reviewing features enabled.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -12723,6 +12723,14 @@ client.workspaces.list()
<dl>
<dd>

**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.

</dd>
</dl>

<dl>
<dd>

**is_personal:** `typing.Optional[bool]` — Workspace is a personal user workspace.

</dd>
Expand Down Expand Up @@ -33546,7 +33554,7 @@ client.projects.stats.users_prediction_agreement(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Get review score and performance score statistics for multiple annotators within a project.
Get review score and performance score statistics for multiple annotators within a project. Only allowed for accounts with reviewing features enabled.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -33732,7 +33740,7 @@ client.projects.stats.user_prediction_agreement(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Get review score statistics for a specific user within a project.
Get review score statistics for a specific user within a project. Only allowed for accounts with reviewing features enabled.
</dd>
</dl>
</dd>
Expand Down Expand Up @@ -37351,6 +37359,62 @@ client.sso.saml.update(
<dl>
<dd>

**domain:** `typing.Optional[str]` — Organization web domain or domains; use comma separated list with no spaces for multiple. Example:<br><br>labelstud.io,humansignal.com<br><br>IMPORTANT: DO NOT PUT COMMON DOMAINS LIKE GMAIL.COM, YAHOO.COM, ETC. IN THIS FIELD

</dd>
</dl>

<dl>
<dd>

**mapping_email:** `typing.Optional[str]` — Mapping attributes: user email from SAML request

</dd>
</dl>

<dl>
<dd>

**mapping_first_name:** `typing.Optional[str]` — Mapping attributes: user first name from SAML request

</dd>
</dl>

<dl>
<dd>

**mapping_groups:** `typing.Optional[str]` — Mapping attributes: groups attribute for user mapping to workspaces and roles

</dd>
</dl>

<dl>
<dd>

**mapping_last_name:** `typing.Optional[str]` — Mapping attributes: user last name from SAML request

</dd>
</dl>

<dl>
<dd>

**metadata_url:** `typing.Optional[str]` — URL SAML metadata from IdP

</dd>
</dl>

<dl>
<dd>

**metadata_xml:** `typing.Optional[str]` — Metadata XML file

</dd>
</dl>

<dl>
<dd>

**projects_groups:** `typing.Optional[typing.Sequence[ProjectGroupRequest]]`

</dd>
Expand Down
20 changes: 10 additions & 10 deletions src/label_studio_sdk/annotation_reviews/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ def list(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
List all reviews for a specific annotation ID.
List all reviews for a specific annotation ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -98,7 +98,7 @@ def create(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Create a review for a specific annotation ID.
Create a review for a specific annotation ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -161,7 +161,7 @@ def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = Non
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Retrieve a specific review by ID for an annotation.
Retrieve a specific review by ID for an annotation. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -198,7 +198,7 @@ def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] =
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Delete a review by ID
Delete a review by ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -246,7 +246,7 @@ def update(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Update a specific review by ID.
Update a specific review by ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -332,7 +332,7 @@ async def list(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
List all reviews for a specific annotation ID.
List all reviews for a specific annotation ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -396,7 +396,7 @@ async def create(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Create a review for a specific annotation ID.
Create a review for a specific annotation ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -467,7 +467,7 @@ async def get(self, id: int, *, request_options: typing.Optional[RequestOptions]
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Retrieve a specific review by ID for an annotation.
Retrieve a specific review by ID for an annotation. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -512,7 +512,7 @@ async def delete(self, id: int, *, request_options: typing.Optional[RequestOptio
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Delete a review by ID
Delete a review by ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -568,7 +568,7 @@ async def update(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Update a specific review by ID.
Update a specific review by ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down
20 changes: 10 additions & 10 deletions src/label_studio_sdk/annotation_reviews/raw_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def list(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
List all reviews for a specific annotation ID.
List all reviews for a specific annotation ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -99,7 +99,7 @@ def create(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Create a review for a specific annotation ID.
Create a review for a specific annotation ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -176,7 +176,7 @@ def get(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Retrieve a specific review by ID for an annotation.
Retrieve a specific review by ID for an annotation. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -219,7 +219,7 @@ def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] =
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Delete a review by ID
Delete a review by ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -266,7 +266,7 @@ def update(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Update a specific review by ID.
Update a specific review by ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -350,7 +350,7 @@ async def list(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
List all reviews for a specific annotation ID.
List all reviews for a specific annotation ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -414,7 +414,7 @@ async def create(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Create a review for a specific annotation ID.
Create a review for a specific annotation ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -491,7 +491,7 @@ async def get(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Retrieve a specific review by ID for an annotation.
Retrieve a specific review by ID for an annotation. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -536,7 +536,7 @@ async def delete(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Delete a review by ID
Delete a review by ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -583,7 +583,7 @@ async def update(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Update a specific review by ID.
Update a specific review by ID. Only allowed for organizations with reviewing features enabled.

Parameters
----------
Expand Down
8 changes: 4 additions & 4 deletions src/label_studio_sdk/projects/stats/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -651,7 +651,7 @@ def users_review_score(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Get review score and performance score statistics for multiple annotators within a project.
Get review score and performance score statistics for multiple annotators within a project. Only allowed for accounts with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -754,7 +754,7 @@ def user_review_score(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Get review score statistics for a specific user within a project.
Get review score statistics for a specific user within a project. Only allowed for accounts with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -1576,7 +1576,7 @@ async def users_review_score(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Get review score and performance score statistics for multiple annotators within a project.
Get review score and performance score statistics for multiple annotators within a project. Only allowed for accounts with reviewing features enabled.

Parameters
----------
Expand Down Expand Up @@ -1695,7 +1695,7 @@ async def user_review_score(
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Get review score statistics for a specific user within a project.
Get review score statistics for a specific user within a project. Only allowed for accounts with reviewing features enabled.

Parameters
----------
Expand Down
Loading
Loading