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
11 changes: 11 additions & 0 deletions .mock/definition/__package__.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4103,6 +4103,17 @@ types:
workspace: optional<integer>
source:
openapi: openapi/openapi.yaml
LseProjectParams:
properties:
annotator_params: optional<unknown>
use_kappa:
type: optional<boolean>
docs: >-
If categorical variables are used in labeling (e.g. choices), Cohen's
Kappa statistic is computed to measure inter-rater reliability instead
of basic agreement
source:
openapi: openapi/openapi.yaml
LseProjectResponseSampling:
discriminated: false
union:
Expand Down
154 changes: 0 additions & 154 deletions .mock/definition/projects.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1045,138 +1045,6 @@ service:
created: 1
audiences:
- public
api_projects_members_create:
path: /api/projects/{id}/members/
method: POST
auth: true
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Add a member to a specific project.
source:
openapi: openapi/openapi.yaml
path-parameters:
id: integer
display-name: Add project member
request:
name: ProjectMemberRequest
body:
properties:
user: integer
content-type: application/json
response:
docs: ''
type: root.ProjectMember
examples:
- path-parameters:
id: 1
request:
user: 1
response:
body:
user: 1
api_projects_members_destroy:
path: /api/projects/{id}/members/
method: DELETE
auth: true
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Remove a member from a specific project.
source:
openapi: openapi/openapi.yaml
path-parameters:
id: integer
display-name: Remove member from project
request:
name: ApiProjectsMembersDestroyRequest
query-parameters:
project_member:
type: optional<integer>
docs: A unique integer value identifying this project member.
examples:
- path-parameters:
id: 1
api_projects_project_extra_params_retrieve:
path: /api/projects/{id}/project-extra-params/
method: GET
auth: true
docs: >-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Retrieve the annotator weights for statistics and Cohen's Kappa for a
specific project.
source:
openapi: openapi/openapi.yaml
path-parameters:
id: integer
display-name: Get annotator weights
response:
docs: Annotator weights retrieved
type: ApiProjectsProjectExtraParamsRetrieveResponse
examples:
- path-parameters:
id: 1
response:
body:
annotator_params:
- key: value
use_kappa: true
api_projects_project_extra_params_create:
path: /api/projects/{id}/project-extra-params/
method: POST
auth: true
docs: >-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Create annotator weights to be used in the annotation statistics for a
project, such as when calculating kappa metrics for inter-annotator
agreement.
source:
openapi: openapi/openapi.yaml
path-parameters:
id: integer
display-name: Create annotator weights for statistics
request:
name: LseProjectParamsRequest
body:
properties:
annotator_params: optional<unknown>
use_kappa:
type: optional<boolean>
docs: >-
If categorical variables are used in labeling (e.g. choices),
Cohen's Kappa statistic is computed to measure inter-rater
reliability instead of basic agreement
content-type: application/json
response:
docs: Annotator weights created/updated
type: ApiProjectsProjectExtraParamsCreateResponse
examples:
- path-parameters:
id: 1
request: {}
response:
body:
annotator_params:
- key: value
use_kappa: true
api_projects_reimports_retrieve:
path: /api/projects/{id}/reimports/{reimport_pk}/
method: GET
Expand Down Expand Up @@ -1402,25 +1270,3 @@ types:
docs: Number of predictions created
source:
openapi: openapi/openapi.yaml
ApiProjectsProjectExtraParamsRetrieveResponse:
docs: Create or change annotator weights for statistics
properties:
annotator_params:
type: optional<list<map<string, unknown>>>
docs: Dict of users with weights
use_kappa:
type: optional<boolean>
docs: If project uses Cohen's Kappa in calculation
source:
openapi: openapi/openapi.yaml
ApiProjectsProjectExtraParamsCreateResponse:
docs: Create or change annotator weights for statistics
properties:
annotator_params:
type: optional<list<map<string, unknown>>>
docs: Dict of users with weights
use_kappa:
type: optional<boolean>
docs: If project uses Cohen's Kappa in calculation
source:
openapi: openapi/openapi.yaml
89 changes: 89 additions & 0 deletions .mock/definition/projects/annotatorWeights.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
imports:
root: ../__package__.yml
service:
auth: false
base-path: ''
endpoints:
get:
path: /api/projects/{id}/project-extra-params/
method: GET
auth: true
docs: >-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Retrieve the annotator weights for statistics and Cohen's Kappa for a
specific project. Affects dashboard-members stats, but old and unused.
source:
openapi: openapi/openapi.yaml
path-parameters:
id: integer
display-name: Get annotator weights
response:
docs: Annotator weights retrieved
type: root.LseProjectParams
examples:
- path-parameters:
id: 1
response:
body:
annotator_params:
key: value
use_kappa: true
audiences:
- internal
create:
path: /api/projects/{id}/project-extra-params/
method: POST
auth: true
docs: >-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Create annotator weights to be used in the annotation statistics for a
project, such as when calculating kappa metrics for inter-annotator
agreement. Affects dashboard-members stats, but old and unused.
source:
openapi: openapi/openapi.yaml
path-parameters:
id: integer
display-name: Create annotator weights for statistics
request:
name: LseProjectParamsRequest
body:
properties:
annotator_params: optional<unknown>
use_kappa:
type: optional<boolean>
docs: >-
If categorical variables are used in labeling (e.g. choices),
Cohen's Kappa statistic is computed to measure inter-rater
reliability instead of basic agreement
content-type: application/json
response:
docs: Annotator weights created/updated
type: root.LseProjectParams
examples:
- name: payload format for annotator_params
path-parameters:
id: 1
request:
annotator_params:
'123': 1
'456': 0.75
use_kappa: true
response:
body:
annotator_params:
key: value
use_kappa: true
audiences:
- internal
source:
openapi: openapi/openapi.yaml
68 changes: 62 additions & 6 deletions .mock/definition/projects/members.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,11 @@ service:
method: GET
auth: true
docs: >-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Retrieve the members for a specific project. Optionally filter by user
IDs (comma-separated).


Does NOT include annotators. Deprecated; use paginated endpoint.
source:
openapi: openapi/openapi.yaml
path-parameters:
Expand All @@ -33,6 +30,7 @@ service:
response:
docs: List of users with membership information
type: list<root.LseUser>
availability: deprecated
examples:
- path-parameters:
id: 1
Expand Down Expand Up @@ -76,6 +74,64 @@ service:
pause: pause
phone: phone
username: username
audiences:
- internal
add:
path: /api/projects/{id}/members/
method: POST
auth: true
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Add a member to a specific project.
source:
openapi: openapi/openapi.yaml
path-parameters:
id: integer
display-name: Add project member
request:
name: ProjectMemberRequest
body:
properties:
user: integer
content-type: application/json
response:
docs: ''
type: root.ProjectMember
examples:
- path-parameters:
id: 1
request:
user: 1
response:
body:
user: 1
audiences:
- public
remove:
path: /api/projects/{id}/members/
method: DELETE
auth: true
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Remove a member from a specific project.
source:
openapi: openapi/openapi.yaml
path-parameters:
id: integer
display-name: Remove member from project
examples:
- path-parameters:
id: 1
audiences:
- public
source:
Expand Down
Loading
Loading