diff --git a/.mock/definition/activityLogs.yml b/.mock/definition/activityLogs.yml index 0532b45d7..4b08cc640 100644 --- a/.mock/definition/activityLogs.yml +++ b/.mock/definition/activityLogs.yml @@ -21,6 +21,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve activity logs filtered by workspace, project, user, HTTP method, date range or search query. source: diff --git a/.mock/definition/annotationHistory.yml b/.mock/definition/annotationHistory.yml index c569c27f7..4538afec7 100644 --- a/.mock/definition/annotationHistory.yml +++ b/.mock/definition/annotationHistory.yml @@ -9,6 +9,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ 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 @@ -54,6 +60,12 @@ service: method: DELETE auth: true docs: >- + + Label Studio Enterprise badge +

+ 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. @@ -85,7 +97,14 @@ service: path: /api/projects/{id}/annotation-history/ method: GET auth: true - docs: List all annotation history items for the project with pagination. + docs: |- + + Label Studio Enterprise badge +

+ 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. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/annotationReviews.yml b/.mock/definition/annotationReviews.yml index c8d2f95eb..5bb8d73a0 100644 --- a/.mock/definition/annotationReviews.yml +++ b/.mock/definition/annotationReviews.yml @@ -8,7 +8,14 @@ service: path: /api/annotation-reviews/ method: GET auth: true - docs: List all reviews for a specific annotation ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + List all reviews for a specific annotation ID. source: openapi: openapi/openapi.yaml display-name: List reviews @@ -44,7 +51,14 @@ service: path: /api/annotation-reviews/ method: POST auth: true - docs: Create a review for a specific annotation ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a review for a specific annotation ID. source: openapi: openapi/openapi.yaml display-name: Create review @@ -82,7 +96,14 @@ service: path: /api/annotation-reviews/{id}/ method: GET auth: true - docs: Retrieve a specific review by ID for an annotation. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a specific review by ID for an annotation. source: openapi: openapi/openapi.yaml path-parameters: @@ -116,7 +137,14 @@ service: path: /api/annotation-reviews/{id}/ method: PUT auth: true - docs: Overwrite a specific review by ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Overwrite a specific review by ID. source: openapi: openapi/openapi.yaml path-parameters: @@ -155,7 +183,14 @@ service: path: /api/annotation-reviews/{id}/ method: DELETE auth: true - docs: Delete a review by ID + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a review by ID source: openapi: openapi/openapi.yaml path-parameters: @@ -172,7 +207,14 @@ service: path: /api/annotation-reviews/{id}/ method: PATCH auth: true - docs: Update a specific review by ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific review by ID. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/billing.yml b/.mock/definition/billing.yml index f8c4d9f7e..7f2e6f708 100644 --- a/.mock/definition/billing.yml +++ b/.mock/definition/billing.yml @@ -8,7 +8,14 @@ service: path: /api/billing/info method: GET auth: true - docs: Retrieve billing checks and feature flags for the active organization. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve billing checks and feature flags for the active organization. source: openapi: openapi/openapi.yaml display-name: Get billing info diff --git a/.mock/definition/comments.yml b/.mock/definition/comments.yml index 260ea6597..00546071c 100644 --- a/.mock/definition/comments.yml +++ b/.mock/definition/comments.yml @@ -8,7 +8,14 @@ service: path: /api/comments/ method: GET auth: true - docs: List all comments for a specific annotation ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + List all comments for a specific annotation ID. source: openapi: openapi/openapi.yaml display-name: List comments @@ -50,7 +57,14 @@ service: path: /api/comments/ method: POST auth: true - docs: Create a comment for a specific annotation ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a comment for a specific annotation ID. source: openapi: openapi/openapi.yaml display-name: Create comment @@ -90,7 +104,14 @@ service: path: /api/comments/export/ method: GET auth: true - docs: Export comments to CSV file + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Export comments to CSV file source: openapi: openapi/openapi.yaml display-name: Export comments to CSV @@ -116,7 +137,14 @@ service: path: /api/comments/{id}/ method: GET auth: true - docs: Retrieve a specific comment by ID for an annotation. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a specific comment by ID for an annotation. source: openapi: openapi/openapi.yaml path-parameters: @@ -157,7 +185,14 @@ service: path: /api/comments/{id}/ method: PUT auth: true - docs: Overwrite a specific comment by ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Overwrite a specific comment by ID. source: openapi: openapi/openapi.yaml path-parameters: @@ -201,7 +236,14 @@ service: path: /api/comments/{id}/ method: DELETE auth: true - docs: Delete a comment by ID + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a comment by ID source: openapi: openapi/openapi.yaml path-parameters: @@ -222,7 +264,14 @@ service: path: /api/comments/{id}/ method: PATCH auth: true - docs: Update a specific comment by ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific comment by ID. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/exportStorage/azureSpi.yml b/.mock/definition/exportStorage/azureSpi.yml index 962f93d34..edf783cc1 100644 --- a/.mock/definition/exportStorage/azureSpi.yml +++ b/.mock/definition/exportStorage/azureSpi.yml @@ -9,6 +9,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all Azure export storage connections that were set up with Service Principal authentication. source: @@ -60,6 +66,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create an Azure export storage connection with Service Principal authentication to store annotations. source: @@ -107,6 +119,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific Azure export storage connection that was set up with Service Principal authentication. source: @@ -125,6 +143,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific Azure export storage connection that was set up with Service Principal authentication. source: @@ -171,6 +195,12 @@ service: method: DELETE auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific Azure export storage connection that was set up with Service Principal authentication. source: @@ -188,6 +218,12 @@ service: method: PATCH auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific Azure export storage connection that was set up with Service Principal authentication. source: @@ -302,7 +338,14 @@ service: path: /api/storages/export/azure_spi/{id}/sync method: POST auth: true - docs: Sync tasks from an Azure SPI export storage. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Sync tasks from an Azure SPI export storage. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/exportStorage/databricks.yml b/.mock/definition/exportStorage/databricks.yml index acc8b8c1a..55bfde3d8 100644 --- a/.mock/definition/exportStorage/databricks.yml +++ b/.mock/definition/exportStorage/databricks.yml @@ -8,7 +8,14 @@ service: path: /api/storages/export/databricks method: GET auth: true - docs: Get a list of all Databricks Files export storage connections. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a list of all Databricks Files export storage connections. source: openapi: openapi/openapi.yaml display-name: List Databricks export storages @@ -58,7 +65,14 @@ service: path: /api/storages/export/databricks method: POST auth: true - docs: Create a Databricks Files export storage connection. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a Databricks Files export storage connection. source: openapi: openapi/openapi.yaml display-name: Create Databricks export storage @@ -108,7 +122,14 @@ service: path: /api/storages/export/databricks/validate method: POST auth: true - docs: Validate a specific Databricks Files export storage connection. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Validate a specific Databricks Files export storage connection. source: openapi: openapi/openapi.yaml display-name: Validate Databricks export storage @@ -128,7 +149,14 @@ service: path: /api/storages/export/databricks/{id} method: GET auth: true - docs: Get a specific Databricks Files export storage connection. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a specific Databricks Files export storage connection. source: openapi: openapi/openapi.yaml path-parameters: @@ -173,7 +201,14 @@ service: path: /api/storages/export/databricks/{id} method: DELETE auth: true - docs: Delete a specific Databricks Files export storage connection. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a specific Databricks Files export storage connection. source: openapi: openapi/openapi.yaml path-parameters: @@ -188,7 +223,14 @@ service: path: /api/storages/export/databricks/{id} method: PATCH auth: true - docs: Update a specific Databricks Files export storage connection. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific Databricks Files export storage connection. source: openapi: openapi/openapi.yaml path-parameters: @@ -318,7 +360,14 @@ service: path: /api/storages/export/databricks/{id}/sync method: POST auth: true - docs: Export annotations to a Databricks Files storage. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Export annotations to a Databricks Files storage. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/exportStorage/gcswif.yml b/.mock/definition/exportStorage/gcswif.yml index 5cf7e8d1c..da250b18f 100644 --- a/.mock/definition/exportStorage/gcswif.yml +++ b/.mock/definition/exportStorage/gcswif.yml @@ -9,6 +9,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all GCS export storage connections that were set up with WIF authentication. source: @@ -61,6 +67,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create an GCS export storage connection with WIF authentication to store annotations. source: @@ -109,6 +121,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific GCS export storage connection that was set up with WIF authentication. source: @@ -127,6 +145,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific GCS export storage connection that was set up with WIF authentication. source: @@ -174,6 +198,12 @@ service: method: DELETE auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific GCS export storage connection that was set up with WIF authentication. source: @@ -191,6 +221,12 @@ service: method: PATCH auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific GCS export storage connection that was set up with WIF authentication. source: @@ -309,7 +345,14 @@ service: path: /api/storages/export/gcswif/{id}/sync method: POST auth: true - docs: Sync tasks from an GCS WIF export storage. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Sync tasks from an GCS WIF export storage. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/exportStorage/s3S.yml b/.mock/definition/exportStorage/s3S.yml index 348b15b35..dc613a366 100644 --- a/.mock/definition/exportStorage/s3S.yml +++ b/.mock/definition/exportStorage/s3S.yml @@ -9,6 +9,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all S3 export storage connections that were set up with IAM role access. source: @@ -64,6 +70,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create an S3 export storage connection with IAM role access to store annotations. source: @@ -116,6 +128,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific S3 export storage connection that was set up with IAM role access. source: @@ -135,6 +153,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific S3 export storage connection that was set up with IAM role access. source: @@ -185,6 +209,12 @@ service: method: DELETE auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific S3 export storage connection that was set up with IAM role access. source: @@ -202,6 +232,12 @@ service: method: PATCH auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific S3 export storage connection that was set up with IAM role access. source: @@ -332,7 +368,14 @@ service: path: /api/storages/export/s3s/{id}/sync method: POST auth: true - docs: Sync tasks from an S3 export storage. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Sync tasks from an S3 export storage. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/importStorage/azureSpi.yml b/.mock/definition/importStorage/azureSpi.yml index 7ae699522..f89caa463 100644 --- a/.mock/definition/importStorage/azureSpi.yml +++ b/.mock/definition/importStorage/azureSpi.yml @@ -9,6 +9,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get list of all Azure import storage connections set up with Service Principal authentication. source: @@ -61,7 +67,14 @@ service: path: /api/storages/azure_spi/ method: POST auth: true - docs: Create Azure import storage with Service Principal authentication. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create Azure import storage with Service Principal authentication. source: openapi: openapi/openapi.yaml display-name: Create Azure import storage with SPI @@ -109,6 +122,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific Azure import storage connection that was set up with Service Principal authentication. source: @@ -127,6 +146,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific Azure import storage connection that was set up with Service Principal authentication. source: @@ -175,6 +200,12 @@ service: method: DELETE auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific Azure import storage connection that was set up with Service Principal authentication. source: @@ -192,6 +223,12 @@ service: method: PATCH auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific Azure import storage connection that was set up with Service Principal authentication. source: @@ -318,6 +355,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an Azure import storage connection that was set up with Service Principal authentication. source: diff --git a/.mock/definition/importStorage/databricks.yml b/.mock/definition/importStorage/databricks.yml index 35a1f9f0a..8c3b3c242 100644 --- a/.mock/definition/importStorage/databricks.yml +++ b/.mock/definition/importStorage/databricks.yml @@ -8,7 +8,14 @@ service: path: /api/storages/databricks/ method: GET auth: true - docs: Get list of all Databricks Files import storage connections. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get list of all Databricks Files import storage connections. source: openapi: openapi/openapi.yaml display-name: List Databricks import storages @@ -60,7 +67,14 @@ service: path: /api/storages/databricks/ method: POST auth: true - docs: Create a Databricks Files import storage connection. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a Databricks Files import storage connection. source: openapi: openapi/openapi.yaml display-name: Create Databricks import storage @@ -112,7 +126,14 @@ service: path: /api/storages/databricks/validate method: POST auth: true - docs: Validate a specific Databricks Files import storage connection. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Validate a specific Databricks Files import storage connection. source: openapi: openapi/openapi.yaml display-name: Validate Databricks import storage @@ -132,7 +153,14 @@ service: path: /api/storages/databricks/{id} method: GET auth: true - docs: Get a specific Databricks Files import storage connection. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a specific Databricks Files import storage connection. source: openapi: openapi/openapi.yaml path-parameters: @@ -179,7 +207,14 @@ service: path: /api/storages/databricks/{id} method: DELETE auth: true - docs: Delete a specific Databricks Files import storage connection. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a specific Databricks Files import storage connection. source: openapi: openapi/openapi.yaml path-parameters: @@ -194,7 +229,14 @@ service: path: /api/storages/databricks/{id} method: PATCH auth: true - docs: Update a specific Databricks Files import storage connection. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific Databricks Files import storage connection. source: openapi: openapi/openapi.yaml path-parameters: @@ -335,7 +377,14 @@ service: path: /api/storages/databricks/{id}/sync method: POST auth: true - docs: Sync tasks from a Databricks Files import storage. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Sync tasks from a Databricks Files import storage. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/importStorage/gcswif.yml b/.mock/definition/importStorage/gcswif.yml index 14e417892..3111c24c0 100644 --- a/.mock/definition/importStorage/gcswif.yml +++ b/.mock/definition/importStorage/gcswif.yml @@ -9,6 +9,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get list of all GCS import storage connections set up with WIF authentication. source: @@ -62,7 +68,14 @@ service: path: /api/storages/gcswif/ method: POST auth: true - docs: Create GCS import storage with WIF. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create GCS import storage with WIF. source: openapi: openapi/openapi.yaml display-name: Create GCS import storage with WIF @@ -111,6 +124,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific GCS import storage connection that was set up with WIF authentication. source: @@ -128,7 +147,14 @@ service: path: /api/storages/gcswif/{id} method: GET auth: true - docs: Get a specific GCS import storage connection that was set up with WIF. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a specific GCS import storage connection that was set up with WIF. source: openapi: openapi/openapi.yaml path-parameters: @@ -176,6 +202,12 @@ service: method: DELETE auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific GCS import storage connection that was set up with WIF authentication. source: @@ -193,6 +225,12 @@ service: method: PATCH auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific GCS import storage connection that was set up with WIF authentication. source: @@ -323,6 +361,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an GCS import storage connection that was set up with WIF authentication. source: diff --git a/.mock/definition/importStorage/s3S.yml b/.mock/definition/importStorage/s3S.yml index f11ecbdf2..c764e0bf7 100644 --- a/.mock/definition/importStorage/s3S.yml +++ b/.mock/definition/importStorage/s3S.yml @@ -9,6 +9,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get list of all S3 import storage connections set up with IAM role access. source: @@ -65,7 +71,14 @@ service: path: /api/storages/s3s/ method: POST auth: true - docs: Create S3 import storage with IAM role access. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create S3 import storage with IAM role access. source: openapi: openapi/openapi.yaml display-name: Create import storage @@ -118,6 +131,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific S3 import storage connection that was set up with IAM role access. source: @@ -137,6 +156,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific S3 import storage connection that was set up with IAM role access. source: @@ -189,6 +214,12 @@ service: method: DELETE auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific S3 import storage connection that was set up with IAM role access. source: @@ -206,6 +237,12 @@ service: method: PATCH auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific S3 import storage connection that was set up with IAM role access. source: @@ -348,6 +385,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an S3 import storage connection that was set up with IAM role access. source: diff --git a/.mock/definition/ml.yml b/.mock/definition/ml.yml index b3d16dc37..d8deaab72 100644 --- a/.mock/definition/ml.yml +++ b/.mock/definition/ml.yml @@ -314,7 +314,12 @@ service: method: POST auth: true docs: >- - Note: not available in the community edition of Label Studio. + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create predictions for all tasks using a specific ML backend so that you diff --git a/.mock/definition/modelProviderConnection.yml b/.mock/definition/modelProviderConnection.yml index d09b32f2d..06f783fa5 100644 --- a/.mock/definition/modelProviderConnection.yml +++ b/.mock/definition/modelProviderConnection.yml @@ -8,7 +8,14 @@ service: path: /api/model-provider-connections/{id}/ method: PUT auth: true - docs: Overwrite a specific model provider connection by ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Overwrite a specific model provider connection by ID. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/modelProviders.yml b/.mock/definition/modelProviders.yml index c4bf1ae32..42e4fe379 100644 --- a/.mock/definition/modelProviders.yml +++ b/.mock/definition/modelProviders.yml @@ -8,7 +8,14 @@ service: path: /api/model-provider-connections/ method: GET auth: true - docs: List all model provider connections. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + List all model provider connections. source: openapi: openapi/openapi.yaml display-name: List model provider connections @@ -54,7 +61,14 @@ service: path: /api/model-provider-connections/ method: POST auth: true - docs: Create a new model provider connection. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a new model provider connection. source: openapi: openapi/openapi.yaml display-name: Create model provider connection @@ -98,7 +112,14 @@ service: path: /api/model-provider-connections/provider-choices method: GET auth: true - docs: List all possible model provider choices + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + List all possible model provider choices source: openapi: openapi/openapi.yaml display-name: List model provider choices @@ -116,7 +137,14 @@ service: path: /api/model-provider-connections/{id}/ method: GET auth: true - docs: Retrieve a specific model provider connection. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a specific model provider connection. source: openapi: openapi/openapi.yaml path-parameters: @@ -160,7 +188,14 @@ service: path: /api/model-provider-connections/{id}/ method: DELETE auth: true - docs: Delete a model provider connection by ID + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a model provider connection by ID source: openapi: openapi/openapi.yaml path-parameters: @@ -175,7 +210,14 @@ service: path: /api/model-provider-connections/{id}/ method: PATCH auth: true - docs: Update a specific model provider connection by ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific model provider connection by ID. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/organizations.yml b/.mock/definition/organizations.yml index 0c0ae782d..72cd4c784 100644 --- a/.mock/definition/organizations.yml +++ b/.mock/definition/organizations.yml @@ -94,6 +94,12 @@ service: method: PATCH auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update organization details including title, embed domains, and Plugins settings. source: @@ -163,7 +169,14 @@ service: path: /api/organizations/{id}/set-default-role method: PATCH auth: true - docs: Update the default role for members of a specific organization. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update the default role for members of a specific organization. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/organizations/invites.yml b/.mock/definition/organizations/invites.yml index f4b39b3e7..5c9d52545 100644 --- a/.mock/definition/organizations/invites.yml +++ b/.mock/definition/organizations/invites.yml @@ -28,7 +28,14 @@ service: path: /api/invite/revoke method: POST auth: true - docs: Revoke invite to organization + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Revoke invite to organization source: openapi: openapi/openapi.yaml display-name: Revoke invite @@ -50,7 +57,14 @@ service: path: /api/invite/send-email method: POST auth: true - docs: Send email with invite to organization + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Send email with invite to organization source: openapi: openapi/openapi.yaml display-name: Send email with invite diff --git a/.mock/definition/organizations/members.yml b/.mock/definition/organizations/members.yml index 0857be759..d20a22e77 100644 --- a/.mock/definition/organizations/members.yml +++ b/.mock/definition/organizations/members.yml @@ -8,7 +8,14 @@ service: path: /api/organizations/{id}/memberships method: GET auth: true - docs: Retrieve a list of all users and roles in a specific organization. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a list of all users and roles in a specific organization. source: openapi: openapi/openapi.yaml path-parameters: @@ -78,6 +85,12 @@ service: method: PATCH auth: true docs: >+ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update organization membership or role for a specific user ID. diff --git a/.mock/definition/organizations/permissions.yml b/.mock/definition/organizations/permissions.yml index 48156d066..de64f0363 100644 --- a/.mock/definition/organizations/permissions.yml +++ b/.mock/definition/organizations/permissions.yml @@ -9,6 +9,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all organization-level permission overrides for a given organization. source: @@ -49,6 +55,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new organization-level permission override for a given organization. source: @@ -91,6 +103,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve the list of configurable permission options (label, tooltip, default role and allowed roles). source: @@ -163,6 +181,12 @@ service: method: PUT auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Replace the organization-level permission override for a given permission key. source: @@ -231,6 +255,12 @@ service: method: PATCH auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Partially update the organization-level permission override for a given permission key. source: diff --git a/.mock/definition/pauses.yml b/.mock/definition/pauses.yml index a7ab6b91c..6d859645c 100644 --- a/.mock/definition/pauses.yml +++ b/.mock/definition/pauses.yml @@ -8,7 +8,14 @@ service: path: /api/projects/{project_pk}/members/{user_pk}/pauses/{id}/ method: PUT auth: true - docs: Overwrite a pause entry by ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Overwrite a pause entry by ID. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/projectRoles.yml b/.mock/definition/projectRoles.yml index b823c6ff4..5a7e176ed 100644 --- a/.mock/definition/projectRoles.yml +++ b/.mock/definition/projectRoles.yml @@ -8,7 +8,13 @@ service: path: /api/projects/roles/ method: GET auth: true - docs: |2- + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List project roles for requested IDs for the current user @@ -36,7 +42,13 @@ service: path: /api/projects/roles/ method: POST auth: true - docs: |2- + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create project role for user allowing the user the same access level provided by organization role. @@ -80,7 +92,13 @@ service: path: /api/projects/roles/{id}/ method: DELETE auth: true - docs: |2- + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Remove project role for user allowing the user the same access level provided by organization role. @@ -98,7 +116,13 @@ service: path: /api/projects/{id}/roles method: GET auth: true - docs: |2- + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List users and their project level roles for a given project. If user is not listed here and is a member of the project then they would behave as assigned role in organization. diff --git a/.mock/definition/projectTemplates.yml b/.mock/definition/projectTemplates.yml index 474335811..14055c9b1 100644 --- a/.mock/definition/projectTemplates.yml +++ b/.mock/definition/projectTemplates.yml @@ -8,7 +8,14 @@ service: path: /api/project-templates/ method: GET auth: true - docs: Get a list of all project templates for an organization. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a list of all project templates for an organization. source: openapi: openapi/openapi.yaml display-name: Get project templates @@ -48,7 +55,14 @@ service: path: /api/project-templates/ method: POST auth: true - docs: Create a project template for an organization. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a project template for an organization. source: openapi: openapi/openapi.yaml display-name: Create project template @@ -88,7 +102,14 @@ service: path: /api/project-templates/{id} method: GET auth: true - docs: Get a specific project template by ID for an organization. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a specific project template by ID for an organization. source: openapi: openapi/openapi.yaml path-parameters: @@ -126,7 +147,14 @@ service: path: /api/project-templates/{id} method: PUT auth: true - docs: Overwrite a specific project template by ID for an organization. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Overwrite a specific project template by ID for an organization. source: openapi: openapi/openapi.yaml path-parameters: @@ -170,7 +198,14 @@ service: path: /api/project-templates/{id} method: DELETE auth: true - docs: Delete a specific project template by ID for an organization. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a specific project template by ID for an organization. source: openapi: openapi/openapi.yaml path-parameters: @@ -186,6 +221,12 @@ service: method: PATCH auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update the details of a specific project template by ID for an organization. source: @@ -257,6 +298,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a project from a specific project template by ID for an organization. source: diff --git a/.mock/definition/projects.yml b/.mock/definition/projects.yml index e184bdcaa..c7c8b45f1 100644 --- a/.mock/definition/projects.yml +++ b/.mock/definition/projects.yml @@ -839,7 +839,14 @@ service: path: /api/projects/{id}/duplicate/ method: POST auth: true - docs: Make a copy of project. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Make a copy of project. source: openapi: openapi/openapi.yaml path-parameters: @@ -1034,7 +1041,14 @@ service: path: /api/projects/{id}/members/ method: POST auth: true - docs: Add a member to a specific project. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Add a member to a specific project. source: openapi: openapi/openapi.yaml path-parameters: @@ -1061,7 +1075,14 @@ service: path: /api/projects/{id}/members/ method: DELETE auth: true - docs: Remove a member from a specific project. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Remove a member from a specific project. source: openapi: openapi/openapi.yaml path-parameters: @@ -1081,6 +1102,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve the annotator weights for statistics and Cohen's Kappa for a specific project. source: @@ -1104,6 +1131,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create annotator weights to be used in the annotation statistics for a project, such as when calculating kappa metrics for inter-annotator agreement. diff --git a/.mock/definition/projects/assignments.yml b/.mock/definition/projects/assignments.yml index 0540b049c..3ceb89e45 100644 --- a/.mock/definition/projects/assignments.yml +++ b/.mock/definition/projects/assignments.yml @@ -344,6 +344,12 @@ service: method: POST auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Assign multiple users to a collection of tasks within a specific project. source: @@ -404,6 +410,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a list of tasks and assignees for those tasks for a specific project. source: @@ -436,7 +448,14 @@ service: path: /api/projects/{id}/tasks/{task_pk}/assignees method: POST auth: true - docs: Assign a user to a task in a specific project. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Assign a user to a task in a specific project. source: openapi: openapi/openapi.yaml path-parameters: @@ -482,7 +501,14 @@ service: path: /api/projects/{id}/tasks/{task_pk}/assignees method: DELETE auth: true - docs: Remove assignees for a task within a specific project. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Remove assignees for a task within a specific project. source: openapi: openapi/openapi.yaml path-parameters: @@ -516,7 +542,14 @@ service: path: /api/projects/{id}/tasks/{task_pk}/assignees method: PATCH auth: true - docs: Update the assignee for a task in a specific project. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update the assignee for a task in a specific project. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/projects/members.yml b/.mock/definition/projects/members.yml index 28a690e28..a75c582c9 100644 --- a/.mock/definition/projects/members.yml +++ b/.mock/definition/projects/members.yml @@ -9,6 +9,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve the members for a specific project. Optionally filter by user IDs (comma-separated). source: diff --git a/.mock/definition/projects/members/bulk.yml b/.mock/definition/projects/members/bulk.yml index b1e984044..42768d773 100644 --- a/.mock/definition/projects/members/bulk.yml +++ b/.mock/definition/projects/members/bulk.yml @@ -19,7 +19,14 @@ service: path: /api/projects/{id}/members/bulk/ method: POST auth: true - docs: Assign project members in bulk. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Assign project members in bulk. source: openapi: openapi/openapi.yaml path-parameters: @@ -58,6 +65,12 @@ service: method: DELETE auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Unassign project members in bulk. Allows the same request body as bulk assign. source: diff --git a/.mock/definition/projects/members/paginated.yml b/.mock/definition/projects/members/paginated.yml index 8c58997d0..9c6a6bc11 100644 --- a/.mock/definition/projects/members/paginated.yml +++ b/.mock/definition/projects/members/paginated.yml @@ -8,7 +8,14 @@ service: path: /api/projects/{id}/members/paginated/ method: GET auth: true - docs: Retrieve the members for a specific project. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve the members for a specific project. pagination: offset: $request.page results: $response.results diff --git a/.mock/definition/projects/metrics.yml b/.mock/definition/projects/metrics.yml index be1c339c0..8acb0cec3 100644 --- a/.mock/definition/projects/metrics.yml +++ b/.mock/definition/projects/metrics.yml @@ -8,7 +8,14 @@ service: path: /api/projects/{id}/metricparam/ method: GET auth: true - docs: Get the current metrics configuration for a project. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get the current metrics configuration for a project. source: openapi: openapi/openapi.yaml path-parameters: @@ -34,7 +41,14 @@ service: path: /api/projects/{id}/metricparam/ method: POST auth: true - docs: Update metrics strategy and parameters for a project. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update metrics strategy and parameters for a project. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/projects/pauses.yml b/.mock/definition/projects/pauses.yml index a5e2524c7..9b36122f4 100644 --- a/.mock/definition/projects/pauses.yml +++ b/.mock/definition/projects/pauses.yml @@ -8,7 +8,14 @@ service: path: /api/projects/{project_pk}/members/{user_pk}/pauses/ method: GET auth: true - docs: Retrieve a list of all pauses. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a list of all pauses. source: openapi: openapi/openapi.yaml path-parameters: @@ -54,7 +61,14 @@ service: path: /api/projects/{project_pk}/members/{user_pk}/pauses/ method: POST auth: true - docs: Create a new pause entry. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a new pause entry. source: openapi: openapi/openapi.yaml path-parameters: @@ -96,7 +110,14 @@ service: path: /api/projects/{project_pk}/members/{user_pk}/pauses/{id}/ method: GET auth: true - docs: Retrieve a specific pause by ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a specific pause by ID. source: openapi: openapi/openapi.yaml path-parameters: @@ -135,7 +156,14 @@ service: path: /api/projects/{project_pk}/members/{user_pk}/pauses/{id}/ method: DELETE auth: true - docs: Delete a specific pause by ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a specific pause by ID. source: openapi: openapi/openapi.yaml path-parameters: @@ -154,7 +182,14 @@ service: path: /api/projects/{project_pk}/members/{user_pk}/pauses/{id}/ method: PATCH auth: true - docs: Partially update a pause entry by ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Partially update a pause entry by ID. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/projects/stats.yml b/.mock/definition/projects/stats.yml index ecf24f8d4..3b8c9c173 100644 --- a/.mock/definition/projects/stats.yml +++ b/.mock/definition/projects/stats.yml @@ -1,4 +1,19 @@ types: + StatsModelVersionAnnotatorAgreementResponse: + properties: + agreement: optional + source: + openapi: openapi/openapi.yaml + StatsModelVersionGroundTruthAgreementResponse: + properties: + agreement: optional + source: + openapi: openapi/openapi.yaml + StatsModelVersionPredictionAgreementResponse: + properties: + average_prediction_agreement_per_model: optional + source: + openapi: openapi/openapi.yaml StatsIaaResponseIaa: discriminated: false docs: >- @@ -216,11 +231,124 @@ service: auth: false base-path: '' endpoints: + model_version_annotator_agreement: + path: /api/projects/{id}/model-stats/{model_version}/agreement + method: GET + auth: true + docs: >- + + Label Studio Enterprise badge +

+ 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. + source: + openapi: openapi/openapi.yaml + path-parameters: + id: integer + model_version: string + display-name: Get model-version overall agreement vs annotators + response: + docs: Model-version overall agreement vs annotators + type: StatsModelVersionAnnotatorAgreementResponse + examples: + - path-parameters: + id: 1 + model_version: model_version + response: + body: + agreement: 1.1 + audiences: + - public + model_version_ground_truth_agreement: + path: /api/projects/{id}/model-stats/{model_version}/agreement-groundtruth + method: GET + auth: true + docs: >- + + Label Studio Enterprise badge +

+ 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. + source: + openapi: openapi/openapi.yaml + path-parameters: + id: integer + model_version: string + display-name: Get model-version ground truth agreement + request: + name: StatsModelVersionGroundTruthAgreementRequest + query-parameters: + per_label: + type: optional + default: false + docs: Calculate agreement per label + response: + docs: Model-version ground truth agreement + type: StatsModelVersionGroundTruthAgreementResponse + examples: + - path-parameters: + id: 1 + model_version: model_version + response: + body: + agreement: 1.1 + audiences: + - public + model_version_prediction_agreement: + path: /api/projects/{id}/model-stats/{model_version}/prediction + method: GET + auth: true + docs: >- + + Label Studio Enterprise badge +

+ 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. + source: + openapi: openapi/openapi.yaml + path-parameters: + id: integer + model_version: string + display-name: Get model-version prediction agreement + request: + name: StatsModelVersionPredictionAgreementRequest + query-parameters: + per_label: + type: optional + default: false + docs: Calculate agreement per label + response: + docs: Model-version prediction agreement + type: StatsModelVersionPredictionAgreementResponse + examples: + - path-parameters: + id: 1 + model_version: model_version + response: + body: + average_prediction_agreement_per_model: 1.1 + audiences: + - public iaa: path: /api/projects/{id}/stats/IAA method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ 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. source: @@ -311,7 +439,14 @@ service: path: /api/projects/{id}/stats/agreement_annotator/{user_id} method: GET auth: true - docs: Get agreement statistics for a specific annotator within a project. + docs: |- + + Label Studio Enterprise badge +

+ 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. source: openapi: openapi/openapi.yaml path-parameters: @@ -416,6 +551,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ 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. @@ -476,6 +617,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ 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. source: @@ -506,7 +653,14 @@ service: path: /api/projects/{id}/user-stats/{user_pk}/review_score method: GET auth: true - docs: Get review score statistics for a specific user within a project. + docs: |- + + Label Studio Enterprise badge +

+ 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. source: openapi: openapi/openapi.yaml path-parameters: @@ -537,6 +691,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ 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. source: diff --git a/.mock/definition/prompts.yml b/.mock/definition/prompts.yml index d6c94219a..9ec53d8a6 100644 --- a/.mock/definition/prompts.yml +++ b/.mock/definition/prompts.yml @@ -8,7 +8,14 @@ service: path: /api/model-run/batch-failed-predictions method: POST auth: true - docs: Create a new batch of failed predictions. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a new batch of failed predictions. source: openapi: openapi/openapi.yaml display-name: Create batch of failed predictions @@ -48,7 +55,14 @@ service: path: /api/model-run/batch-predictions method: POST auth: true - docs: Create a new batch prediction. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a new batch prediction. source: openapi: openapi/openapi.yaml display-name: Create batch predictions @@ -88,7 +102,13 @@ service: path: /api/projects/{project_pk}/subset-tasks method: GET auth: true - docs: |2- + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Provides list of tasks, based on project subset. Includes predictions for tasks. For the 'HasGT' subset, accuracy metrics will also be provided. @@ -149,7 +169,13 @@ service: path: /api/projects/{project_pk}/subsets method: GET auth: true - docs: |2- + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Provides list of available subsets for a project along with count of tasks in each subset @@ -223,7 +249,14 @@ service: path: /api/prompts/ method: POST auth: true - docs: Create a new prompt. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a new prompt. source: openapi: openapi/openapi.yaml display-name: Create prompt @@ -382,7 +415,14 @@ service: path: /api/prompts/{id}/ method: GET auth: true - docs: Retrieve a specific prompt. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a specific prompt. source: openapi: openapi/openapi.yaml path-parameters: @@ -422,7 +462,14 @@ service: path: /api/prompts/{id}/ method: PUT auth: true - docs: Overwrite a specific prompt by ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Overwrite a specific prompt by ID. source: openapi: openapi/openapi.yaml path-parameters: @@ -466,7 +513,14 @@ service: path: /api/prompts/{id}/ method: DELETE auth: true - docs: Delete a prompt by ID + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a prompt by ID source: openapi: openapi/openapi.yaml path-parameters: @@ -481,7 +535,14 @@ service: path: /api/prompts/{id}/ method: PATCH auth: true - docs: Update a specific prompt by ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific prompt by ID. source: openapi: openapi/openapi.yaml path-parameters: @@ -543,7 +604,14 @@ service: path: /api/prompts/{prompt_id}/versions/{version_id} method: PUT auth: true - docs: Overwrite a specific prompt version by ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Overwrite a specific prompt version by ID. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/prompts/indicators.yml b/.mock/definition/prompts/indicators.yml index 50ab4e2c4..70f93a344 100644 --- a/.mock/definition/prompts/indicators.yml +++ b/.mock/definition/prompts/indicators.yml @@ -13,7 +13,14 @@ service: path: /api/inference-runs/{id}/indicators/ method: GET auth: true - docs: Get key indicators for the Prompt dashboard. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get key indicators for the Prompt dashboard. source: openapi: openapi/openapi.yaml path-parameters: @@ -36,7 +43,14 @@ service: path: /api/inference-runs/{id}/indicators/{indicator_key} method: GET auth: true - docs: Get a specific key indicator for the Prompt dashboard. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a specific key indicator for the Prompt dashboard. source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/prompts/runs.yml b/.mock/definition/prompts/runs.yml index 82c606df0..f049150dd 100644 --- a/.mock/definition/prompts/runs.yml +++ b/.mock/definition/prompts/runs.yml @@ -16,7 +16,14 @@ service: path: /api/prompts/{prompt_id}/versions/{version_id}/inference-runs method: GET auth: true - docs: Get information (status, metadata, etc) about an existing inference run + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get information (status, metadata, etc) about an existing inference run source: openapi: openapi/openapi.yaml path-parameters: @@ -71,7 +78,14 @@ service: path: /api/prompts/{prompt_id}/versions/{version_id}/inference-runs method: POST auth: true - docs: Run a prompt inference. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Run a prompt inference. source: openapi: openapi/openapi.yaml path-parameters: @@ -140,7 +154,14 @@ service: /api/prompts/{prompt_id}/versions/{version_id}/inference-runs/{inference_run_id}/cancel method: POST auth: true - docs: Cancel the inference run for the given api + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Cancel the inference run for the given api source: openapi: openapi/openapi.yaml path-parameters: diff --git a/.mock/definition/prompts/versions.yml b/.mock/definition/prompts/versions.yml index 95119f0fa..488a17aed 100644 --- a/.mock/definition/prompts/versions.yml +++ b/.mock/definition/prompts/versions.yml @@ -6,7 +6,14 @@ service: path: /api/prompts/{id}/get-default-version-name method: GET auth: true - docs: Get default prompt version name + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get default prompt version name source: openapi: openapi/openapi.yaml path-parameters: @@ -21,7 +28,14 @@ service: path: /api/prompts/{prompt_id}/versions method: GET auth: true - docs: List all versions of a prompt. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + List all versions of a prompt. source: openapi: openapi/openapi.yaml path-parameters: @@ -64,7 +78,14 @@ service: path: /api/prompts/{prompt_id}/versions method: POST auth: true - docs: Create a new version of a prompt. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a new version of a prompt. source: openapi: openapi/openapi.yaml path-parameters: @@ -108,7 +129,14 @@ service: path: /api/prompts/{prompt_id}/versions/{version_id} method: GET auth: true - docs: Retrieve a specific prompt of a model. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a specific prompt of a model. source: openapi: openapi/openapi.yaml path-parameters: @@ -147,7 +175,14 @@ service: path: /api/prompts/{prompt_id}/versions/{version_id} method: DELETE auth: true - docs: Delete a prompt version by ID + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a prompt version by ID source: openapi: openapi/openapi.yaml path-parameters: @@ -164,7 +199,14 @@ service: path: /api/prompts/{prompt_id}/versions/{version_id} method: PATCH auth: true - docs: Update a specific prompt version by ID. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific prompt version by ID. source: openapi: openapi/openapi.yaml path-parameters: @@ -244,6 +286,12 @@ service: method: GET auth: true docs: >- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get an estimate of the cost for making an inference run on the selected Prompt Version and Project/ProjectSubset source: diff --git a/.mock/definition/sso/saml.yml b/.mock/definition/sso/saml.yml index 3e7eca934..c7c6f5fc2 100644 --- a/.mock/definition/sso/saml.yml +++ b/.mock/definition/sso/saml.yml @@ -8,7 +8,14 @@ service: path: /api/saml/settings method: GET auth: true - docs: Retrieve SAML2 settings for the currently active organization. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve SAML2 settings for the currently active organization. source: openapi: openapi/openapi.yaml display-name: Retrieve SAML2 Settings @@ -35,7 +42,14 @@ service: path: /api/saml/settings method: POST auth: true - docs: Update SAML2 settings for the currently active organization. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update SAML2 settings for the currently active organization. source: openapi: openapi/openapi.yaml display-name: Update SAML2 Settings diff --git a/.mock/definition/sso/scim.yml b/.mock/definition/sso/scim.yml index f407efc3e..cba4efdbd 100644 --- a/.mock/definition/sso/scim.yml +++ b/.mock/definition/sso/scim.yml @@ -8,7 +8,14 @@ service: path: /api/scim/settings method: GET auth: true - docs: Retrieve SCIM settings for the currently active organization. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve SCIM settings for the currently active organization. source: openapi: openapi/openapi.yaml display-name: Retrieve SCIM Settings @@ -35,7 +42,14 @@ service: path: /api/scim/settings method: POST auth: true - docs: Update SCIM settings for the currently active organization. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update SCIM settings for the currently active organization. source: openapi: openapi/openapi.yaml display-name: Update SCIM Settings diff --git a/.mock/definition/stats.yml b/.mock/definition/stats.yml deleted file mode 100644 index 6c150e67c..000000000 --- a/.mock/definition/stats.yml +++ /dev/null @@ -1,132 +0,0 @@ -types: - ApiProjectsModelStatsAgreementRetrieveResponse: - properties: - agreement: optional - source: - openapi: openapi/openapi.yaml - ApiProjectsModelStatsAgreementGroundtruthRetrieveResponse: - properties: - agreement: optional - source: - openapi: openapi/openapi.yaml - ApiProjectsModelStatsPredictionRetrieveResponse: - properties: - average_prediction_agreement_per_model: optional - source: - openapi: openapi/openapi.yaml -service: - auth: false - base-path: '' - endpoints: - api_projects_model_stats_agreement_retrieve: - path: /api/projects/{id}/model-stats/{model_version}/agreement - method: GET - auth: true - docs: >- - Overall agreement between a given model version's predictions and all - annotators on overlapping tasks. - - Computed as the average of per-annotator agreement vs this model version - over annotators who overlap on at least one task. - - Mirrors IAA per annotator, but one side is the model. - - :return: {"agreement": float[0..1]} - source: - openapi: openapi/openapi.yaml - path-parameters: - id: integer - model_version: string - display-name: Get model-version overall agreement vs annotators - response: - docs: Model-version overall agreement vs annotators - type: ApiProjectsModelStatsAgreementRetrieveResponse - examples: - - path-parameters: - id: 1 - model_version: model_version - response: - body: - agreement: 1.1 - api_projects_model_stats_agreement_groundtruth_retrieve: - path: /api/projects/{id}/model-stats/{model_version}/agreement-groundtruth - method: GET - auth: true - docs: >- - Ground truth agreement for annotations that match predictions of a - specific model version. - - This mirrors gt_per_user_agreement but filters stats by tasks where - predictions have given model_version. - - :return: {"agreement": float[0..1]} - source: - openapi: openapi/openapi.yaml - path-parameters: - id: integer - model_version: string - display-name: Get model-version ground truth agreement - request: - name: ApiProjectsModelStatsAgreementGroundtruthRetrieveRequest - query-parameters: - per_label: - type: optional - default: false - docs: Calculate agreement per label - response: - docs: Model-version ground truth agreement - type: ApiProjectsModelStatsAgreementGroundtruthRetrieveResponse - examples: - - path-parameters: - id: 1 - model_version: model_version - response: - body: - agreement: 1.1 - api_projects_model_stats_prediction_retrieve: - path: /api/projects/{id}/model-stats/{model_version}/prediction - method: GET - auth: true - docs: >- - Mean agreement between the given model version and all other model - versions in the project. - - - Computed as the average of pairwise model-to-model agreement scores from - PredictionPairStats where either - - prediction pair's model_version_from or model_version_to equals the - provided model_version. - - - When per_label=true, returns a mapping of label -> average agreement - across the same set of pairs. - - - :return: {"average_prediction_agreement_per_model": float[0..1] | - {label: float[0..1]}} - source: - openapi: openapi/openapi.yaml - path-parameters: - id: integer - model_version: string - display-name: Get model-version prediction agreement - request: - name: ApiProjectsModelStatsPredictionRetrieveRequest - query-parameters: - per_label: - type: optional - default: false - docs: Calculate agreement per label - response: - docs: Model-version prediction agreement - type: ApiProjectsModelStatsPredictionRetrieveResponse - examples: - - path-parameters: - id: 1 - model_version: model_version - response: - body: - average_prediction_agreement_per_model: 1.1 - source: - openapi: openapi/openapi.yaml diff --git a/.mock/definition/users.yml b/.mock/definition/users.yml index e39a8f8c0..0bf809ace 100644 --- a/.mock/definition/users.yml +++ b/.mock/definition/users.yml @@ -8,7 +8,14 @@ service: path: /api/current-user method: GET auth: true - docs: Get info about the currently authenticated user. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get info about the currently authenticated user. source: openapi: openapi/openapi.yaml display-name: Get current user info @@ -47,7 +54,14 @@ service: path: /api/current-user method: PATCH auth: true - docs: Update details for the currently authenticated user. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update details for the currently authenticated user. source: openapi: openapi/openapi.yaml display-name: Update current user diff --git a/.mock/definition/versions.yml b/.mock/definition/versions.yml index 77ca4e0a8..1a1d395d5 100644 --- a/.mock/definition/versions.yml +++ b/.mock/definition/versions.yml @@ -8,7 +8,14 @@ service: path: /api/version/ method: GET auth: true - docs: Get version information about the Label Studio instance. + docs: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get version information about the Label Studio instance. source: openapi: openapi/openapi.yaml display-name: Get version information diff --git a/.mock/openapi/openapi.yaml b/.mock/openapi/openapi.yaml index 4ccfaca00..97f139dd3 100644 --- a/.mock/openapi/openapi.yaml +++ b/.mock/openapi/openapi.yaml @@ -8,7 +8,14 @@ info: paths: /api/activity-logs/: get: - description: Retrieve activity logs filtered by workspace, project, user, HTTP method, date range or search query. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve activity logs filtered by workspace, project, user, HTTP method, date range or search query. operationId: api_activity_logs_list parameters: - description: End date/time (ISO-8601) for log filtering. @@ -92,7 +99,14 @@ paths: x-fern-sdk-method-name: list /api/annotation-history/: delete: - description: Delete all annotation history items for a specific annotation, task or project. This method is available only for users with administrator roles. + description: |- + + Label Studio Enterprise badge +

+ 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. operationId: api_annotation_history_destroy parameters: - description: Annotation ID to delete annotation history items for. @@ -131,7 +145,14 @@ paths: x-fern-sdk-group-name: annotation_history x-fern-sdk-method-name: delete get: - description: '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.' + description: |- + + Label Studio Enterprise badge +

+ 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. operationId: api_annotation_history_list parameters: - description: Annotation ID to get annotation history items for. @@ -165,7 +186,14 @@ paths: x-fern-sdk-method-name: list /api/annotation-reviews/: get: - description: List all reviews for a specific annotation ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + List all reviews for a specific annotation ID. operationId: api_annotation_reviews_list parameters: - in: query @@ -201,7 +229,14 @@ paths: x-fern-sdk-group-name: annotation_reviews x-fern-sdk-method-name: list post: - description: Create a review for a specific annotation ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a review for a specific annotation ID. operationId: api_annotation_reviews_create parameters: - description: Whether to postprocess the review asynchronously. @@ -239,7 +274,14 @@ paths: x-fern-sdk-method-name: create /api/annotation-reviews/{id}/: delete: - description: Delete a review by ID + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a review by ID operationId: api_annotation_reviews_destroy parameters: - description: A unique integer value identifying this annotation review. @@ -261,7 +303,14 @@ paths: x-fern-sdk-group-name: annotation_reviews x-fern-sdk-method-name: delete get: - description: Retrieve a specific review by ID for an annotation. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a specific review by ID for an annotation. operationId: api_annotation_reviews_retrieve parameters: - description: A unique integer value identifying this annotation review. @@ -287,7 +336,14 @@ paths: x-fern-sdk-group-name: annotation_reviews x-fern-sdk-method-name: get patch: - description: Update a specific review by ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific review by ID. operationId: api_annotation_reviews_partial_update parameters: - description: A unique integer value identifying this annotation review. @@ -324,7 +380,14 @@ paths: x-fern-sdk-group-name: annotation_reviews x-fern-sdk-method-name: update put: - description: Overwrite a specific review by ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Overwrite a specific review by ID. operationId: api_annotation_reviews_update parameters: - description: A unique integer value identifying this annotation review. @@ -617,7 +680,14 @@ paths: - internal /api/billing/info: get: - description: Retrieve billing checks and feature flags for the active organization. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve billing checks and feature flags for the active organization. operationId: api_billing_info_retrieve responses: '200': @@ -926,7 +996,14 @@ paths: - internal /api/comments/: get: - description: List all comments for a specific annotation ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + List all comments for a specific annotation ID. operationId: api_comments_list parameters: - in: query @@ -975,7 +1052,14 @@ paths: x-fern-sdk-group-name: comments x-fern-sdk-method-name: list post: - description: Create a comment for a specific annotation ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a comment for a specific annotation ID. operationId: api_comments_create parameters: - description: Expand the created_by field @@ -1012,7 +1096,14 @@ paths: x-fern-sdk-method-name: create /api/comments/export/: get: - description: Export comments to CSV file + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Export comments to CSV file operationId: api_comments_export_retrieve parameters: - in: query @@ -1060,7 +1151,14 @@ paths: x-fern-sdk-method-name: export /api/comments/{id}/: delete: - description: Delete a comment by ID + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a comment by ID operationId: api_comments_destroy parameters: - description: Expand the created_by field @@ -1086,7 +1184,14 @@ paths: x-fern-sdk-group-name: comments x-fern-sdk-method-name: delete get: - description: Retrieve a specific comment by ID for an annotation. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a specific comment by ID for an annotation. operationId: api_comments_retrieve parameters: - description: Expand the created_by field @@ -1116,7 +1221,14 @@ paths: x-fern-sdk-group-name: comments x-fern-sdk-method-name: get patch: - description: Update a specific comment by ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific comment by ID. operationId: api_comments_partial_update parameters: - description: Expand the created_by field @@ -1157,7 +1269,14 @@ paths: x-fern-sdk-group-name: comments x-fern-sdk-method-name: update put: - description: Overwrite a specific comment by ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Overwrite a specific comment by ID. operationId: api_comments_update parameters: - description: Expand the created_by field @@ -1197,7 +1316,14 @@ paths: - internal /api/current-user: get: - description: Get info about the currently authenticated user. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get info about the currently authenticated user. operationId: api_current_user_retrieve responses: '200': @@ -1216,7 +1342,14 @@ paths: x-fern-sdk-group-name: users x-fern-sdk-method-name: get_current_user patch: - description: Update details for the currently authenticated user. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update details for the currently authenticated user. operationId: api_current_user_partial_update requestBody: content: @@ -3837,7 +3970,14 @@ paths: x-fern-sdk-method-name: update /api/inference-runs/{id}/indicators/: get: - description: Get key indicators for the Prompt dashboard. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get key indicators for the Prompt dashboard. operationId: api_inference_runs_indicators_retrieve parameters: - in: path @@ -3872,7 +4012,14 @@ paths: x-fern-sdk-method-name: list /api/inference-runs/{id}/indicators/{indicator_key}: get: - description: Get a specific key indicator for the Prompt dashboard. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a specific key indicator for the Prompt dashboard. operationId: api_inference_runs_indicators_retrieve_2 parameters: - in: path @@ -3950,7 +4097,14 @@ paths: x-fern-sdk-method-name: reset_token /api/invite/revoke: post: - description: Revoke invite to organization + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Revoke invite to organization operationId: api_invite_revoke_create requestBody: content: @@ -3981,7 +4135,14 @@ paths: x-fern-sdk-method-name: revoke_invite /api/invite/send-email: post: - description: Send email with invite to organization + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Send email with invite to organization operationId: api_invite_send_email_create requestBody: content: @@ -4747,7 +4908,7 @@ paths: x-fern-sdk-method-name: predict_interactive /api/ml/{id}/predict: post: - description: "Note: not available in the community edition of Label Studio. \n\nCreate predictions for all tasks using a specific ML backend so that you can set up an active learning strategy based on the confidence or uncertainty scores associated with the predictions. Creating predictions requires a Label Studio ML backend set up and configured for your project. \n\nSee [Set up machine learning](https://labelstud.io/guide/ml.html) for more details about a Label Studio ML backend. \n\nReference the ML backend ID in the path of this API call. Get the ML backend ID by [listing the ML backends for a project](https://labelstud.io/api/#operation/api_ml_list)." + description: "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n \n\n\nCreate predictions for all tasks using a specific ML backend so that you can set up an active learning strategy based on the confidence or uncertainty scores associated with the predictions. Creating predictions requires a Label Studio ML backend set up and configured for your project. \n\nSee [Set up machine learning](https://labelstud.io/guide/ml.html) for more details about a Label Studio ML backend. \n\nReference the ML backend ID in the path of this API call. Get the ML backend ID by [listing the ML backends for a project](https://labelstud.io/api/#operation/api_ml_list)." operationId: api_ml_predict_create parameters: - description: Computed number of tasks without predictions that the ML backend needs to predict. @@ -4891,7 +5052,14 @@ paths: x-fern-sdk-method-name: list_model_versions /api/model-provider-connections/: get: - description: List all model provider connections. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + List all model provider connections. operationId: api_model_provider_connections_list parameters: - description: Which field to use when ordering the results. @@ -4919,7 +5087,14 @@ paths: x-fern-sdk-group-name: model_providers x-fern-sdk-method-name: list post: - description: Create a new model provider connection. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a new model provider connection. operationId: api_model_provider_connections_create requestBody: content: @@ -4950,7 +5125,14 @@ paths: x-fern-sdk-method-name: create /api/model-provider-connections/provider-choices: get: - description: List all possible model provider choices + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + List all possible model provider choices operationId: api_model_provider_connections_provider_choices_retrieve responses: '200': @@ -4975,7 +5157,14 @@ paths: x-fern-sdk-method-name: list_model_provider_choices /api/model-provider-connections/{id}/: delete: - description: Delete a model provider connection by ID + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a model provider connection by ID operationId: api_model_provider_connections_destroy parameters: - in: path @@ -4996,7 +5185,14 @@ paths: x-fern-sdk-group-name: model_providers x-fern-sdk-method-name: delete get: - description: Retrieve a specific model provider connection. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a specific model provider connection. operationId: api_model_provider_connections_retrieve parameters: - in: path @@ -5021,7 +5217,14 @@ paths: x-fern-sdk-group-name: model_providers x-fern-sdk-method-name: get patch: - description: Update a specific model provider connection by ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific model provider connection by ID. operationId: api_model_provider_connections_partial_update parameters: - in: path @@ -5057,7 +5260,14 @@ paths: x-fern-sdk-group-name: model_providers x-fern-sdk-method-name: update put: - description: Overwrite a specific model provider connection by ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Overwrite a specific model provider connection by ID. operationId: api_model_provider_connections_update parameters: - in: path @@ -5092,7 +5302,14 @@ paths: - internal /api/model-run/batch-failed-predictions: post: - description: Create a new batch of failed predictions. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a new batch of failed predictions. operationId: api_model_run_batch_failed_predictions_create parameters: - description: Number of failed predictions being sent (for telemetry only, has no effect) @@ -5130,7 +5347,14 @@ paths: x-fern-sdk-method-name: batch_failed_predictions /api/model-run/batch-predictions: post: - description: Create a new batch prediction. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a new batch prediction. operationId: api_model_run_batch_predictions_create parameters: - description: Number of predictions being sent (for telemetry only, has no effect) @@ -5222,7 +5446,14 @@ paths: x-fern-sdk-group-name: organizations x-fern-sdk-method-name: get patch: - description: Update organization details including title, embed domains, and Plugins settings. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update organization details including title, embed domains, and Plugins settings. operationId: api_organizations_partial_update parameters: - in: path @@ -5266,7 +5497,14 @@ paths: x-fern-sdk-method-name: update /api/organizations/{id}/memberships: get: - description: Retrieve a list of all users and roles in a specific organization. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a list of all users and roles in a specific organization. operationId: api_organizations_memberships_list parameters: - description: Project ID to exclude users who are already associated with this project (direct members, workspace members, or implicit admin/owner access). @@ -5329,6 +5567,12 @@ paths: x-fern-sdk-method-name: list patch: description: |+ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update organization membership or role for a specific user ID. **User Rotation Best Practices for API Usage** @@ -5451,7 +5695,14 @@ paths: x-fern-sdk-method-name: get /api/organizations/{id}/permissions: get: - description: List all organization-level permission overrides for a given organization. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + List all organization-level permission overrides for a given organization. operationId: api_organizations_permissions_list parameters: - in: path @@ -5487,12 +5738,19 @@ paths: - permissions x-fern-sdk-method-name: list post: - description: Create a new organization-level permission override for a given organization. - operationId: api_organizations_permissions_create - parameters: - - in: path - name: id - required: true + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a new organization-level permission override for a given organization. + operationId: api_organizations_permissions_create + parameters: + - in: path + name: id + required: true schema: type: integer requestBody: @@ -5532,7 +5790,14 @@ paths: x-fern-sdk-method-name: create /api/organizations/{id}/permissions/options: get: - description: Retrieve the list of configurable permission options (label, tooltip, default role and allowed roles). + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve the list of configurable permission options (label, tooltip, default role and allowed roles). operationId: api_organizations_permissions_options_list parameters: - in: path @@ -5637,7 +5902,14 @@ paths: - permissions x-fern-sdk-method-name: get patch: - description: Partially update the organization-level permission override for a given permission key. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Partially update the organization-level permission override for a given permission key. operationId: api_organizations_permissions_partial_update parameters: - in: path @@ -5687,7 +5959,14 @@ paths: - permissions x-fern-sdk-method-name: update put: - description: Replace the organization-level permission override for a given permission key. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Replace the organization-level permission override for a given permission key. operationId: api_organizations_permissions_update parameters: - description: A unique integer value identifying this organization. @@ -5741,7 +6020,14 @@ paths: x-fern-sdk-method-name: replace /api/organizations/{id}/set-default-role: patch: - description: Update the default role for members of a specific organization. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update the default role for members of a specific organization. operationId: api_organizations_set_default_role_partial_update parameters: - in: path @@ -6221,7 +6507,14 @@ paths: - internal /api/project-templates/: get: - description: Get a list of all project templates for an organization. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a list of all project templates for an organization. operationId: api_project_templates_list parameters: - description: Which field to use when ordering the results. @@ -6250,7 +6543,14 @@ paths: - project-templates x-fern-sdk-method-name: list post: - description: Create a project template for an organization. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a project template for an organization. operationId: api_project_templates_create requestBody: content: @@ -6283,7 +6583,14 @@ paths: x-fern-sdk-method-name: create /api/project-templates/{id}: delete: - description: Delete a specific project template by ID for an organization. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a specific project template by ID for an organization. operationId: api_project_templates_destroy parameters: - in: path @@ -6305,7 +6612,14 @@ paths: - project-templates x-fern-sdk-method-name: delete get: - description: Get a specific project template by ID for an organization. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a specific project template by ID for an organization. operationId: api_project_templates_retrieve parameters: - in: path @@ -6331,7 +6645,14 @@ paths: - project-templates x-fern-sdk-method-name: get patch: - description: Update the details of a specific project template by ID for an organization. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update the details of a specific project template by ID for an organization. operationId: api_project_templates_partial_update parameters: - in: path @@ -6368,7 +6689,14 @@ paths: - project-templates x-fern-sdk-method-name: update put: - description: Overwrite a specific project template by ID for an organization. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Overwrite a specific project template by ID for an organization. operationId: api_project_templates_update parameters: - in: path @@ -6404,7 +6732,14 @@ paths: - internal /api/project-templates/{id}/create-project: post: - description: Create a project from a specific project template by ID for an organization. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a project from a specific project template by ID for an organization. operationId: api_project_templates_create_project_create parameters: - in: path @@ -6628,7 +6963,7 @@ paths: x-fern-sdk-method-name: list_counts /api/projects/roles/: get: - description: "\n List project roles for requested IDs for the current user\n " + description: "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n \n\n List project roles for requested IDs for the current user\n " operationId: api_projects_roles_list parameters: - in: query @@ -6656,7 +6991,7 @@ paths: tags: - Project Roles post: - description: "\n Create project role for user allowing the user the same access level provided by organization role.\n " + description: "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n \n\n Create project role for user allowing the user the same access level provided by organization role.\n " operationId: api_projects_roles_create requestBody: content: @@ -6684,7 +7019,7 @@ paths: - Project Roles /api/projects/roles/{id}/: delete: - description: "\n Remove project role for user allowing the user the same access level provided by organization role.\n " + description: "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n \n\n Remove project role for user allowing the user the same access level provided by organization role.\n " operationId: api_projects_roles_destroy parameters: - description: A unique integer value identifying this project role. @@ -6827,7 +7162,14 @@ paths: x-fern-sdk-method-name: update /api/projects/{id}/annotation-history/: get: - description: List all annotation history items for the project with pagination. + description: |- + + Label Studio Enterprise badge +

+ 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. operationId: api_projects_annotation_history_list parameters: - in: path @@ -7219,7 +7561,14 @@ paths: - internal /api/projects/{id}/duplicate/: post: - description: Make a copy of project. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Make a copy of project. operationId: api_projects_duplicate_create parameters: - in: path @@ -7856,7 +8205,14 @@ paths: x-fern-sdk-method-name: create_many_status /api/projects/{id}/members/: delete: - description: Remove a member from a specific project. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Remove a member from a specific project. operationId: api_projects_members_destroy parameters: - in: path @@ -7878,7 +8234,14 @@ paths: tags: - Projects get: - description: Retrieve the members for a specific project. Optionally filter by user IDs (comma-separated). + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve the members for a specific project. Optionally filter by user IDs (comma-separated). operationId: api_projects_members_retrieve parameters: - in: path @@ -7912,7 +8275,14 @@ paths: - members x-fern-sdk-method-name: get post: - description: Add a member to a specific project. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Add a member to a specific project. operationId: api_projects_members_create parameters: - in: path @@ -7946,7 +8316,14 @@ paths: - Projects /api/projects/{id}/members/bulk/: delete: - description: Unassign project members in bulk. Allows the same request body as bulk assign. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Unassign project members in bulk. Allows the same request body as bulk assign. operationId: api_projects_members_bulk_destroy parameters: - in: path @@ -7982,7 +8359,14 @@ paths: - bulk x-fern-sdk-method-name: delete post: - description: Assign project members in bulk. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Assign project members in bulk. operationId: api_projects_members_bulk_create parameters: - in: path @@ -8031,7 +8415,14 @@ paths: x-fern-sdk-method-name: post /api/projects/{id}/members/paginated/: get: - description: Retrieve the members for a specific project. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve the members for a specific project. operationId: api_projects_members_paginated_list parameters: - in: path @@ -8100,7 +8491,14 @@ paths: x-fern-sdk-method-name: list /api/projects/{id}/metricparam/: get: - description: Get the current metrics configuration for a project. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get the current metrics configuration for a project. operationId: api_projects_metricparam_retrieve parameters: - in: path @@ -8127,7 +8525,14 @@ paths: - metrics x-fern-sdk-method-name: get post: - description: Update metrics strategy and parameters for a project. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update metrics strategy and parameters for a project. operationId: api_projects_metricparam_create parameters: - in: path @@ -8169,10 +8574,13 @@ paths: /api/projects/{id}/model-stats/{model_version}/agreement: get: description: |- - Overall agreement between a given model version's predictions and all annotators on overlapping tasks. - Computed as the average of per-annotator agreement vs this model version over annotators who overlap on at least one task. - Mirrors IAA per annotator, but one side is the model. - :return: {"agreement": float[0..1]} + + Label Studio Enterprise badge +

+ 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. operationId: api_projects_model_stats_agreement_retrieve parameters: - in: path @@ -8192,6 +8600,7 @@ paths: schema: properties: agreement: + nullable: true type: number type: object description: Model-version overall agreement vs annotators @@ -8200,12 +8609,22 @@ paths: summary: Get model-version overall agreement vs annotators tags: - Stats + x-fern-audiences: + - public + x-fern-sdk-group-name: + - projects + - stats + x-fern-sdk-method-name: model_version_annotator_agreement /api/projects/{id}/model-stats/{model_version}/agreement-groundtruth: get: description: |- - Ground truth agreement for annotations that match predictions of a specific model version. - This mirrors gt_per_user_agreement but filters stats by tasks where predictions have given model_version. - :return: {"agreement": float[0..1]} + + Label Studio Enterprise badge +

+ 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. operationId: api_projects_model_stats_agreement_groundtruth_retrieve parameters: - in: path @@ -8231,6 +8650,7 @@ paths: schema: properties: agreement: + nullable: true type: number type: object description: Model-version ground truth agreement @@ -8239,17 +8659,22 @@ paths: summary: Get model-version ground truth agreement tags: - Stats + x-fern-audiences: + - public + x-fern-sdk-group-name: + - projects + - stats + x-fern-sdk-method-name: model_version_ground_truth_agreement /api/projects/{id}/model-stats/{model_version}/prediction: get: description: |- - Mean agreement between the given model version and all other model versions in the project. - - Computed as the average of pairwise model-to-model agreement scores from PredictionPairStats where either - prediction pair's model_version_from or model_version_to equals the provided model_version. - - When per_label=true, returns a mapping of label -> average agreement across the same set of pairs. - - :return: {"average_prediction_agreement_per_model": float[0..1] | {label: float[0..1]}} + + Label Studio Enterprise badge +

+ 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. operationId: api_projects_model_stats_prediction_retrieve parameters: - in: path @@ -8275,6 +8700,7 @@ paths: schema: properties: average_prediction_agreement_per_model: + nullable: true type: number type: object description: Model-version prediction agreement @@ -8283,9 +8709,22 @@ paths: summary: Get model-version prediction agreement tags: - Stats + x-fern-audiences: + - public + x-fern-sdk-group-name: + - projects + - stats + x-fern-sdk-method-name: model_version_prediction_agreement /api/projects/{id}/project-extra-params/: get: - description: Retrieve the annotator weights for statistics and Cohen's Kappa for a specific project. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve the annotator weights for statistics and Cohen's Kappa for a specific project. operationId: api_projects_project_extra_params_retrieve parameters: - in: path @@ -8323,7 +8762,14 @@ paths: tags: - Projects post: - description: Create annotator weights to be used in the annotation statistics for a project, such as when calculating kappa metrics for inter-annotator agreement. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create annotator weights to be used in the annotation statistics for a project, such as when calculating kappa metrics for inter-annotator agreement. operationId: api_projects_project_extra_params_create parameters: - in: path @@ -8401,7 +8847,7 @@ paths: - internal /api/projects/{id}/roles: get: - description: "\n List users and their project level roles for a given project.\n If user is not listed here and is a member of the project then they would behave as assigned role in organization.\n " + description: "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n \n\n List users and their project level roles for a given project.\n If user is not listed here and is a member of the project then they would behave as assigned role in organization.\n " operationId: api_projects_roles_retrieve parameters: - in: path @@ -8423,7 +8869,14 @@ paths: - Project Roles /api/projects/{id}/stats/IAA: get: - description: Get Inter-Annotator Agreement (IAA) matrix for a project, showing agreement between all annotators. + description: |- + + Label Studio Enterprise badge +

+ 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. operationId: api_projects_stats_IAA_retrieve parameters: - description: Comma-separated list of fields to expand @@ -8575,7 +9028,14 @@ paths: x-fern-sdk-method-name: iaa /api/projects/{id}/stats/agreement_annotator/{user_id}: get: - description: Get agreement statistics for a specific annotator within a project. + description: |- + + Label Studio Enterprise badge +

+ 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. operationId: api_projects_stats_agreement_annotator_retrieve parameters: - in: path @@ -8751,6 +9211,12 @@ paths: /api/projects/{id}/stats/total_agreement: get: description: |- + + Label Studio Enterprise badge +

+ 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. @@ -8863,7 +9329,14 @@ paths: - internal /api/projects/{id}/tasks/assignees: post: - description: Assign multiple users to a collection of tasks within a specific project. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Assign multiple users to a collection of tasks within a specific project. operationId: api_projects_tasks_assignees_create parameters: - in: path @@ -9054,7 +9527,14 @@ paths: x-fern-sdk-method-name: bulk_assign /api/projects/{id}/tasks/{task_pk}/assignees: delete: - description: Remove assignees for a task within a specific project. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Remove assignees for a task within a specific project. operationId: api_projects_tasks_assignees_destroy parameters: - description: A unique integer value identifying this project. @@ -9097,7 +9577,14 @@ paths: - assignments x-fern-sdk-method-name: delete get: - description: Retrieve a list of tasks and assignees for those tasks for a specific project. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a list of tasks and assignees for those tasks for a specific project. operationId: api_projects_tasks_assignees_retrieve parameters: - description: A unique integer value identifying this project. @@ -9133,13 +9620,20 @@ paths: - assignments x-fern-sdk-method-name: list patch: - description: Update the assignee for a task in a specific project. - operationId: api_projects_tasks_assignees_partial_update - parameters: - - description: A unique integer value identifying this project. - in: path - name: id - required: true + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update the assignee for a task in a specific project. + operationId: api_projects_tasks_assignees_partial_update + parameters: + - description: A unique integer value identifying this project. + in: path + name: id + required: true schema: type: integer - description: A unique integer value identifying this task. @@ -9187,7 +9681,14 @@ paths: - assignments x-fern-sdk-method-name: update post: - description: Assign a user to a task in a specific project. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Assign a user to a task in a specific project. operationId: api_projects_tasks_assignees_create_2 parameters: - description: A unique integer value identifying this project. @@ -9277,7 +9778,14 @@ paths: x-fern-sdk-method-name: update_stats /api/projects/{id}/user-stats/{user_pk}/prediction: get: - description: Get prediction agreement statistics for a specific user within a project. + description: |- + + Label Studio Enterprise badge +

+ 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. operationId: api_projects_user_stats_prediction_retrieve parameters: - in: path @@ -9324,7 +9832,14 @@ paths: x-fern-sdk-method-name: user_prediction_agreement /api/projects/{id}/user-stats/{user_pk}/review_score: get: - description: Get review score statistics for a specific user within a project. + description: |- + + Label Studio Enterprise badge +

+ 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. operationId: api_projects_user_stats_review_score_retrieve parameters: - in: path @@ -9379,7 +9894,14 @@ paths: x-fern-sdk-method-name: user_review_score /api/projects/{id}/users/{user_pk}/stats/agreement-groundtruth: get: - description: Get ground truth agreement statistics for a specific user within a project. + description: |- + + Label Studio Enterprise badge +

+ 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. operationId: api_projects_users_stats_agreement_groundtruth_retrieve parameters: - in: path @@ -9466,7 +9988,14 @@ paths: x-fern-sdk-method-name: validate_label_config /api/projects/{project_pk}/members/{user_pk}/pauses/: get: - description: Retrieve a list of all pauses. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a list of all pauses. operationId: api_projects_members_pauses_list parameters: - description: Include deleted pauses. @@ -9511,7 +10040,14 @@ paths: - pauses x-fern-sdk-method-name: list post: - description: Create a new pause entry. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a new pause entry. operationId: api_projects_members_pauses_create parameters: - in: path @@ -9556,7 +10092,14 @@ paths: x-fern-sdk-method-name: create /api/projects/{project_pk}/members/{user_pk}/pauses/{id}/: delete: - description: Delete a specific pause by ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a specific pause by ID. operationId: api_projects_members_pauses_destroy parameters: - in: path @@ -9589,7 +10132,14 @@ paths: - pauses x-fern-sdk-method-name: delete get: - description: Retrieve a specific pause by ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a specific pause by ID. operationId: api_projects_members_pauses_retrieve parameters: - in: path @@ -9626,7 +10176,14 @@ paths: - pauses x-fern-sdk-method-name: get patch: - description: Partially update a pause entry by ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Partially update a pause entry by ID. operationId: api_projects_members_pauses_partial_update parameters: - in: path @@ -9674,7 +10231,14 @@ paths: - pauses x-fern-sdk-method-name: update put: - description: Overwrite a pause entry by ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Overwrite a pause entry by ID. operationId: api_projects_members_pauses_update parameters: - in: path @@ -9720,7 +10284,7 @@ paths: - internal /api/projects/{project_pk}/subset-tasks: get: - description: "\n Provides list of tasks, based on project subset. Includes predictions for tasks. For the 'HasGT' subset, accuracy metrics will also be provided.\n " + description: "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n \n\n Provides list of tasks, based on project subset. Includes predictions for tasks. For the 'HasGT' subset, accuracy metrics will also be provided.\n " operationId: api_projects_subset_tasks_list parameters: - description: If true (default), includes task_count in response; if false, omits it. @@ -9786,7 +10350,7 @@ paths: x-fern-sdk-method-name: subset_tasks /api/projects/{project_pk}/subsets: get: - description: "\n Provides list of available subsets for a project along with count of tasks in each subset\n " + description: "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n \n\n Provides list of available subsets for a project along with count of tasks in each subset\n " operationId: api_projects_subsets_list parameters: - description: Which field to use when ordering the results. @@ -9848,7 +10412,14 @@ paths: x-fern-sdk-group-name: prompts x-fern-sdk-method-name: list post: - description: Create a new prompt. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a new prompt. operationId: api_prompts_create requestBody: content: @@ -9928,7 +10499,14 @@ paths: x-fern-sdk-method-name: compatible_projects /api/prompts/{id}/: delete: - description: Delete a prompt by ID + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a prompt by ID operationId: api_prompts_destroy parameters: - in: path @@ -9949,7 +10527,14 @@ paths: x-fern-sdk-group-name: prompts x-fern-sdk-method-name: delete get: - description: Retrieve a specific prompt. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a specific prompt. operationId: api_prompts_retrieve parameters: - in: path @@ -9974,7 +10559,14 @@ paths: x-fern-sdk-group-name: prompts x-fern-sdk-method-name: get patch: - description: Update a specific prompt by ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific prompt by ID. operationId: api_prompts_partial_update parameters: - in: path @@ -10010,7 +10602,14 @@ paths: x-fern-sdk-group-name: prompts x-fern-sdk-method-name: update put: - description: Overwrite a specific prompt by ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Overwrite a specific prompt by ID. operationId: api_prompts_update parameters: - in: path @@ -10046,7 +10645,14 @@ paths: - internal /api/prompts/{id}/get-default-version-name: get: - description: Get default prompt version name + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get default prompt version name operationId: api_prompts_get_default_version_name_retrieve parameters: - in: path @@ -10070,7 +10676,14 @@ paths: x-fern-sdk-method-name: get_default_version_name /api/prompts/{prompt_id}/versions: get: - description: List all versions of a prompt. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + List all versions of a prompt. operationId: api_prompts_versions_list parameters: - description: Which field to use when ordering the results. @@ -10105,7 +10718,14 @@ paths: - versions x-fern-sdk-method-name: list post: - description: Create a new version of a prompt. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a new version of a prompt. operationId: api_prompts_versions_create parameters: - in: path @@ -10145,7 +10765,14 @@ paths: x-fern-sdk-method-name: create /api/prompts/{prompt_id}/versions/{version_id}: delete: - description: Delete a prompt version by ID + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a prompt version by ID operationId: api_prompts_versions_destroy parameters: - in: path @@ -10173,7 +10800,14 @@ paths: - versions x-fern-sdk-method-name: delete get: - description: Retrieve a specific prompt of a model. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve a specific prompt of a model. operationId: api_prompts_versions_retrieve parameters: - in: path @@ -10205,7 +10839,14 @@ paths: - versions x-fern-sdk-method-name: get patch: - description: Update a specific prompt version by ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific prompt version by ID. operationId: api_prompts_versions_partial_update parameters: - in: path @@ -10248,7 +10889,14 @@ paths: - versions x-fern-sdk-method-name: update put: - description: Overwrite a specific prompt version by ID. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Overwrite a specific prompt version by ID. operationId: api_prompts_versions_update parameters: - in: path @@ -10289,7 +10937,14 @@ paths: - internal /api/prompts/{prompt_id}/versions/{version_id}/cost-estimate: get: - description: Get an estimate of the cost for making an inference run on the selected Prompt Version and Project/ProjectSubset + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get an estimate of the cost for making an inference run on the selected Prompt Version and Project/ProjectSubset operationId: api_prompts_versions_cost_estimate_retrieve parameters: - in: path @@ -10322,7 +10977,14 @@ paths: x-fern-sdk-method-name: cost_estimate /api/prompts/{prompt_id}/versions/{version_id}/inference-runs: get: - description: Get information (status, metadata, etc) about an existing inference run + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get information (status, metadata, etc) about an existing inference run operationId: api_prompts_versions_inference_runs_list parameters: - description: Which field to use when ordering the results. @@ -10381,7 +11043,14 @@ paths: - runs x-fern-sdk-method-name: list post: - description: Run a prompt inference. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Run a prompt inference. operationId: api_prompts_versions_inference_runs_create parameters: - in: path @@ -10426,7 +11095,14 @@ paths: x-fern-sdk-method-name: create /api/prompts/{prompt_id}/versions/{version_id}/inference-runs/{inference_run_id}/cancel: post: - description: Cancel the inference run for the given api + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Cancel the inference run for the given api operationId: api_prompts_versions_inference_runs_cancel_create parameters: - in: path @@ -10557,7 +11233,14 @@ paths: x-fern-sdk-method-name: refine_prompt /api/saml/settings: get: - description: Retrieve SAML2 settings for the currently active organization. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve SAML2 settings for the currently active organization. operationId: api_saml_settings_retrieve responses: '200': @@ -10592,7 +11275,14 @@ paths: - saml x-fern-sdk-method-name: get post: - description: Update SAML2 settings for the currently active organization. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update SAML2 settings for the currently active organization. operationId: api_saml_settings_create requestBody: content: @@ -10653,7 +11343,14 @@ paths: x-fern-sdk-method-name: update /api/scim/settings: get: - description: Retrieve SCIM settings for the currently active organization. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Retrieve SCIM settings for the currently active organization. operationId: api_scim_settings_retrieve responses: '200': @@ -10688,7 +11385,14 @@ paths: - scim x-fern-sdk-method-name: get post: - description: Update SCIM settings for the currently active organization. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update SCIM settings for the currently active organization. operationId: api_scim_settings_create requestBody: content: @@ -11148,7 +11852,14 @@ paths: x-fern-sdk-method-name: sync /api/storages/azure_spi/: get: - description: Get list of all Azure import storage connections set up with Service Principal authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get list of all Azure import storage connections set up with Service Principal authentication. operationId: api_storages_azure_spi_list parameters: - description: Which field to use when ordering the results. @@ -11183,7 +11894,14 @@ paths: - azure_spi x-fern-sdk-method-name: list post: - description: Create Azure import storage with Service Principal authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create Azure import storage with Service Principal authentication. operationId: api_storages_azure_spi_create requestBody: content: @@ -11217,7 +11935,14 @@ paths: x-fern-sdk-method-name: create /api/storages/azure_spi/validate: post: - description: Validate a specific Azure import storage connection that was set up with Service Principal authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Validate a specific Azure import storage connection that was set up with Service Principal authentication. operationId: api_storages_azure_spi_validate_create requestBody: content: @@ -11247,7 +11972,14 @@ paths: x-fern-sdk-method-name: validate /api/storages/azure_spi/{id}: delete: - description: Delete a specific Azure import storage connection that was set up with Service Principal authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a specific Azure import storage connection that was set up with Service Principal authentication. operationId: api_storages_azure_spi_destroy parameters: - in: path @@ -11270,7 +12002,14 @@ paths: - azure_spi x-fern-sdk-method-name: delete get: - description: Get a specific Azure import storage connection that was set up with Service Principal authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a specific Azure import storage connection that was set up with Service Principal authentication. operationId: api_storages_azure_spi_retrieve parameters: - in: path @@ -11297,7 +12036,14 @@ paths: - azure_spi x-fern-sdk-method-name: get patch: - description: Update a specific Azure import storage connection that was set up with Service Principal authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific Azure import storage connection that was set up with Service Principal authentication. operationId: api_storages_azure_spi_partial_update parameters: - in: path @@ -11336,7 +12082,14 @@ paths: x-fern-sdk-method-name: update /api/storages/azure_spi/{id}/sync: post: - description: Sync tasks from an Azure import storage connection that was set up with Service Principal authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Sync tasks from an Azure import storage connection that was set up with Service Principal authentication. operationId: api_storages_azure_spi_sync_create parameters: - in: path @@ -11364,7 +12117,14 @@ paths: x-fern-sdk-method-name: sync /api/storages/databricks/: get: - description: Get list of all Databricks Files import storage connections. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get list of all Databricks Files import storage connections. operationId: api_storages_databricks_list parameters: - description: Which field to use when ordering the results. @@ -11399,7 +12159,14 @@ paths: - databricks x-fern-sdk-method-name: list post: - description: Create a Databricks Files import storage connection. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a Databricks Files import storage connection. operationId: api_storages_databricks_create requestBody: content: @@ -11433,7 +12200,14 @@ paths: x-fern-sdk-method-name: create /api/storages/databricks/validate: post: - description: Validate a specific Databricks Files import storage connection. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Validate a specific Databricks Files import storage connection. operationId: api_storages_databricks_validate_create requestBody: content: @@ -11463,7 +12237,14 @@ paths: x-fern-sdk-method-name: validate /api/storages/databricks/{id}: delete: - description: Delete a specific Databricks Files import storage connection. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a specific Databricks Files import storage connection. operationId: api_storages_databricks_destroy parameters: - in: path @@ -11486,7 +12267,14 @@ paths: - databricks x-fern-sdk-method-name: delete get: - description: Get a specific Databricks Files import storage connection. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a specific Databricks Files import storage connection. operationId: api_storages_databricks_retrieve parameters: - in: path @@ -11513,7 +12301,14 @@ paths: - databricks x-fern-sdk-method-name: get patch: - description: Update a specific Databricks Files import storage connection. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific Databricks Files import storage connection. operationId: api_storages_databricks_partial_update parameters: - in: path @@ -11552,7 +12347,14 @@ paths: x-fern-sdk-method-name: update /api/storages/databricks/{id}/sync: post: - description: Sync tasks from a Databricks Files import storage. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Sync tasks from a Databricks Files import storage. operationId: api_storages_databricks_sync_create parameters: - in: path @@ -11895,7 +12697,14 @@ paths: x-fern-sdk-method-name: sync /api/storages/export/azure_spi: get: - description: Get a list of all Azure export storage connections that were set up with Service Principal authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a list of all Azure export storage connections that were set up with Service Principal authentication. operationId: api_storages_export_azure_spi_list parameters: - description: Which field to use when ordering the results. @@ -11930,7 +12739,14 @@ paths: - azure_spi x-fern-sdk-method-name: list post: - description: Create an Azure export storage connection with Service Principal authentication to store annotations. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create an Azure export storage connection with Service Principal authentication to store annotations. operationId: api_storages_export_azure_spi_create requestBody: content: @@ -11964,7 +12780,14 @@ paths: x-fern-sdk-method-name: create /api/storages/export/azure_spi/validate: post: - description: Validate a specific Azure export storage connection that was set up with Service Principal authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Validate a specific Azure export storage connection that was set up with Service Principal authentication. operationId: api_storages_export_azure_spi_validate_create requestBody: content: @@ -11994,7 +12817,14 @@ paths: x-fern-sdk-method-name: validate /api/storages/export/azure_spi/{id}: delete: - description: Delete a specific Azure export storage connection that was set up with Service Principal authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a specific Azure export storage connection that was set up with Service Principal authentication. operationId: api_storages_export_azure_spi_destroy parameters: - in: path @@ -12017,7 +12847,14 @@ paths: - azure_spi x-fern-sdk-method-name: delete get: - description: Get a specific Azure export storage connection that was set up with Service Principal authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a specific Azure export storage connection that was set up with Service Principal authentication. operationId: api_storages_export_azure_spi_retrieve parameters: - in: path @@ -12044,7 +12881,14 @@ paths: - azure_spi x-fern-sdk-method-name: get patch: - description: Update a specific Azure export storage connection that was set up with Service Principal authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific Azure export storage connection that was set up with Service Principal authentication. operationId: api_storages_export_azure_spi_partial_update parameters: - in: path @@ -12083,7 +12927,14 @@ paths: x-fern-sdk-method-name: update /api/storages/export/azure_spi/{id}/sync: post: - description: Sync tasks from an Azure SPI export storage. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Sync tasks from an Azure SPI export storage. operationId: api_storages_export_azure_spi_sync_create parameters: - in: path @@ -12111,7 +12962,14 @@ paths: x-fern-sdk-method-name: sync /api/storages/export/databricks: get: - description: Get a list of all Databricks Files export storage connections. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a list of all Databricks Files export storage connections. operationId: api_storages_export_databricks_list parameters: - description: Which field to use when ordering the results. @@ -12146,7 +13004,14 @@ paths: - databricks x-fern-sdk-method-name: list post: - description: Create a Databricks Files export storage connection. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create a Databricks Files export storage connection. operationId: api_storages_export_databricks_create requestBody: content: @@ -12180,7 +13045,14 @@ paths: x-fern-sdk-method-name: create /api/storages/export/databricks/validate: post: - description: Validate a specific Databricks Files export storage connection. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Validate a specific Databricks Files export storage connection. operationId: api_storages_export_databricks_validate_create requestBody: content: @@ -12210,7 +13082,14 @@ paths: x-fern-sdk-method-name: validate /api/storages/export/databricks/{id}: delete: - description: Delete a specific Databricks Files export storage connection. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a specific Databricks Files export storage connection. operationId: api_storages_export_databricks_destroy parameters: - in: path @@ -12233,7 +13112,14 @@ paths: - databricks x-fern-sdk-method-name: delete get: - description: Get a specific Databricks Files export storage connection. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a specific Databricks Files export storage connection. operationId: api_storages_export_databricks_retrieve parameters: - in: path @@ -12260,7 +13146,14 @@ paths: - databricks x-fern-sdk-method-name: get patch: - description: Update a specific Databricks Files export storage connection. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific Databricks Files export storage connection. operationId: api_storages_export_databricks_partial_update parameters: - in: path @@ -12299,7 +13192,14 @@ paths: x-fern-sdk-method-name: update /api/storages/export/databricks/{id}/sync: post: - description: Export annotations to a Databricks Files storage. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Export annotations to a Databricks Files storage. operationId: api_storages_export_databricks_sync_create parameters: - in: path @@ -12610,7 +13510,14 @@ paths: x-fern-sdk-method-name: sync /api/storages/export/gcswif: get: - description: Get a list of all GCS export storage connections that were set up with WIF authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a list of all GCS export storage connections that were set up with WIF authentication. operationId: api_storages_export_gcswif_list parameters: - description: Which field to use when ordering the results. @@ -12645,7 +13552,14 @@ paths: - gcswif x-fern-sdk-method-name: list post: - description: Create an GCS export storage connection with WIF authentication to store annotations. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create an GCS export storage connection with WIF authentication to store annotations. operationId: api_storages_export_gcswif_create requestBody: content: @@ -12679,7 +13593,14 @@ paths: x-fern-sdk-method-name: create /api/storages/export/gcswif/validate: post: - description: Validate a specific GCS export storage connection that was set up with WIF authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Validate a specific GCS export storage connection that was set up with WIF authentication. operationId: api_storages_export_gcswif_validate_create requestBody: content: @@ -12709,7 +13630,14 @@ paths: x-fern-sdk-method-name: validate /api/storages/export/gcswif/{id}: delete: - description: Delete a specific GCS export storage connection that was set up with WIF authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a specific GCS export storage connection that was set up with WIF authentication. operationId: api_storages_export_gcswif_destroy parameters: - in: path @@ -12732,7 +13660,14 @@ paths: - gcswif x-fern-sdk-method-name: delete get: - description: Get a specific GCS export storage connection that was set up with WIF authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a specific GCS export storage connection that was set up with WIF authentication. operationId: api_storages_export_gcswif_retrieve parameters: - in: path @@ -12759,7 +13694,14 @@ paths: - gcswif x-fern-sdk-method-name: get patch: - description: Update a specific GCS export storage connection that was set up with WIF authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific GCS export storage connection that was set up with WIF authentication. operationId: api_storages_export_gcswif_partial_update parameters: - in: path @@ -12798,7 +13740,14 @@ paths: x-fern-sdk-method-name: update /api/storages/export/gcswif/{id}/sync: post: - description: Sync tasks from an GCS WIF export storage. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Sync tasks from an GCS WIF export storage. operationId: api_storages_export_gcswif_sync_create parameters: - in: path @@ -13702,7 +14651,14 @@ paths: x-fern-sdk-method-name: sync /api/storages/export/s3s: get: - description: Get a list of all S3 export storage connections that were set up with IAM role access. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a list of all S3 export storage connections that were set up with IAM role access. operationId: api_storages_export_s3s_list parameters: - description: Which field to use when ordering the results. @@ -13737,7 +14693,14 @@ paths: - s3s x-fern-sdk-method-name: list post: - description: Create an S3 export storage connection with IAM role access to store annotations. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create an S3 export storage connection with IAM role access to store annotations. operationId: api_storages_export_s3s_create requestBody: content: @@ -13771,7 +14734,14 @@ paths: x-fern-sdk-method-name: create /api/storages/export/s3s/validate: post: - description: Validate a specific S3 export storage connection that was set up with IAM role access. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Validate a specific S3 export storage connection that was set up with IAM role access. operationId: api_storages_export_s3s_validate_create requestBody: content: @@ -13801,7 +14771,14 @@ paths: x-fern-sdk-method-name: validate /api/storages/export/s3s/{id}: delete: - description: Delete a specific S3 export storage connection that was set up with IAM role access. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a specific S3 export storage connection that was set up with IAM role access. operationId: api_storages_export_s3s_destroy parameters: - in: path @@ -13824,7 +14801,14 @@ paths: - s3s x-fern-sdk-method-name: delete get: - description: Get a specific S3 export storage connection that was set up with IAM role access. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a specific S3 export storage connection that was set up with IAM role access. operationId: api_storages_export_s3s_retrieve parameters: - in: path @@ -13851,7 +14835,14 @@ paths: - s3s x-fern-sdk-method-name: get patch: - description: Update a specific S3 export storage connection that was set up with IAM role access. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific S3 export storage connection that was set up with IAM role access. operationId: api_storages_export_s3s_partial_update parameters: - in: path @@ -13890,7 +14881,14 @@ paths: x-fern-sdk-method-name: update /api/storages/export/s3s/{id}/sync: post: - description: Sync tasks from an S3 export storage. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Sync tasks from an S3 export storage. operationId: api_storages_export_s3s_sync_create parameters: - in: path @@ -14263,7 +15261,14 @@ paths: x-fern-sdk-method-name: sync /api/storages/gcswif/: get: - description: Get list of all GCS import storage connections set up with WIF authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get list of all GCS import storage connections set up with WIF authentication. operationId: api_storages_gcswif_list parameters: - description: Which field to use when ordering the results. @@ -14298,7 +15303,14 @@ paths: - gcswif x-fern-sdk-method-name: list post: - description: Create GCS import storage with WIF. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create GCS import storage with WIF. operationId: api_storages_gcswif_create requestBody: content: @@ -14332,7 +15344,14 @@ paths: x-fern-sdk-method-name: create /api/storages/gcswif/validate: post: - description: Validate a specific GCS import storage connection that was set up with WIF authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Validate a specific GCS import storage connection that was set up with WIF authentication. operationId: api_storages_gcswif_validate_create requestBody: content: @@ -14362,7 +15381,14 @@ paths: x-fern-sdk-method-name: validate /api/storages/gcswif/{id}: delete: - description: Delete a specific GCS import storage connection that was set up with WIF authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a specific GCS import storage connection that was set up with WIF authentication. operationId: api_storages_gcswif_destroy parameters: - in: path @@ -14385,7 +15411,14 @@ paths: - gcswif x-fern-sdk-method-name: delete get: - description: Get a specific GCS import storage connection that was set up with WIF. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a specific GCS import storage connection that was set up with WIF. operationId: api_storages_gcswif_retrieve parameters: - in: path @@ -14412,7 +15445,14 @@ paths: - gcswif x-fern-sdk-method-name: get patch: - description: Update a specific GCS import storage connection that was set up with WIF authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific GCS import storage connection that was set up with WIF authentication. operationId: api_storages_gcswif_partial_update parameters: - in: path @@ -14451,7 +15491,14 @@ paths: x-fern-sdk-method-name: update /api/storages/gcswif/{id}/sync: post: - description: Sync tasks from an GCS import storage connection that was set up with WIF authentication. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Sync tasks from an GCS import storage connection that was set up with WIF authentication. operationId: api_storages_gcswif_sync_create parameters: - in: path @@ -15400,7 +16447,14 @@ paths: x-fern-sdk-method-name: sync /api/storages/s3s/: get: - description: Get list of all S3 import storage connections set up with IAM role access. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get list of all S3 import storage connections set up with IAM role access. operationId: api_storages_s3s_list parameters: - description: Which field to use when ordering the results. @@ -15435,7 +16489,14 @@ paths: - s3s x-fern-sdk-method-name: list post: - description: Create S3 import storage with IAM role access. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create S3 import storage with IAM role access. operationId: api_storages_s3s_create requestBody: content: @@ -15469,7 +16530,14 @@ paths: x-fern-sdk-method-name: create /api/storages/s3s/validate: post: - description: Validate a specific S3 import storage connection that was set up with IAM role access. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Validate a specific S3 import storage connection that was set up with IAM role access. operationId: api_storages_s3s_validate_create requestBody: content: @@ -15499,7 +16567,14 @@ paths: x-fern-sdk-method-name: validate /api/storages/s3s/{id}: delete: - description: Delete a specific S3 import storage connection that was set up with IAM role access. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Delete a specific S3 import storage connection that was set up with IAM role access. operationId: api_storages_s3s_destroy parameters: - in: path @@ -15522,7 +16597,14 @@ paths: - s3s x-fern-sdk-method-name: delete get: - description: Get a specific S3 import storage connection that was set up with IAM role access. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get a specific S3 import storage connection that was set up with IAM role access. operationId: api_storages_s3s_retrieve parameters: - in: path @@ -15549,7 +16631,14 @@ paths: - s3s x-fern-sdk-method-name: get patch: - description: Update a specific S3 import storage connection that was set up with IAM role access. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Update a specific S3 import storage connection that was set up with IAM role access. operationId: api_storages_s3s_partial_update parameters: - in: path @@ -15588,7 +16677,14 @@ paths: x-fern-sdk-method-name: update /api/storages/s3s/{id}/sync: post: - description: Sync tasks from an S3 import storage connection that was set up with IAM role access. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Sync tasks from an S3 import storage connection that was set up with IAM role access. operationId: api_storages_s3s_sync_create parameters: - in: path @@ -16455,7 +17551,14 @@ paths: x-fern-sdk-method-name: update /api/version/: get: - description: Get version information about the Label Studio instance. + description: |- + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Get version information about the Label Studio instance. operationId: api_version_retrieve responses: '200': diff --git a/reference.md b/reference.md index 637bf12d4..f48d5423f 100644 --- a/reference.md +++ b/reference.md @@ -12,6 +12,12 @@
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve activity logs filtered by workspace, project, user, HTTP method, date range or search query.
@@ -153,6 +159,12 @@ client.activity_logs.list()
+ + Label Studio Enterprise badge +

+ 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.
@@ -229,6 +241,12 @@ client.annotation_history.list()
+ + Label Studio Enterprise badge +

+ 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.
@@ -313,6 +331,12 @@ client.annotation_history.delete()
+ + Label Studio Enterprise badge +

+ 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.
@@ -400,6 +424,12 @@ client.annotation_history.list_for_project(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all reviews for a specific annotation ID.
@@ -484,6 +514,12 @@ client.annotation_reviews.list()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a review for a specific annotation ID.
@@ -610,6 +646,12 @@ client.annotation_reviews.create(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific review by ID for an annotation.
@@ -680,6 +722,12 @@ client.annotation_reviews.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a review by ID
@@ -750,6 +798,12 @@ client.annotation_reviews.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific review by ID.
@@ -1636,6 +1690,12 @@ client.annotations.create(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve billing checks and feature flags for the active organization.
@@ -1697,6 +1757,12 @@ client.billing.info()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all comments for a specific annotation ID.
@@ -1805,6 +1871,12 @@ client.comments.list()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a comment for a specific annotation ID.
@@ -1921,6 +1993,12 @@ client.comments.create()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific comment by ID for an annotation.
@@ -1999,6 +2077,12 @@ client.comments.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a comment by ID
@@ -2077,6 +2161,12 @@ client.comments.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific comment by ID.
@@ -2204,6 +2294,12 @@ client.comments.update(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get info about the currently authenticated user.
@@ -2264,6 +2360,12 @@ client.users.get_current_user()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update details for the currently authenticated user.
@@ -4597,6 +4699,12 @@ client.organizations.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update organization details including title, embed domains, and Plugins settings.
@@ -4739,6 +4847,12 @@ client.organizations.update(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update the default role for members of a specific organization.
@@ -5683,7 +5797,13 @@ client.ml.predict_interactive(
-Note: not available in the community edition of Label Studio. + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create predictions for all tasks using a specific ML backend so that you can set up an active learning strategy based on the confidence or uncertainty scores associated with the predictions. Creating predictions requires a Label Studio ML backend set up and configured for your project. @@ -5921,6 +6041,12 @@ client.ml.list_model_versions(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all model provider connections.
@@ -5989,6 +6115,12 @@ client.model_providers.list()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new model provider connection.
@@ -6145,6 +6277,12 @@ client.model_providers.create()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all possible model provider choices
@@ -6205,6 +6343,12 @@ client.model_providers.list_model_provider_choices()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific model provider connection.
@@ -6275,6 +6419,12 @@ client.model_providers.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a model provider connection by ID
@@ -6345,6 +6495,12 @@ client.model_providers.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific model provider connection by ID.
@@ -6512,6 +6668,12 @@ client.model_providers.update(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new batch of failed predictions.
@@ -6607,6 +6769,12 @@ client.prompts.batch_failed_predictions(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new batch prediction.
@@ -6702,6 +6870,12 @@ client.prompts.batch_predictions(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Provides list of tasks, based on project subset. Includes predictions for tasks. For the 'HasGT' subset, accuracy metrics will also be provided. @@ -6830,6 +7004,12 @@ client.prompts.subset_tasks(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Provides list of available subsets for a project along with count of tasks in each subset @@ -6978,6 +7158,12 @@ client.prompts.list()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new prompt.
@@ -7196,6 +7382,12 @@ client.prompts.compatible_projects()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific prompt.
@@ -7266,6 +7458,12 @@ client.prompts.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a prompt by ID
@@ -7336,6 +7534,12 @@ client.prompts.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific prompt by ID.
@@ -7923,6 +8127,12 @@ client.predictions.update(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all project templates for an organization.
@@ -7991,6 +8201,12 @@ client.project_templates.list()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a project template for an organization.
@@ -8150,6 +8366,12 @@ client.project_templates.create(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific project template by ID for an organization.
@@ -8220,6 +8442,12 @@ client.project_templates.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific project template by ID for an organization.
@@ -8290,6 +8518,12 @@ client.project_templates.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update the details of a specific project template by ID for an organization.
@@ -8456,6 +8690,12 @@ client.project_templates.update(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a project from a specific project template by ID for an organization.
@@ -9746,6 +9986,12 @@ client.projects.list_unique_annotators(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Make a copy of project.
@@ -11812,6 +12058,12 @@ client.tokens.rotate(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get version information about the Label Studio instance.
@@ -13480,6 +13732,12 @@ client.export_storage.azure.sync(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all Azure export storage connections that were set up with Service Principal authentication.
@@ -13556,6 +13814,12 @@ client.export_storage.azure_spi.list()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create an Azure export storage connection with Service Principal authentication to store annotations.
@@ -13778,6 +14042,12 @@ client.export_storage.azure_spi.create(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific Azure export storage connection that was set up with Service Principal authentication.
@@ -14000,6 +14270,12 @@ client.export_storage.azure_spi.validate(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific Azure export storage connection that was set up with Service Principal authentication.
@@ -14070,6 +14346,12 @@ client.export_storage.azure_spi.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific Azure export storage connection that was set up with Service Principal authentication.
@@ -14140,6 +14422,12 @@ client.export_storage.azure_spi.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific Azure export storage connection that was set up with Service Principal authentication.
@@ -14370,6 +14658,12 @@ client.export_storage.azure_spi.update(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an Azure SPI export storage.
@@ -14441,6 +14735,12 @@ client.export_storage.azure_spi.sync(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all Databricks Files export storage connections.
@@ -14517,6 +14817,12 @@ client.export_storage.databricks.list()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a Databricks Files export storage connection.
@@ -14759,6 +15065,12 @@ client.export_storage.databricks.create(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific Databricks Files export storage connection.
@@ -15001,6 +15313,12 @@ client.export_storage.databricks.validate(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific Databricks Files export storage connection.
@@ -15071,6 +15389,12 @@ client.export_storage.databricks.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific Databricks Files export storage connection.
@@ -15141,6 +15465,12 @@ client.export_storage.databricks.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific Databricks Files export storage connection.
@@ -15387,6 +15717,12 @@ client.export_storage.databricks.update(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Export annotations to a Databricks Files storage.
@@ -16135,6 +16471,12 @@ client.export_storage.gcs.sync(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all GCS export storage connections that were set up with WIF authentication.
@@ -16211,6 +16553,12 @@ client.export_storage.gcswif.list()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create an GCS export storage connection with WIF authentication to store annotations.
@@ -16441,6 +16789,12 @@ client.export_storage.gcswif.create(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific GCS export storage connection that was set up with WIF authentication.
@@ -16671,6 +17025,12 @@ client.export_storage.gcswif.validate(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific GCS export storage connection that was set up with WIF authentication.
@@ -16741,6 +17101,12 @@ client.export_storage.gcswif.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific GCS export storage connection that was set up with WIF authentication.
@@ -16811,6 +17177,12 @@ client.export_storage.gcswif.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific GCS export storage connection that was set up with WIF authentication.
@@ -17049,6 +17421,12 @@ client.export_storage.gcswif.update(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an GCS WIF export storage.
@@ -19223,6 +19601,12 @@ client.export_storage.s3.sync(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all S3 export storage connections that were set up with IAM role access.
@@ -19299,6 +19683,12 @@ client.export_storage.s3s.list()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create an S3 export storage connection with IAM role access to store annotations.
@@ -19554,6 +19944,12 @@ client.export_storage.s3s.create(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific S3 export storage connection that was set up with IAM role access.
@@ -19809,6 +20205,12 @@ client.export_storage.s3s.validate(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific S3 export storage connection that was set up with IAM role access.
@@ -19879,6 +20281,12 @@ client.export_storage.s3s.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific S3 export storage connection that was set up with IAM role access.
@@ -19949,6 +20357,12 @@ client.export_storage.s3s.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific S3 export storage connection that was set up with IAM role access.
@@ -20211,6 +20625,12 @@ client.export_storage.s3s.update(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an S3 export storage.
@@ -21031,6 +21451,12 @@ client.import_storage.azure.sync(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get list of all Azure import storage connections set up with Service Principal authentication.
@@ -21107,6 +21533,12 @@ client.import_storage.azure_spi.list()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create Azure import storage with Service Principal authentication.
@@ -21345,6 +21777,12 @@ client.import_storage.azure_spi.create(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific Azure import storage connection that was set up with Service Principal authentication.
@@ -21583,6 +22021,12 @@ client.import_storage.azure_spi.validate(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific Azure import storage connection that was set up with Service Principal authentication.
@@ -21653,6 +22097,12 @@ client.import_storage.azure_spi.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific Azure import storage connection that was set up with Service Principal authentication.
@@ -21723,6 +22173,12 @@ client.import_storage.azure_spi.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific Azure import storage connection that was set up with Service Principal authentication.
@@ -21969,6 +22425,12 @@ client.import_storage.azure_spi.update(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an Azure import storage connection that was set up with Service Principal authentication.
@@ -22040,6 +22502,12 @@ client.import_storage.azure_spi.sync(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get list of all Databricks Files import storage connections.
@@ -22116,6 +22584,12 @@ client.import_storage.databricks.list()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a Databricks Files import storage connection.
@@ -22374,6 +22848,12 @@ client.import_storage.databricks.create(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific Databricks Files import storage connection.
@@ -22632,6 +23112,12 @@ client.import_storage.databricks.validate(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific Databricks Files import storage connection.
@@ -22702,6 +23188,12 @@ client.import_storage.databricks.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific Databricks Files import storage connection.
@@ -22772,6 +23264,12 @@ client.import_storage.databricks.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific Databricks Files import storage connection.
@@ -23034,6 +23532,12 @@ client.import_storage.databricks.update(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from a Databricks Files import storage.
@@ -23854,6 +24358,12 @@ client.import_storage.gcs.sync(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get list of all GCS import storage connections set up with WIF authentication.
@@ -23930,6 +24440,12 @@ client.import_storage.gcswif.list()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create GCS import storage with WIF.
@@ -24176,6 +24692,12 @@ client.import_storage.gcswif.create(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific GCS import storage connection that was set up with WIF authentication.
@@ -24422,6 +24944,12 @@ client.import_storage.gcswif.validate(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific GCS import storage connection that was set up with WIF.
@@ -24492,6 +25020,12 @@ client.import_storage.gcswif.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific GCS import storage connection that was set up with WIF authentication.
@@ -24562,6 +25096,12 @@ client.import_storage.gcswif.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific GCS import storage connection that was set up with WIF authentication.
@@ -24816,6 +25356,12 @@ client.import_storage.gcswif.update(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an GCS import storage connection that was set up with WIF authentication.
@@ -27086,6 +27632,12 @@ client.import_storage.s3.sync(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get list of all S3 import storage connections set up with IAM role access.
@@ -27162,6 +27714,12 @@ client.import_storage.s3s.list()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create S3 import storage with IAM role access.
@@ -27433,6 +27991,12 @@ client.import_storage.s3s.create(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific S3 import storage connection that was set up with IAM role access.
@@ -27704,6 +28268,12 @@ client.import_storage.s3s.validate(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific S3 import storage connection that was set up with IAM role access.
@@ -27774,6 +28344,12 @@ client.import_storage.s3s.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific S3 import storage connection that was set up with IAM role access.
@@ -27844,6 +28420,12 @@ client.import_storage.s3s.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific S3 import storage connection that was set up with IAM role access.
@@ -28122,6 +28704,12 @@ client.import_storage.s3s.update(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an S3 import storage connection that was set up with IAM role access.
@@ -28253,6 +28841,12 @@ client.organizations.invites.get_invite_link()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Revoke invite to organization
@@ -28323,6 +28917,12 @@ client.organizations.invites.revoke_invite(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Send email with invite to organization
@@ -28419,6 +29019,12 @@ client.organizations.invites.send_email(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a list of all users and roles in a specific organization.
@@ -28537,6 +29143,12 @@ client.organizations.members.list(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update organization membership or role for a specific user ID. **User Rotation Best Practices for API Usage** @@ -28795,6 +29407,12 @@ client.organizations.members.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all organization-level permission overrides for a given organization.
@@ -28873,6 +29491,12 @@ client.organizations.permissions.list(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new organization-level permission override for a given organization.
@@ -28960,6 +29584,12 @@ client.organizations.permissions.create(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve the list of configurable permission options (label, tooltip, default role and allowed roles).
@@ -29103,6 +29733,12 @@ client.organizations.permissions.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Replace the organization-level permission override for a given permission key.
@@ -29264,6 +29900,12 @@ client.organizations.permissions.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Partially update the organization-level permission override for a given permission key.
@@ -29913,6 +30555,12 @@ client.projects.exports.convert(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve the members for a specific project. Optionally filter by user IDs (comma-separated).
@@ -29992,6 +30640,12 @@ client.projects.members.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get the current metrics configuration for a project.
@@ -30062,6 +30716,12 @@ client.projects.metrics.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update metrics strategy and parameters for a project.
@@ -30153,7 +30813,7 @@ client.projects.metrics.update( ## Projects Stats -
client.projects.stats.iaa(...) +
client.projects.stats.model_version_annotator_agreement(...)
@@ -30165,7 +30825,13 @@ client.projects.metrics.update(
-Get Inter-Annotator Agreement (IAA) matrix for a project, showing agreement between all annotators. + + Label Studio Enterprise badge +

+ 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.
@@ -30185,8 +30851,9 @@ from label_studio_sdk import LabelStudio client = LabelStudio( api_key="YOUR_API_KEY", ) -client.projects.stats.iaa( +client.projects.stats.model_version_annotator_agreement( id=1, + model_version="model_version", ) ``` @@ -30211,31 +30878,7 @@ client.projects.stats.iaa(
-**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 +**model_version:** `str`
@@ -30255,7 +30898,7 @@ client.projects.stats.iaa(
-
client.projects.stats.agreement_annotator(...) +
client.projects.stats.model_version_ground_truth_agreement(...)
@@ -30267,7 +30910,13 @@ client.projects.stats.iaa(
-Get agreement statistics for a specific annotator within a project. + + Label Studio Enterprise badge +

+ 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.
@@ -30287,9 +30936,9 @@ from label_studio_sdk import LabelStudio client = LabelStudio( api_key="YOUR_API_KEY", ) -client.projects.stats.agreement_annotator( +client.projects.stats.model_version_ground_truth_agreement( id=1, - user_id=1, + model_version="model_version", ) ``` @@ -30314,7 +30963,7 @@ client.projects.stats.agreement_annotator(
-**user_id:** `int` +**model_version:** `str`
@@ -30322,69 +30971,7 @@ client.projects.stats.agreement_annotator(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
- - -
client.projects.stats.data_filters(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get statistics about user data filters and their usage within a project. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from label_studio_sdk import LabelStudio - -client = LabelStudio( - api_key="YOUR_API_KEY", -) -client.projects.stats.data_filters( - id=1, -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**id:** `int` +**per_label:** `typing.Optional[bool]` — Calculate agreement per label
@@ -30404,7 +30991,7 @@ client.projects.stats.data_filters(
-
client.projects.stats.finished_tasks(...) +
client.projects.stats.model_version_prediction_agreement(...)
@@ -30416,7 +31003,13 @@ client.projects.stats.data_filters(
-Get statistics about finished tasks for a project. + + Label Studio Enterprise badge +

+ 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.
@@ -30436,7 +31029,357 @@ from label_studio_sdk import LabelStudio client = LabelStudio( api_key="YOUR_API_KEY", ) -client.projects.stats.finished_tasks( +client.projects.stats.model_version_prediction_agreement( + id=1, + model_version="model_version", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `int` + +
+
+ +
+
+ +**model_version:** `str` + +
+
+ +
+
+ +**per_label:** `typing.Optional[bool]` — Calculate agreement per label + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + + + + + +
client.projects.stats.iaa(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ + + Label Studio Enterprise badge +

+ 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. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from label_studio_sdk import LabelStudio + +client = LabelStudio( + api_key="YOUR_API_KEY", +) +client.projects.stats.iaa( + id=1, +) + +``` +
+
+
+
+ +#### ⚙️ 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. + +
+
+
+
+ + +
+
+
+ +
client.projects.stats.agreement_annotator(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ + + Label Studio Enterprise badge +

+ 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. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from label_studio_sdk import LabelStudio + +client = LabelStudio( + api_key="YOUR_API_KEY", +) +client.projects.stats.agreement_annotator( + id=1, + user_id=1, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `int` + +
+
+ +
+
+ +**user_id:** `int` + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.projects.stats.data_filters(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get statistics about user data filters and their usage within a project. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from label_studio_sdk import LabelStudio + +client = LabelStudio( + api_key="YOUR_API_KEY", +) +client.projects.stats.data_filters( + id=1, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `int` + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.projects.stats.finished_tasks(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get statistics about finished tasks for a project. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from label_studio_sdk import LabelStudio + +client = LabelStudio( + api_key="YOUR_API_KEY", +) +client.projects.stats.finished_tasks( id=1, ) @@ -30564,6 +31507,12 @@ client.projects.stats.lead_time(
+ + Label Studio Enterprise badge +

+ 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. @@ -30722,6 +31671,12 @@ client.projects.stats.update_stats(
+ + Label Studio Enterprise badge +

+ 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.
@@ -30809,6 +31764,12 @@ client.projects.stats.user_prediction_agreement(
+ + Label Studio Enterprise badge +

+ 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.
@@ -30896,6 +31857,12 @@ client.projects.stats.user_review_score(
+ + Label Studio Enterprise badge +

+ 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.
@@ -30984,6 +31951,12 @@ client.projects.stats.user_ground_truth_agreement(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Assign multiple users to a collection of tasks within a specific project.
@@ -31094,6 +32067,12 @@ client.projects.assignments.bulk_assign(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a list of tasks and assignees for those tasks for a specific project.
@@ -31173,6 +32152,12 @@ client.projects.assignments.list(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Assign a user to a task in a specific project.
@@ -31270,6 +32255,12 @@ client.projects.assignments.assign(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Remove assignees for a task within a specific project.
@@ -31365,6 +32356,12 @@ client.projects.assignments.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update the assignee for a task in a specific project.
@@ -31463,6 +32460,12 @@ client.projects.assignments.update(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a list of all pauses.
@@ -31558,6 +32561,12 @@ client.projects.pauses.list(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new pause entry.
@@ -31662,6 +32671,12 @@ Reason for pausing
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific pause by ID.
@@ -31750,6 +32765,12 @@ client.projects.pauses.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific pause by ID.
@@ -31838,6 +32859,12 @@ client.projects.pauses.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Partially update a pause entry by ID.
@@ -31951,6 +32978,12 @@ Reason for pausing
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Assign project members in bulk.
@@ -32062,6 +33095,12 @@ client.projects.members.bulk.post(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Unassign project members in bulk. Allows the same request body as bulk assign.
@@ -32141,6 +33180,12 @@ client.projects.members.bulk.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve the members for a specific project.
@@ -32612,6 +33657,12 @@ client.projects.metrics.custom.check_function(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get key indicators for the Prompt dashboard.
@@ -32682,6 +33733,12 @@ client.prompts.indicators.list(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific key indicator for the Prompt dashboard.
@@ -32762,6 +33819,12 @@ client.prompts.indicators.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get default prompt version name
@@ -32832,6 +33895,12 @@ client.prompts.versions.get_default_version_name(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all versions of a prompt.
@@ -32910,6 +33979,12 @@ client.prompts.versions.list(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new version of a prompt.
@@ -33049,6 +34124,12 @@ The model provider to use e.g. OpenAI
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific prompt of a model.
@@ -33128,6 +34209,12 @@ client.prompts.versions.get(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a prompt version by ID
@@ -33207,6 +34294,12 @@ client.prompts.versions.delete(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific prompt version by ID.
@@ -33352,6 +34445,12 @@ The model provider to use e.g. OpenAI
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get an estimate of the cost for making an inference run on the selected Prompt Version and Project/ProjectSubset
@@ -33633,6 +34732,12 @@ client.prompts.versions.refine_prompt(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get information (status, metadata, etc) about an existing inference run
@@ -33744,6 +34849,12 @@ client.prompts.runs.list(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Run a prompt inference.
@@ -33888,6 +34999,12 @@ client.prompts.runs.create(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Cancel the inference run for the given api
@@ -33977,6 +35094,12 @@ client.prompts.runs.cancel(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve SAML2 settings for the currently active organization.
@@ -34037,6 +35160,12 @@ client.sso.saml.get()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update SAML2 settings for the currently active organization.
@@ -34132,6 +35261,12 @@ client.sso.saml.update(
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve SCIM settings for the currently active organization.
@@ -34192,6 +35327,12 @@ client.sso.scim.get()
+ + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update SCIM settings for the currently active organization.
diff --git a/src/label_studio_sdk/activity_logs/client.py b/src/label_studio_sdk/activity_logs/client.py index fa1c710fe..39d04a6b0 100644 --- a/src/label_studio_sdk/activity_logs/client.py +++ b/src/label_studio_sdk/activity_logs/client.py @@ -32,6 +32,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[ActivityLogResponse]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve activity logs filtered by workspace, project, user, HTTP method, date range or search query. Parameters @@ -145,6 +151,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[ActivityLogResponse]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve activity logs filtered by workspace, project, user, HTTP method, date range or search query. Parameters diff --git a/src/label_studio_sdk/annotation_history/client.py b/src/label_studio_sdk/annotation_history/client.py index 6565de665..6b12135cc 100644 --- a/src/label_studio_sdk/annotation_history/client.py +++ b/src/label_studio_sdk/annotation_history/client.py @@ -25,6 +25,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[AnnotationHistory]: """ + + Label Studio Enterprise badge +

+ 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 @@ -84,6 +90,12 @@ def delete( request_options: typing.Optional[RequestOptions] = None, ) -> AnnotationHistoryDeleteResponse: """ + + Label Studio Enterprise badge +

+ 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 @@ -147,6 +159,12 @@ def list_for_project( request_options: typing.Optional[RequestOptions] = None, ) -> PaginatedAnnotationHistoryList: """ + + Label Studio Enterprise badge +

+ 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 @@ -214,6 +232,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[AnnotationHistory]: """ + + Label Studio Enterprise badge +

+ 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 @@ -281,6 +305,12 @@ async def delete( request_options: typing.Optional[RequestOptions] = None, ) -> AnnotationHistoryDeleteResponse: """ + + Label Studio Enterprise badge +

+ 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 @@ -352,6 +382,12 @@ async def list_for_project( request_options: typing.Optional[RequestOptions] = None, ) -> PaginatedAnnotationHistoryList: """ + + Label Studio Enterprise badge +

+ 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 diff --git a/src/label_studio_sdk/annotation_reviews/client.py b/src/label_studio_sdk/annotation_reviews/client.py index ce1118bbc..c37b294d8 100644 --- a/src/label_studio_sdk/annotation_reviews/client.py +++ b/src/label_studio_sdk/annotation_reviews/client.py @@ -28,6 +28,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[AnnotationReview]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all reviews for a specific annotation ID. Parameters @@ -94,6 +100,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> AnnotationReview: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a review for a specific annotation ID. Parameters @@ -170,6 +182,12 @@ def create( def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> AnnotationReview: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific review by ID for an annotation. Parameters @@ -217,6 +235,12 @@ def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = Non def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a review by ID Parameters @@ -269,6 +293,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> AnnotationReview: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific review by ID. Parameters @@ -357,6 +387,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[AnnotationReview]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all reviews for a specific annotation ID. Parameters @@ -431,6 +467,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AnnotationReview: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a review for a specific annotation ID. Parameters @@ -515,6 +557,12 @@ async def main() -> None: async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> AnnotationReview: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific review by ID for an annotation. Parameters @@ -570,6 +618,12 @@ async def main() -> None: async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a review by ID Parameters @@ -630,6 +684,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> AnnotationReview: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific review by ID. Parameters diff --git a/src/label_studio_sdk/billing/client.py b/src/label_studio_sdk/billing/client.py index 3384bd56a..68d847ef3 100644 --- a/src/label_studio_sdk/billing/client.py +++ b/src/label_studio_sdk/billing/client.py @@ -16,6 +16,12 @@ def __init__(self, *, client_wrapper: SyncClientWrapper): def info(self, *, request_options: typing.Optional[RequestOptions] = None) -> BillingInfoResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve billing checks and feature flags for the active organization. Parameters @@ -63,6 +69,12 @@ def __init__(self, *, client_wrapper: AsyncClientWrapper): async def info(self, *, request_options: typing.Optional[RequestOptions] = None) -> BillingInfoResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve billing checks and feature flags for the active organization. Parameters diff --git a/src/label_studio_sdk/comments/client.py b/src/label_studio_sdk/comments/client.py index 4213d8538..795331843 100644 --- a/src/label_studio_sdk/comments/client.py +++ b/src/label_studio_sdk/comments/client.py @@ -30,6 +30,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[MaybeExpandedComment]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all comments for a specific annotation ID. Parameters @@ -104,6 +110,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> MaybeExpandedComment: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a comment for a specific annotation ID. Parameters @@ -185,6 +197,12 @@ def export( request_options: typing.Optional[RequestOptions] = None, ) -> typing.Iterator[bytes]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Export comments to CSV file Parameters @@ -243,6 +261,12 @@ def get( request_options: typing.Optional[RequestOptions] = None, ) -> MaybeExpandedComment: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific comment by ID for an annotation. Parameters @@ -301,6 +325,12 @@ def delete( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a comment by ID Parameters @@ -358,6 +388,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> MaybeExpandedComment: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific comment by ID. Parameters @@ -451,6 +487,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[MaybeExpandedComment]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all comments for a specific annotation ID. Parameters @@ -533,6 +575,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> MaybeExpandedComment: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a comment for a specific annotation ID. Parameters @@ -622,6 +670,12 @@ async def export( request_options: typing.Optional[RequestOptions] = None, ) -> typing.AsyncIterator[bytes]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Export comments to CSV file Parameters @@ -680,6 +734,12 @@ async def get( request_options: typing.Optional[RequestOptions] = None, ) -> MaybeExpandedComment: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific comment by ID for an annotation. Parameters @@ -746,6 +806,12 @@ async def delete( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a comment by ID Parameters @@ -811,6 +877,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> MaybeExpandedComment: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific comment by ID. Parameters diff --git a/src/label_studio_sdk/export_storage/azure_spi/client.py b/src/label_studio_sdk/export_storage/azure_spi/client.py index f46af9625..b159dd175 100644 --- a/src/label_studio_sdk/export_storage/azure_spi/client.py +++ b/src/label_studio_sdk/export_storage/azure_spi/client.py @@ -28,6 +28,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[AzureServicePrincipalExportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all Azure export storage connections that were set up with Service Principal authentication. Parameters @@ -104,6 +110,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> AzureServicePrincipalExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create an Azure export storage connection with Service Principal authentication to store annotations. Parameters @@ -252,6 +264,12 @@ def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific Azure export storage connection that was set up with Service Principal authentication. Parameters @@ -371,6 +389,12 @@ def get( self, id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> AzureServicePrincipalExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific Azure export storage connection that was set up with Service Principal authentication. Parameters @@ -417,6 +441,12 @@ def get( def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific Azure export storage connection that was set up with Service Principal authentication. Parameters @@ -481,6 +511,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> AzureServicePrincipalExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific Azure export storage connection that was set up with Service Principal authentication. Parameters @@ -612,6 +648,12 @@ def sync( self, id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> AzureServicePrincipalExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an Azure SPI export storage. Parameters @@ -669,6 +711,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[AzureServicePrincipalExportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all Azure export storage connections that were set up with Service Principal authentication. Parameters @@ -753,6 +801,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AzureServicePrincipalExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create an Azure export storage connection with Service Principal authentication to store annotations. Parameters @@ -909,6 +963,12 @@ async def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific Azure export storage connection that was set up with Service Principal authentication. Parameters @@ -1036,6 +1096,12 @@ async def get( self, id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> AzureServicePrincipalExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific Azure export storage connection that was set up with Service Principal authentication. Parameters @@ -1090,6 +1156,12 @@ async def main() -> None: async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific Azure export storage connection that was set up with Service Principal authentication. Parameters @@ -1162,6 +1234,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> AzureServicePrincipalExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific Azure export storage connection that was set up with Service Principal authentication. Parameters @@ -1301,6 +1379,12 @@ async def sync( self, id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> AzureServicePrincipalExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an Azure SPI export storage. Parameters diff --git a/src/label_studio_sdk/export_storage/databricks/client.py b/src/label_studio_sdk/export_storage/databricks/client.py index fadb4ad70..a350c8100 100644 --- a/src/label_studio_sdk/export_storage/databricks/client.py +++ b/src/label_studio_sdk/export_storage/databricks/client.py @@ -28,6 +28,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[DatabricksExportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all Databricks Files export storage connections. Parameters @@ -106,6 +112,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> DatabricksExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a Databricks Files export storage connection. Parameters @@ -265,6 +277,12 @@ def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific Databricks Files export storage connection. Parameters @@ -391,6 +409,12 @@ def validate( def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> DatabricksExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific Databricks Files export storage connection. Parameters @@ -437,6 +461,12 @@ def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = Non def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific Databricks Files export storage connection. Parameters @@ -503,6 +533,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> DatabricksExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific Databricks Files export storage connection. Parameters @@ -637,6 +673,12 @@ def update( def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> DatabricksExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Export annotations to a Databricks Files storage. Parameters @@ -694,6 +736,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[DatabricksExportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all Databricks Files export storage connections. Parameters @@ -780,6 +828,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> DatabricksExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a Databricks Files export storage connection. Parameters @@ -947,6 +1001,12 @@ async def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific Databricks Files export storage connection. Parameters @@ -1081,6 +1141,12 @@ async def main() -> None: async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> DatabricksExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific Databricks Files export storage connection. Parameters @@ -1135,6 +1201,12 @@ async def main() -> None: async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific Databricks Files export storage connection. Parameters @@ -1209,6 +1281,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> DatabricksExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific Databricks Files export storage connection. Parameters @@ -1353,6 +1431,12 @@ async def sync( self, id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> DatabricksExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Export annotations to a Databricks Files storage. Parameters diff --git a/src/label_studio_sdk/export_storage/gcswif/client.py b/src/label_studio_sdk/export_storage/gcswif/client.py index cb4a1d3b0..b8fdb8f8d 100644 --- a/src/label_studio_sdk/export_storage/gcswif/client.py +++ b/src/label_studio_sdk/export_storage/gcswif/client.py @@ -28,6 +28,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[GcswifExportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all GCS export storage connections that were set up with WIF authentication. Parameters @@ -105,6 +111,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> GcswifExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create an GCS export storage connection with WIF authentication to store annotations. Parameters @@ -258,6 +270,12 @@ def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific GCS export storage connection that was set up with WIF authentication. Parameters @@ -379,6 +397,12 @@ def validate( def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcswifExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific GCS export storage connection that was set up with WIF authentication. Parameters @@ -425,6 +449,12 @@ def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = Non def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific GCS export storage connection that was set up with WIF authentication. Parameters @@ -490,6 +520,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> GcswifExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific GCS export storage connection that was set up with WIF authentication. Parameters @@ -623,6 +659,12 @@ def update( def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcswifExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an GCS WIF export storage. Parameters @@ -680,6 +722,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[GcswifExportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all GCS export storage connections that were set up with WIF authentication. Parameters @@ -765,6 +813,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> GcswifExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create an GCS export storage connection with WIF authentication to store annotations. Parameters @@ -926,6 +980,12 @@ async def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific GCS export storage connection that was set up with WIF authentication. Parameters @@ -1055,6 +1115,12 @@ async def main() -> None: async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcswifExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific GCS export storage connection that was set up with WIF authentication. Parameters @@ -1109,6 +1175,12 @@ async def main() -> None: async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific GCS export storage connection that was set up with WIF authentication. Parameters @@ -1182,6 +1254,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> GcswifExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific GCS export storage connection that was set up with WIF authentication. Parameters @@ -1323,6 +1401,12 @@ async def main() -> None: async def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcswifExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an GCS WIF export storage. Parameters diff --git a/src/label_studio_sdk/export_storage/s3s/client.py b/src/label_studio_sdk/export_storage/s3s/client.py index e2c3e18ff..234e90af2 100644 --- a/src/label_studio_sdk/export_storage/s3s/client.py +++ b/src/label_studio_sdk/export_storage/s3s/client.py @@ -28,6 +28,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[LseS3ExportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all S3 export storage connections that were set up with IAM role access. Parameters @@ -108,6 +114,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> LseS3ExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create an S3 export storage connection with IAM role access to store annotations. Parameters @@ -276,6 +288,12 @@ def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific S3 export storage connection that was set up with IAM role access. Parameters @@ -409,6 +427,12 @@ def validate( def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LseS3ExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific S3 export storage connection that was set up with IAM role access. Parameters @@ -455,6 +479,12 @@ def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = Non def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific S3 export storage connection that was set up with IAM role access. Parameters @@ -523,6 +553,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> LseS3ExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific S3 export storage connection that was set up with IAM role access. Parameters @@ -667,6 +703,12 @@ def update( def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LseS3ExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an S3 export storage. Parameters @@ -724,6 +766,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[LseS3ExportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all S3 export storage connections that were set up with IAM role access. Parameters @@ -812,6 +860,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> LseS3ExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create an S3 export storage connection with IAM role access to store annotations. Parameters @@ -988,6 +1042,12 @@ async def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific S3 export storage connection that was set up with IAM role access. Parameters @@ -1129,6 +1189,12 @@ async def main() -> None: async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LseS3ExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific S3 export storage connection that was set up with IAM role access. Parameters @@ -1183,6 +1249,12 @@ async def main() -> None: async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific S3 export storage connection that was set up with IAM role access. Parameters @@ -1259,6 +1331,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> LseS3ExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific S3 export storage connection that was set up with IAM role access. Parameters @@ -1411,6 +1489,12 @@ async def main() -> None: async def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LseS3ExportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an S3 export storage. Parameters diff --git a/src/label_studio_sdk/import_storage/azure_spi/client.py b/src/label_studio_sdk/import_storage/azure_spi/client.py index e941444dc..804a02e20 100644 --- a/src/label_studio_sdk/import_storage/azure_spi/client.py +++ b/src/label_studio_sdk/import_storage/azure_spi/client.py @@ -28,6 +28,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[AzureServicePrincipalImportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get list of all Azure import storage connections set up with Service Principal authentication. Parameters @@ -106,6 +112,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> AzureServicePrincipalImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create Azure import storage with Service Principal authentication. Parameters @@ -263,6 +275,12 @@ def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific Azure import storage connection that was set up with Service Principal authentication. Parameters @@ -389,6 +407,12 @@ def get( self, id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> AzureServicePrincipalImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific Azure import storage connection that was set up with Service Principal authentication. Parameters @@ -435,6 +459,12 @@ def get( def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific Azure import storage connection that was set up with Service Principal authentication. Parameters @@ -501,6 +531,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> AzureServicePrincipalImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific Azure import storage connection that was set up with Service Principal authentication. Parameters @@ -639,6 +675,12 @@ def sync( self, id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> AzureServicePrincipalImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an Azure import storage connection that was set up with Service Principal authentication. Parameters @@ -696,6 +738,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[AzureServicePrincipalImportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get list of all Azure import storage connections set up with Service Principal authentication. Parameters @@ -782,6 +830,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AzureServicePrincipalImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create Azure import storage with Service Principal authentication. Parameters @@ -947,6 +1001,12 @@ async def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific Azure import storage connection that was set up with Service Principal authentication. Parameters @@ -1081,6 +1141,12 @@ async def get( self, id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> AzureServicePrincipalImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific Azure import storage connection that was set up with Service Principal authentication. Parameters @@ -1135,6 +1201,12 @@ async def main() -> None: async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific Azure import storage connection that was set up with Service Principal authentication. Parameters @@ -1209,6 +1281,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> AzureServicePrincipalImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific Azure import storage connection that was set up with Service Principal authentication. Parameters @@ -1355,6 +1433,12 @@ async def sync( self, id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> AzureServicePrincipalImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an Azure import storage connection that was set up with Service Principal authentication. Parameters diff --git a/src/label_studio_sdk/import_storage/databricks/client.py b/src/label_studio_sdk/import_storage/databricks/client.py index 5dd3e8925..e8203005e 100644 --- a/src/label_studio_sdk/import_storage/databricks/client.py +++ b/src/label_studio_sdk/import_storage/databricks/client.py @@ -28,6 +28,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[DatabricksImportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get list of all Databricks Files import storage connections. Parameters @@ -108,6 +114,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> DatabricksImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a Databricks Files import storage connection. Parameters @@ -277,6 +289,12 @@ def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific Databricks Files import storage connection. Parameters @@ -411,6 +429,12 @@ def validate( def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> DatabricksImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific Databricks Files import storage connection. Parameters @@ -457,6 +481,12 @@ def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = Non def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific Databricks Files import storage connection. Parameters @@ -525,6 +555,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> DatabricksImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific Databricks Files import storage connection. Parameters @@ -667,6 +703,12 @@ def update( def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> DatabricksImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from a Databricks Files import storage. Parameters @@ -724,6 +766,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[DatabricksImportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get list of all Databricks Files import storage connections. Parameters @@ -812,6 +860,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> DatabricksImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a Databricks Files import storage connection. Parameters @@ -989,6 +1043,12 @@ async def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific Databricks Files import storage connection. Parameters @@ -1131,6 +1191,12 @@ async def main() -> None: async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> DatabricksImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific Databricks Files import storage connection. Parameters @@ -1185,6 +1251,12 @@ async def main() -> None: async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific Databricks Files import storage connection. Parameters @@ -1261,6 +1333,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> DatabricksImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific Databricks Files import storage connection. Parameters @@ -1413,6 +1491,12 @@ async def sync( self, id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> DatabricksImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from a Databricks Files import storage. Parameters diff --git a/src/label_studio_sdk/import_storage/gcswif/client.py b/src/label_studio_sdk/import_storage/gcswif/client.py index 09a181e78..23fab0927 100644 --- a/src/label_studio_sdk/import_storage/gcswif/client.py +++ b/src/label_studio_sdk/import_storage/gcswif/client.py @@ -28,6 +28,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[GcswifImportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get list of all GCS import storage connections set up with WIF authentication. Parameters @@ -107,6 +113,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> GcswifImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create GCS import storage with WIF. Parameters @@ -269,6 +281,12 @@ def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific GCS import storage connection that was set up with WIF authentication. Parameters @@ -397,6 +415,12 @@ def validate( def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcswifImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific GCS import storage connection that was set up with WIF. Parameters @@ -443,6 +467,12 @@ def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = Non def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific GCS import storage connection that was set up with WIF authentication. Parameters @@ -510,6 +540,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> GcswifImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific GCS import storage connection that was set up with WIF authentication. Parameters @@ -650,6 +686,12 @@ def update( def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcswifImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an GCS import storage connection that was set up with WIF authentication. Parameters @@ -707,6 +749,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[GcswifImportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get list of all GCS import storage connections set up with WIF authentication. Parameters @@ -794,6 +842,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> GcswifImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create GCS import storage with WIF. Parameters @@ -964,6 +1018,12 @@ async def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific GCS import storage connection that was set up with WIF authentication. Parameters @@ -1100,6 +1160,12 @@ async def main() -> None: async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcswifImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific GCS import storage connection that was set up with WIF. Parameters @@ -1154,6 +1220,12 @@ async def main() -> None: async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific GCS import storage connection that was set up with WIF authentication. Parameters @@ -1229,6 +1301,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> GcswifImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific GCS import storage connection that was set up with WIF authentication. Parameters @@ -1377,6 +1455,12 @@ async def main() -> None: async def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> GcswifImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an GCS import storage connection that was set up with WIF authentication. Parameters diff --git a/src/label_studio_sdk/import_storage/s3s/client.py b/src/label_studio_sdk/import_storage/s3s/client.py index 90706b349..04f80e07d 100644 --- a/src/label_studio_sdk/import_storage/s3s/client.py +++ b/src/label_studio_sdk/import_storage/s3s/client.py @@ -28,6 +28,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[LseS3ImportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get list of all S3 import storage connections set up with IAM role access. Parameters @@ -110,6 +116,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> LseS3ImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create S3 import storage with IAM role access. Parameters @@ -287,6 +299,12 @@ def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific S3 import storage connection that was set up with IAM role access. Parameters @@ -427,6 +445,12 @@ def validate( def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LseS3ImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific S3 import storage connection that was set up with IAM role access. Parameters @@ -473,6 +497,12 @@ def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = Non def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific S3 import storage connection that was set up with IAM role access. Parameters @@ -543,6 +573,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> LseS3ImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific S3 import storage connection that was set up with IAM role access. Parameters @@ -694,6 +730,12 @@ def update( def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LseS3ImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an S3 import storage connection that was set up with IAM role access. Parameters @@ -751,6 +793,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[LseS3ImportStorage]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get list of all S3 import storage connections set up with IAM role access. Parameters @@ -841,6 +889,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> LseS3ImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create S3 import storage with IAM role access. Parameters @@ -1026,6 +1080,12 @@ async def validate( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Validate a specific S3 import storage connection that was set up with IAM role access. Parameters @@ -1174,6 +1234,12 @@ async def main() -> None: async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LseS3ImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific S3 import storage connection that was set up with IAM role access. Parameters @@ -1228,6 +1294,12 @@ async def main() -> None: async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific S3 import storage connection that was set up with IAM role access. Parameters @@ -1306,6 +1378,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> LseS3ImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific S3 import storage connection that was set up with IAM role access. Parameters @@ -1465,6 +1543,12 @@ async def main() -> None: async def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LseS3ImportStorage: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Sync tasks from an S3 import storage connection that was set up with IAM role access. Parameters diff --git a/src/label_studio_sdk/ml/client.py b/src/label_studio_sdk/ml/client.py index bb079d7fb..374bcb41a 100644 --- a/src/label_studio_sdk/ml/client.py +++ b/src/label_studio_sdk/ml/client.py @@ -465,7 +465,13 @@ def predict_all_tasks( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ - Note: not available in the community edition of Label Studio. + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create predictions for all tasks using a specific ML backend so that you can set up an active learning strategy based on the confidence or uncertainty scores associated with the predictions. Creating predictions requires a Label Studio ML backend set up and configured for your project. @@ -1130,7 +1136,13 @@ async def predict_all_tasks( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ - Note: not available in the community edition of Label Studio. + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ + Create predictions for all tasks using a specific ML backend so that you can set up an active learning strategy based on the confidence or uncertainty scores associated with the predictions. Creating predictions requires a Label Studio ML backend set up and configured for your project. diff --git a/src/label_studio_sdk/model_providers/client.py b/src/label_studio_sdk/model_providers/client.py index 8aea3731a..3a960e5f2 100644 --- a/src/label_studio_sdk/model_providers/client.py +++ b/src/label_studio_sdk/model_providers/client.py @@ -25,6 +25,12 @@ def list( self, *, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[ModelProviderConnection]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all model provider connections. Parameters @@ -89,6 +95,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> ModelProviderConnection: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new model provider connection. Parameters @@ -182,6 +194,12 @@ def list_model_provider_choices( self, *, request_options: typing.Optional[RequestOptions] = None ) -> ModelProvidersListModelProviderChoicesResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all possible model provider choices Parameters @@ -224,6 +242,12 @@ def list_model_provider_choices( def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> ModelProviderConnection: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific model provider connection. Parameters @@ -270,6 +294,12 @@ def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = Non def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a model provider connection by ID Parameters @@ -326,6 +356,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> ModelProviderConnection: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific model provider connection by ID. Parameters @@ -431,6 +467,12 @@ async def list( self, *, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[ModelProviderConnection]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all model provider connections. Parameters @@ -503,6 +545,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> ModelProviderConnection: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new model provider connection. Parameters @@ -604,6 +652,12 @@ async def list_model_provider_choices( self, *, request_options: typing.Optional[RequestOptions] = None ) -> ModelProvidersListModelProviderChoicesResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all possible model provider choices Parameters @@ -654,6 +708,12 @@ async def main() -> None: async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> ModelProviderConnection: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific model provider connection. Parameters @@ -708,6 +768,12 @@ async def main() -> None: async def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a model provider connection by ID Parameters @@ -772,6 +838,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> ModelProviderConnection: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific model provider connection by ID. Parameters diff --git a/src/label_studio_sdk/organizations/client.py b/src/label_studio_sdk/organizations/client.py index a7a170b78..283dd9aff 100644 --- a/src/label_studio_sdk/organizations/client.py +++ b/src/label_studio_sdk/organizations/client.py @@ -195,6 +195,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> LseOrganization: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update organization details including title, embed domains, and Plugins settings. Parameters @@ -321,6 +327,12 @@ def update_default_role( request_options: typing.Optional[RequestOptions] = None, ) -> DefaultRole: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update the default role for members of a specific organization. Parameters @@ -618,6 +630,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> LseOrganization: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update organization details including title, embed domains, and Plugins settings. Parameters @@ -752,6 +770,12 @@ async def update_default_role( request_options: typing.Optional[RequestOptions] = None, ) -> DefaultRole: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update the default role for members of a specific organization. Parameters diff --git a/src/label_studio_sdk/organizations/invites/client.py b/src/label_studio_sdk/organizations/invites/client.py index 5b55dd970..2d75bd6d1 100644 --- a/src/label_studio_sdk/organizations/invites/client.py +++ b/src/label_studio_sdk/organizations/invites/client.py @@ -73,6 +73,12 @@ def get_invite_link(self, *, request_options: typing.Optional[RequestOptions] = def revoke_invite(self, *, email: str, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Revoke invite to organization Parameters @@ -127,6 +133,12 @@ def send_email( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Send email with invite to organization Parameters @@ -258,6 +270,12 @@ async def main() -> None: async def revoke_invite(self, *, email: str, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Revoke invite to organization Parameters @@ -320,6 +338,12 @@ async def send_email( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Send email with invite to organization Parameters diff --git a/src/label_studio_sdk/organizations/members/client.py b/src/label_studio_sdk/organizations/members/client.py index f89c51114..35020fe5a 100644 --- a/src/label_studio_sdk/organizations/members/client.py +++ b/src/label_studio_sdk/organizations/members/client.py @@ -37,6 +37,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> PaginatedLseOrganizationMemberListList: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a list of all users and roles in a specific organization. Parameters @@ -117,6 +123,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> LseOrganizationMemberList: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update organization membership or role for a specific user ID. **User Rotation Best Practices for API Usage** @@ -329,6 +341,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> PaginatedLseOrganizationMemberListList: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a list of all users and roles in a specific organization. Parameters @@ -417,6 +435,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> LseOrganizationMemberList: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update organization membership or role for a specific user ID. **User Rotation Best Practices for API Usage** diff --git a/src/label_studio_sdk/organizations/permissions/client.py b/src/label_studio_sdk/organizations/permissions/client.py index 6a356d5bb..8f71128e5 100644 --- a/src/label_studio_sdk/organizations/permissions/client.py +++ b/src/label_studio_sdk/organizations/permissions/client.py @@ -27,6 +27,12 @@ def list( self, id: int, *, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[OrganizationPermission]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all organization-level permission overrides for a given organization. Parameters @@ -86,6 +92,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> OrganizationPermission: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new organization-level permission override for a given organization. Parameters @@ -165,6 +177,12 @@ def get_options( self, id: int, *, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[ConfigurablePermissionOption]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve the list of configurable permission options (label, tooltip, default role and allowed roles). Parameters @@ -294,6 +312,12 @@ def replace( request_options: typing.Optional[RequestOptions] = None, ) -> OrganizationPermission: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Replace the organization-level permission override for a given permission key. Parameters @@ -454,6 +478,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> OrganizationPermission: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Partially update the organization-level permission override for a given permission key. Parameters @@ -553,6 +583,12 @@ async def list( self, id: int, *, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[OrganizationPermission]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all organization-level permission overrides for a given organization. Parameters @@ -620,6 +656,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> OrganizationPermission: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new organization-level permission override for a given organization. Parameters @@ -707,6 +749,12 @@ async def get_options( self, id: int, *, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[ConfigurablePermissionOption]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve the list of configurable permission options (label, tooltip, default role and allowed roles). Parameters @@ -852,6 +900,12 @@ async def replace( request_options: typing.Optional[RequestOptions] = None, ) -> OrganizationPermission: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Replace the organization-level permission override for a given permission key. Parameters @@ -1030,6 +1084,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> OrganizationPermission: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Partially update the organization-level permission override for a given permission key. Parameters diff --git a/src/label_studio_sdk/project_templates/client.py b/src/label_studio_sdk/project_templates/client.py index 764538ac5..c51b00f83 100644 --- a/src/label_studio_sdk/project_templates/client.py +++ b/src/label_studio_sdk/project_templates/client.py @@ -23,6 +23,12 @@ def list( self, *, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[ProjectTemplate]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all project templates for an organization. Parameters @@ -87,6 +93,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> ProjectTemplate: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a project template for an organization. Parameters @@ -173,6 +185,12 @@ def create( def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> ProjectTemplate: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific project template by ID for an organization. Parameters @@ -219,6 +237,12 @@ def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = Non def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific project template by ID for an organization. Parameters @@ -275,6 +299,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> ProjectTemplate: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update the details of a specific project template by ID for an organization. Parameters @@ -373,6 +403,12 @@ def create_project_from_template( request_options: typing.Optional[RequestOptions] = None, ) -> LseProject: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a project from a specific project template by ID for an organization. Parameters @@ -446,6 +482,12 @@ async def list( self, *, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[ProjectTemplate]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a list of all project templates for an organization. Parameters @@ -518,6 +560,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> ProjectTemplate: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a project template for an organization. Parameters @@ -612,6 +660,12 @@ async def main() -> None: async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> ProjectTemplate: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific project template by ID for an organization. Parameters @@ -666,6 +720,12 @@ async def main() -> None: async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific project template by ID for an organization. Parameters @@ -730,6 +790,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> ProjectTemplate: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update the details of a specific project template by ID for an organization. Parameters @@ -836,6 +902,12 @@ async def create_project_from_template( request_options: typing.Optional[RequestOptions] = None, ) -> LseProject: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a project from a specific project template by ID for an organization. Parameters diff --git a/src/label_studio_sdk/projects/__init__.py b/src/label_studio_sdk/projects/__init__.py index 414784786..8b3148988 100644 --- a/src/label_studio_sdk/projects/__init__.py +++ b/src/label_studio_sdk/projects/__init__.py @@ -39,6 +39,9 @@ StatsIaaResponseStd, StatsLeadTimeResponse, StatsLeadTimeResponseLeadTimeStatsItem, + StatsModelVersionAnnotatorAgreementResponse, + StatsModelVersionGroundTruthAgreementResponse, + StatsModelVersionPredictionAgreementResponse, StatsTotalAgreementResponse, StatsTotalAgreementResponseOne, StatsTotalAgreementResponseZero, @@ -85,6 +88,9 @@ "StatsIaaResponseStd", "StatsLeadTimeResponse", "StatsLeadTimeResponseLeadTimeStatsItem", + "StatsModelVersionAnnotatorAgreementResponse", + "StatsModelVersionGroundTruthAgreementResponse", + "StatsModelVersionPredictionAgreementResponse", "StatsTotalAgreementResponse", "StatsTotalAgreementResponseOne", "StatsTotalAgreementResponseZero", diff --git a/src/label_studio_sdk/projects/assignments/client.py b/src/label_studio_sdk/projects/assignments/client.py index 87c84c1d1..360d74b12 100644 --- a/src/label_studio_sdk/projects/assignments/client.py +++ b/src/label_studio_sdk/projects/assignments/client.py @@ -38,6 +38,12 @@ def bulk_assign( request_options: typing.Optional[RequestOptions] = None, ) -> AssignmentsBulkAssignResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Assign multiple users to a collection of tasks within a specific project. Parameters @@ -130,6 +136,12 @@ def list( self, id: int, task_pk: int, *, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[TaskAssignment]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a list of tasks and assignees for those tasks for a specific project. Parameters @@ -189,6 +201,12 @@ def assign( request_options: typing.Optional[RequestOptions] = None, ) -> TaskAssignment: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Assign a user to a task in a specific project. Parameters @@ -264,6 +282,12 @@ def delete( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Remove assignees for a task within a specific project. Parameters @@ -326,6 +350,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> TaskAssignment: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update the assignee for a task in a specific project. Parameters @@ -407,6 +437,12 @@ async def bulk_assign( request_options: typing.Optional[RequestOptions] = None, ) -> AssignmentsBulkAssignResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Assign multiple users to a collection of tasks within a specific project. Parameters @@ -507,6 +543,12 @@ async def list( self, id: int, task_pk: int, *, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[TaskAssignment]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a list of tasks and assignees for those tasks for a specific project. Parameters @@ -574,6 +616,12 @@ async def assign( request_options: typing.Optional[RequestOptions] = None, ) -> TaskAssignment: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Assign a user to a task in a specific project. Parameters @@ -657,6 +705,12 @@ async def delete( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Remove assignees for a task within a specific project. Parameters @@ -727,6 +781,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> TaskAssignment: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update the assignee for a task in a specific project. Parameters diff --git a/src/label_studio_sdk/projects/client.py b/src/label_studio_sdk/projects/client.py index 6373eee21..1fed8a684 100644 --- a/src/label_studio_sdk/projects/client.py +++ b/src/label_studio_sdk/projects/client.py @@ -883,6 +883,12 @@ def duplicate( request_options: typing.Optional[RequestOptions] = None, ) -> ProjectsDuplicateResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Make a copy of project. Parameters @@ -2114,6 +2120,12 @@ async def duplicate( request_options: typing.Optional[RequestOptions] = None, ) -> ProjectsDuplicateResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Make a copy of project. Parameters diff --git a/src/label_studio_sdk/projects/members/bulk/client.py b/src/label_studio_sdk/projects/members/bulk/client.py index c09ba179a..623bb162b 100644 --- a/src/label_studio_sdk/projects/members/bulk/client.py +++ b/src/label_studio_sdk/projects/members/bulk/client.py @@ -33,6 +33,12 @@ def post( request_options: typing.Optional[RequestOptions] = None, ) -> BulkPostResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Assign project members in bulk. Parameters @@ -108,6 +114,12 @@ def delete( self, id: int, *, search: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None ) -> BulkDeleteResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Unassign project members in bulk. Allows the same request body as bulk assign. Parameters @@ -175,6 +187,12 @@ async def post( request_options: typing.Optional[RequestOptions] = None, ) -> BulkPostResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Assign project members in bulk. Parameters @@ -258,6 +276,12 @@ async def delete( self, id: int, *, search: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None ) -> BulkDeleteResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Unassign project members in bulk. Allows the same request body as bulk assign. Parameters diff --git a/src/label_studio_sdk/projects/members/client.py b/src/label_studio_sdk/projects/members/client.py index ca4a4c4a8..e74d5e1d1 100644 --- a/src/label_studio_sdk/projects/members/client.py +++ b/src/label_studio_sdk/projects/members/client.py @@ -25,6 +25,12 @@ def get( self, id: int, *, user_ids: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[LseUser]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve the members for a specific project. Optionally filter by user IDs (comma-separated). Parameters @@ -86,6 +92,12 @@ async def get( self, id: int, *, user_ids: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[LseUser]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve the members for a specific project. Optionally filter by user IDs (comma-separated). Parameters diff --git a/src/label_studio_sdk/projects/members/paginated/client.py b/src/label_studio_sdk/projects/members/paginated/client.py index a395ff750..26839b6e5 100644 --- a/src/label_studio_sdk/projects/members/paginated/client.py +++ b/src/label_studio_sdk/projects/members/paginated/client.py @@ -32,6 +32,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[PaginatedProjectMember]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve the members for a specific project. Parameters @@ -145,6 +151,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[PaginatedProjectMember]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve the members for a specific project. Parameters diff --git a/src/label_studio_sdk/projects/metrics/client.py b/src/label_studio_sdk/projects/metrics/client.py index fa39e9b00..c20d3a5d9 100644 --- a/src/label_studio_sdk/projects/metrics/client.py +++ b/src/label_studio_sdk/projects/metrics/client.py @@ -23,6 +23,12 @@ def __init__(self, *, client_wrapper: SyncClientWrapper): def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> MetricParam: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get the current metrics configuration for a project. Parameters @@ -78,6 +84,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> MetricParam: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update metrics strategy and parameters for a project. Parameters @@ -148,6 +160,12 @@ def __init__(self, *, client_wrapper: AsyncClientWrapper): async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> MetricParam: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get the current metrics configuration for a project. Parameters @@ -211,6 +229,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> MetricParam: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update metrics strategy and parameters for a project. Parameters diff --git a/src/label_studio_sdk/projects/pauses/client.py b/src/label_studio_sdk/projects/pauses/client.py index f390ea67f..92fb05bd2 100644 --- a/src/label_studio_sdk/projects/pauses/client.py +++ b/src/label_studio_sdk/projects/pauses/client.py @@ -29,6 +29,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[Pause]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a list of all pauses. Parameters @@ -96,6 +102,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> Pause: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new pause entry. Parameters @@ -165,6 +177,12 @@ def get( self, id: str, project_pk: int, user_pk: int, *, request_options: typing.Optional[RequestOptions] = None ) -> Pause: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific pause by ID. Parameters @@ -219,6 +237,12 @@ def delete( self, id: str, project_pk: int, user_pk: int, *, request_options: typing.Optional[RequestOptions] = None ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific pause by ID. Parameters @@ -273,6 +297,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> Pause: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Partially update a pause entry by ID. Parameters @@ -358,6 +388,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[Pause]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a list of all pauses. Parameters @@ -433,6 +469,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> Pause: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new pause entry. Parameters @@ -510,6 +552,12 @@ async def get( self, id: str, project_pk: int, user_pk: int, *, request_options: typing.Optional[RequestOptions] = None ) -> Pause: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific pause by ID. Parameters @@ -572,6 +620,12 @@ async def delete( self, id: str, project_pk: int, user_pk: int, *, request_options: typing.Optional[RequestOptions] = None ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a specific pause by ID. Parameters @@ -634,6 +688,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> Pause: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Partially update a pause entry by ID. Parameters diff --git a/src/label_studio_sdk/projects/stats/__init__.py b/src/label_studio_sdk/projects/stats/__init__.py index 0cb78a0d6..d9f08c12b 100644 --- a/src/label_studio_sdk/projects/stats/__init__.py +++ b/src/label_studio_sdk/projects/stats/__init__.py @@ -12,6 +12,9 @@ StatsIaaResponseStd, StatsLeadTimeResponse, StatsLeadTimeResponseLeadTimeStatsItem, + StatsModelVersionAnnotatorAgreementResponse, + StatsModelVersionGroundTruthAgreementResponse, + StatsModelVersionPredictionAgreementResponse, StatsTotalAgreementResponse, StatsTotalAgreementResponseOne, StatsTotalAgreementResponseZero, @@ -36,6 +39,9 @@ "StatsIaaResponseStd", "StatsLeadTimeResponse", "StatsLeadTimeResponseLeadTimeStatsItem", + "StatsModelVersionAnnotatorAgreementResponse", + "StatsModelVersionGroundTruthAgreementResponse", + "StatsModelVersionPredictionAgreementResponse", "StatsTotalAgreementResponse", "StatsTotalAgreementResponseOne", "StatsTotalAgreementResponseZero", diff --git a/src/label_studio_sdk/projects/stats/client.py b/src/label_studio_sdk/projects/stats/client.py index 508cc75ea..b2cf17a2b 100644 --- a/src/label_studio_sdk/projects/stats/client.py +++ b/src/label_studio_sdk/projects/stats/client.py @@ -3,11 +3,14 @@ from ...core.client_wrapper import SyncClientWrapper import typing from ...core.request_options import RequestOptions -from .types.stats_iaa_response import StatsIaaResponse +from .types.stats_model_version_annotator_agreement_response import StatsModelVersionAnnotatorAgreementResponse from ...core.jsonable_encoder import jsonable_encoder from ...core.unchecked_base_model import construct_type from json.decoder import JSONDecodeError from ...core.api_error import ApiError +from .types.stats_model_version_ground_truth_agreement_response import StatsModelVersionGroundTruthAgreementResponse +from .types.stats_model_version_prediction_agreement_response import StatsModelVersionPredictionAgreementResponse +from .types.stats_iaa_response import StatsIaaResponse from .types.stats_agreement_annotator_response import StatsAgreementAnnotatorResponse from .types.stats_data_filters_response import StatsDataFiltersResponse from .types.stats_finished_tasks_response import StatsFinishedTasksResponse @@ -23,6 +26,199 @@ class StatsClient: 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 + ) -> StatsModelVersionAnnotatorAgreementResponse: + """ + + Label Studio Enterprise badge +

+ 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 + ------- + StatsModelVersionAnnotatorAgreementResponse + Model-version overall agreement vs annotators + + Examples + -------- + from label_studio_sdk import LabelStudio + + client = LabelStudio( + api_key="YOUR_API_KEY", + ) + client.projects.stats.model_version_annotator_agreement( + id=1, + model_version="model_version", + ) + """ + _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: + return typing.cast( + StatsModelVersionAnnotatorAgreementResponse, + construct_type( + type_=StatsModelVersionAnnotatorAgreementResponse, # type: ignore + object_=_response.json(), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, 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, + ) -> StatsModelVersionGroundTruthAgreementResponse: + """ + + Label Studio Enterprise badge +

+ 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 + ------- + StatsModelVersionGroundTruthAgreementResponse + Model-version ground truth agreement + + Examples + -------- + from label_studio_sdk import LabelStudio + + client = LabelStudio( + api_key="YOUR_API_KEY", + ) + client.projects.stats.model_version_ground_truth_agreement( + id=1, + model_version="model_version", + ) + """ + _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: + return typing.cast( + StatsModelVersionGroundTruthAgreementResponse, + construct_type( + type_=StatsModelVersionGroundTruthAgreementResponse, # type: ignore + object_=_response.json(), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, 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, + ) -> StatsModelVersionPredictionAgreementResponse: + """ + + Label Studio Enterprise badge +

+ 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 + ------- + StatsModelVersionPredictionAgreementResponse + Model-version prediction agreement + + Examples + -------- + from label_studio_sdk import LabelStudio + + client = LabelStudio( + api_key="YOUR_API_KEY", + ) + client.projects.stats.model_version_prediction_agreement( + id=1, + model_version="model_version", + ) + """ + _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: + return typing.cast( + StatsModelVersionPredictionAgreementResponse, + construct_type( + type_=StatsModelVersionPredictionAgreementResponse, # type: ignore + object_=_response.json(), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + def iaa( self, id: int, @@ -34,6 +230,12 @@ def iaa( request_options: typing.Optional[RequestOptions] = None, ) -> StatsIaaResponse: """ + + Label Studio Enterprise badge +

+ 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 @@ -100,6 +302,12 @@ def agreement_annotator( self, id: int, user_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> StatsAgreementAnnotatorResponse: """ + + Label Studio Enterprise badge +

+ 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 @@ -303,6 +511,12 @@ def total_agreement( request_options: typing.Optional[RequestOptions] = None, ) -> StatsTotalAgreementResponse: """ + + Label Studio Enterprise badge +

+ 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. @@ -422,6 +636,12 @@ def user_prediction_agreement( request_options: typing.Optional[RequestOptions] = None, ) -> StatsUserPredictionAgreementResponse: """ + + Label Studio Enterprise badge +

+ 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 @@ -484,6 +704,12 @@ def user_review_score( request_options: typing.Optional[RequestOptions] = None, ) -> StatsUserReviewScoreResponse: """ + + Label Studio Enterprise badge +

+ 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. Parameters @@ -546,6 +772,12 @@ def user_ground_truth_agreement( request_options: typing.Optional[RequestOptions] = None, ) -> StatsUserGroundTruthAgreementResponse: """ + + Label Studio Enterprise badge +

+ 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 @@ -604,6 +836,223 @@ class AsyncStatsClient: 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 + ) -> StatsModelVersionAnnotatorAgreementResponse: + """ + + Label Studio Enterprise badge +

+ 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 + ------- + StatsModelVersionAnnotatorAgreementResponse + Model-version overall agreement vs annotators + + Examples + -------- + import asyncio + + from label_studio_sdk import AsyncLabelStudio + + client = AsyncLabelStudio( + api_key="YOUR_API_KEY", + ) + + + async def main() -> None: + await client.projects.stats.model_version_annotator_agreement( + id=1, + model_version="model_version", + ) + + + asyncio.run(main()) + """ + _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: + return typing.cast( + StatsModelVersionAnnotatorAgreementResponse, + construct_type( + type_=StatsModelVersionAnnotatorAgreementResponse, # type: ignore + object_=_response.json(), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, 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, + ) -> StatsModelVersionGroundTruthAgreementResponse: + """ + + Label Studio Enterprise badge +

+ 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 + ------- + StatsModelVersionGroundTruthAgreementResponse + Model-version ground truth agreement + + Examples + -------- + import asyncio + + from label_studio_sdk import AsyncLabelStudio + + client = AsyncLabelStudio( + api_key="YOUR_API_KEY", + ) + + + async def main() -> None: + await client.projects.stats.model_version_ground_truth_agreement( + id=1, + model_version="model_version", + ) + + + asyncio.run(main()) + """ + _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: + return typing.cast( + StatsModelVersionGroundTruthAgreementResponse, + construct_type( + type_=StatsModelVersionGroundTruthAgreementResponse, # type: ignore + object_=_response.json(), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, 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, + ) -> StatsModelVersionPredictionAgreementResponse: + """ + + Label Studio Enterprise badge +

+ 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 + ------- + StatsModelVersionPredictionAgreementResponse + Model-version prediction agreement + + Examples + -------- + import asyncio + + from label_studio_sdk import AsyncLabelStudio + + client = AsyncLabelStudio( + api_key="YOUR_API_KEY", + ) + + + async def main() -> None: + await client.projects.stats.model_version_prediction_agreement( + id=1, + model_version="model_version", + ) + + + asyncio.run(main()) + """ + _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: + return typing.cast( + StatsModelVersionPredictionAgreementResponse, + construct_type( + type_=StatsModelVersionPredictionAgreementResponse, # type: ignore + object_=_response.json(), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, body=_response.text) + raise ApiError(status_code=_response.status_code, body=_response_json) + async def iaa( self, id: int, @@ -615,6 +1064,12 @@ async def iaa( request_options: typing.Optional[RequestOptions] = None, ) -> StatsIaaResponse: """ + + Label Studio Enterprise badge +

+ 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 @@ -689,6 +1144,12 @@ async def agreement_annotator( self, id: int, user_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> StatsAgreementAnnotatorResponse: """ + + Label Studio Enterprise badge +

+ 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 @@ -926,6 +1387,12 @@ async def total_agreement( request_options: typing.Optional[RequestOptions] = None, ) -> StatsTotalAgreementResponse: """ + + Label Studio Enterprise badge +

+ 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. @@ -1061,6 +1528,12 @@ async def user_prediction_agreement( request_options: typing.Optional[RequestOptions] = None, ) -> StatsUserPredictionAgreementResponse: """ + + Label Studio Enterprise badge +

+ 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 @@ -1131,6 +1604,12 @@ async def user_review_score( request_options: typing.Optional[RequestOptions] = None, ) -> StatsUserReviewScoreResponse: """ + + Label Studio Enterprise badge +

+ 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. Parameters @@ -1201,6 +1680,12 @@ async def user_ground_truth_agreement( request_options: typing.Optional[RequestOptions] = None, ) -> StatsUserGroundTruthAgreementResponse: """ + + Label Studio Enterprise badge +

+ 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 diff --git a/src/label_studio_sdk/projects/stats/types/__init__.py b/src/label_studio_sdk/projects/stats/types/__init__.py index 85fe87687..7da9cb7fc 100644 --- a/src/label_studio_sdk/projects/stats/types/__init__.py +++ b/src/label_studio_sdk/projects/stats/types/__init__.py @@ -11,6 +11,9 @@ from .stats_iaa_response_std import StatsIaaResponseStd from .stats_lead_time_response import StatsLeadTimeResponse from .stats_lead_time_response_lead_time_stats_item import StatsLeadTimeResponseLeadTimeStatsItem +from .stats_model_version_annotator_agreement_response import StatsModelVersionAnnotatorAgreementResponse +from .stats_model_version_ground_truth_agreement_response import StatsModelVersionGroundTruthAgreementResponse +from .stats_model_version_prediction_agreement_response import StatsModelVersionPredictionAgreementResponse from .stats_total_agreement_response import StatsTotalAgreementResponse from .stats_total_agreement_response_one import StatsTotalAgreementResponseOne from .stats_total_agreement_response_zero import StatsTotalAgreementResponseZero @@ -36,6 +39,9 @@ "StatsIaaResponseStd", "StatsLeadTimeResponse", "StatsLeadTimeResponseLeadTimeStatsItem", + "StatsModelVersionAnnotatorAgreementResponse", + "StatsModelVersionGroundTruthAgreementResponse", + "StatsModelVersionPredictionAgreementResponse", "StatsTotalAgreementResponse", "StatsTotalAgreementResponseOne", "StatsTotalAgreementResponseZero", diff --git a/src/label_studio_sdk/projects/stats/types/stats_model_version_annotator_agreement_response.py b/src/label_studio_sdk/projects/stats/types/stats_model_version_annotator_agreement_response.py new file mode 100644 index 000000000..5a45f78af --- /dev/null +++ b/src/label_studio_sdk/projects/stats/types/stats_model_version_annotator_agreement_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +from ....core.unchecked_base_model import UncheckedBaseModel +import typing +from ....core.pydantic_utilities import IS_PYDANTIC_V2 +import pydantic + + +class StatsModelVersionAnnotatorAgreementResponse(UncheckedBaseModel): + agreement: typing.Optional[float] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/label_studio_sdk/projects/stats/types/stats_model_version_ground_truth_agreement_response.py b/src/label_studio_sdk/projects/stats/types/stats_model_version_ground_truth_agreement_response.py new file mode 100644 index 000000000..ae057d26f --- /dev/null +++ b/src/label_studio_sdk/projects/stats/types/stats_model_version_ground_truth_agreement_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +from ....core.unchecked_base_model import UncheckedBaseModel +import typing +from ....core.pydantic_utilities import IS_PYDANTIC_V2 +import pydantic + + +class StatsModelVersionGroundTruthAgreementResponse(UncheckedBaseModel): + agreement: typing.Optional[float] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/label_studio_sdk/projects/stats/types/stats_model_version_prediction_agreement_response.py b/src/label_studio_sdk/projects/stats/types/stats_model_version_prediction_agreement_response.py new file mode 100644 index 000000000..835943204 --- /dev/null +++ b/src/label_studio_sdk/projects/stats/types/stats_model_version_prediction_agreement_response.py @@ -0,0 +1,19 @@ +# This file was auto-generated by Fern from our API Definition. + +from ....core.unchecked_base_model import UncheckedBaseModel +import typing +from ....core.pydantic_utilities import IS_PYDANTIC_V2 +import pydantic + + +class StatsModelVersionPredictionAgreementResponse(UncheckedBaseModel): + average_prediction_agreement_per_model: typing.Optional[float] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/label_studio_sdk/prompts/client.py b/src/label_studio_sdk/prompts/client.py index 6f1e15812..673b1300b 100644 --- a/src/label_studio_sdk/prompts/client.py +++ b/src/label_studio_sdk/prompts/client.py @@ -48,6 +48,12 @@ def batch_failed_predictions( request_options: typing.Optional[RequestOptions] = None, ) -> BatchFailedPredictions: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new batch of failed predictions. Parameters @@ -122,6 +128,12 @@ def batch_predictions( request_options: typing.Optional[RequestOptions] = None, ) -> BatchPredictions: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new batch prediction. Parameters @@ -200,6 +212,12 @@ def subset_tasks( request_options: typing.Optional[RequestOptions] = None, ) -> PaginatedProjectSubsetTasksResponseList: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Provides list of tasks, based on project subset. Includes predictions for tasks. For the 'HasGT' subset, accuracy metrics will also be provided. @@ -294,6 +312,12 @@ def subsets( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[ProjectSubsetItem]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Provides list of available subsets for a project along with count of tasks in each subset @@ -410,6 +434,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> ModelInterface: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new prompt. Parameters @@ -554,6 +584,12 @@ def compatible_projects( def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> ModelInterfaceSerializerGet: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific prompt. Parameters @@ -600,6 +636,12 @@ def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = Non def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a prompt by ID Parameters @@ -652,6 +694,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> ModelInterface: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific prompt by ID. Parameters @@ -749,6 +797,12 @@ async def batch_failed_predictions( request_options: typing.Optional[RequestOptions] = None, ) -> BatchFailedPredictions: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new batch of failed predictions. Parameters @@ -831,6 +885,12 @@ async def batch_predictions( request_options: typing.Optional[RequestOptions] = None, ) -> BatchPredictions: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new batch prediction. Parameters @@ -917,6 +977,12 @@ async def subset_tasks( request_options: typing.Optional[RequestOptions] = None, ) -> PaginatedProjectSubsetTasksResponseList: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Provides list of tasks, based on project subset. Includes predictions for tasks. For the 'HasGT' subset, accuracy metrics will also be provided. @@ -1019,6 +1085,12 @@ async def subsets( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[ProjectSubsetItem]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Provides list of available subsets for a project along with count of tasks in each subset @@ -1151,6 +1223,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> ModelInterface: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new prompt. Parameters @@ -1313,6 +1391,12 @@ async def get( self, id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> ModelInterfaceSerializerGet: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific prompt. Parameters @@ -1367,6 +1451,12 @@ async def main() -> None: async def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a prompt by ID Parameters @@ -1427,6 +1517,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> ModelInterface: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific prompt by ID. Parameters diff --git a/src/label_studio_sdk/prompts/indicators/client.py b/src/label_studio_sdk/prompts/indicators/client.py index cefed90ae..a90a7444c 100644 --- a/src/label_studio_sdk/prompts/indicators/client.py +++ b/src/label_studio_sdk/prompts/indicators/client.py @@ -20,6 +20,12 @@ def list( self, id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[IndicatorsListResponseItem]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get key indicators for the Prompt dashboard. Parameters @@ -68,6 +74,12 @@ def get( self, id: int, indicator_key: str, *, request_options: typing.Optional[RequestOptions] = None ) -> LseKeyIndicatorValue: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific key indicator for the Prompt dashboard. Parameters @@ -124,6 +136,12 @@ async def list( self, id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> typing.List[IndicatorsListResponseItem]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get key indicators for the Prompt dashboard. Parameters @@ -180,6 +198,12 @@ async def get( self, id: int, indicator_key: str, *, request_options: typing.Optional[RequestOptions] = None ) -> LseKeyIndicatorValue: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get a specific key indicator for the Prompt dashboard. Parameters diff --git a/src/label_studio_sdk/prompts/runs/client.py b/src/label_studio_sdk/prompts/runs/client.py index 22d795000..dd732f348 100644 --- a/src/label_studio_sdk/prompts/runs/client.py +++ b/src/label_studio_sdk/prompts/runs/client.py @@ -34,6 +34,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[ModelRun]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get information (status, metadata, etc) about an existing inference run Parameters @@ -115,6 +121,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> ModelRun: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Run a prompt inference. Parameters @@ -203,6 +215,12 @@ def cancel( request_options: typing.Optional[RequestOptions] = None, ) -> CancelModelRunResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Cancel the inference run for the given api Parameters @@ -270,6 +288,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[ModelRun]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get information (status, metadata, etc) about an existing inference run Parameters @@ -359,6 +383,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> ModelRun: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Run a prompt inference. Parameters @@ -455,6 +485,12 @@ async def cancel( request_options: typing.Optional[RequestOptions] = None, ) -> CancelModelRunResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Cancel the inference run for the given api Parameters diff --git a/src/label_studio_sdk/prompts/versions/client.py b/src/label_studio_sdk/prompts/versions/client.py index 0185ec11a..73158f984 100644 --- a/src/label_studio_sdk/prompts/versions/client.py +++ b/src/label_studio_sdk/prompts/versions/client.py @@ -23,6 +23,12 @@ def __init__(self, *, client_wrapper: SyncClientWrapper): def get_default_version_name(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get default prompt version name Parameters @@ -68,6 +74,12 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[ThirdPartyModelVersion]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all versions of a prompt. Parameters @@ -132,6 +144,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> ThirdPartyModelVersion: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new version of a prompt. Parameters @@ -220,6 +238,12 @@ def get( self, prompt_id: int, version_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> ThirdPartyModelVersion: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific prompt of a model. Parameters @@ -271,6 +295,12 @@ def delete( self, prompt_id: int, version_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a prompt version by ID Parameters @@ -326,6 +356,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> ThirdPartyModelVersion: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific prompt version by ID. Parameters @@ -417,6 +453,12 @@ def cost_estimate( self, prompt_id: int, version_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> InferenceRunCostEstimate: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get an estimate of the cost for making an inference run on the selected Prompt Version and Project/ProjectSubset Parameters @@ -621,6 +663,12 @@ async def get_default_version_name( self, id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get default prompt version name Parameters @@ -674,6 +722,12 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[ThirdPartyModelVersion]: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ List all versions of a prompt. Parameters @@ -746,6 +800,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> ThirdPartyModelVersion: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Create a new version of a prompt. Parameters @@ -842,6 +902,12 @@ async def get( self, prompt_id: int, version_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> ThirdPartyModelVersion: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve a specific prompt of a model. Parameters @@ -901,6 +967,12 @@ async def delete( self, prompt_id: int, version_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> None: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Delete a prompt version by ID Parameters @@ -964,6 +1036,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> ThirdPartyModelVersion: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update a specific prompt version by ID. Parameters @@ -1063,6 +1141,12 @@ async def cost_estimate( self, prompt_id: int, version_id: int, *, request_options: typing.Optional[RequestOptions] = None ) -> InferenceRunCostEstimate: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get an estimate of the cost for making an inference run on the selected Prompt Version and Project/ProjectSubset Parameters diff --git a/src/label_studio_sdk/sso/saml/client.py b/src/label_studio_sdk/sso/saml/client.py index a3aed198b..18162b1d3 100644 --- a/src/label_studio_sdk/sso/saml/client.py +++ b/src/label_studio_sdk/sso/saml/client.py @@ -22,6 +22,12 @@ def __init__(self, *, client_wrapper: SyncClientWrapper): def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> SamlSettings: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve SAML2 settings for the currently active organization. Parameters @@ -71,6 +77,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> SamlSettingsUpdate: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update SAML2 settings for the currently active organization. Parameters @@ -145,6 +157,12 @@ def __init__(self, *, client_wrapper: AsyncClientWrapper): async def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> SamlSettings: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve SAML2 settings for the currently active organization. Parameters @@ -202,6 +220,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> SamlSettingsUpdate: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update SAML2 settings for the currently active organization. Parameters diff --git a/src/label_studio_sdk/sso/scim/client.py b/src/label_studio_sdk/sso/scim/client.py index 47c8c56cd..18d9ef24c 100644 --- a/src/label_studio_sdk/sso/scim/client.py +++ b/src/label_studio_sdk/sso/scim/client.py @@ -22,6 +22,12 @@ def __init__(self, *, client_wrapper: SyncClientWrapper): def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> ScimSettings: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve SCIM settings for the currently active organization. Parameters @@ -71,6 +77,12 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> ScimSettingsUpdate: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update SCIM settings for the currently active organization. Parameters @@ -145,6 +157,12 @@ def __init__(self, *, client_wrapper: AsyncClientWrapper): async def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> ScimSettings: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Retrieve SCIM settings for the currently active organization. Parameters @@ -202,6 +220,12 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> ScimSettingsUpdate: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update SCIM settings for the currently active organization. Parameters diff --git a/src/label_studio_sdk/users/client.py b/src/label_studio_sdk/users/client.py index fbd446a6f..dd4947ba4 100644 --- a/src/label_studio_sdk/users/client.py +++ b/src/label_studio_sdk/users/client.py @@ -26,6 +26,12 @@ def __init__(self, *, client_wrapper: SyncClientWrapper): def get_current_user(self, *, request_options: typing.Optional[RequestOptions] = None) -> LseUserApi: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get info about the currently authenticated user. Parameters @@ -84,6 +90,12 @@ def update_current_user( request_options: typing.Optional[RequestOptions] = None, ) -> LseUserApi: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update details for the currently authenticated user. Parameters @@ -739,6 +751,12 @@ def __init__(self, *, client_wrapper: AsyncClientWrapper): async def get_current_user(self, *, request_options: typing.Optional[RequestOptions] = None) -> LseUserApi: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get info about the currently authenticated user. Parameters @@ -805,6 +823,12 @@ async def update_current_user( request_options: typing.Optional[RequestOptions] = None, ) -> LseUserApi: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Update details for the currently authenticated user. Parameters diff --git a/src/label_studio_sdk/versions/client.py b/src/label_studio_sdk/versions/client.py index 198582b58..4574106c3 100644 --- a/src/label_studio_sdk/versions/client.py +++ b/src/label_studio_sdk/versions/client.py @@ -16,6 +16,12 @@ def __init__(self, *, client_wrapper: SyncClientWrapper): def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> VersionResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get version information about the Label Studio instance. Parameters @@ -63,6 +69,12 @@ def __init__(self, *, client_wrapper: AsyncClientWrapper): async def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> VersionResponse: """ + + Label Studio Enterprise badge +

+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) +

+ Get version information about the Label Studio instance. Parameters diff --git a/tests/projects/test_stats.py b/tests/projects/test_stats.py index 0a36d76af..cfac44c87 100644 --- a/tests/projects/test_stats.py +++ b/tests/projects/test_stats.py @@ -6,6 +6,42 @@ from ..utilities import validate_response +async def test_model_version_annotator_agreement(client: LabelStudio, async_client: AsyncLabelStudio) -> None: + expected_response: typing.Any = {"agreement": 1.1} + expected_types: typing.Any = {"agreement": None} + response = client.projects.stats.model_version_annotator_agreement(id=1, model_version="model_version") + validate_response(response, expected_response, expected_types) + + async_response = await async_client.projects.stats.model_version_annotator_agreement( + id=1, model_version="model_version" + ) + validate_response(async_response, expected_response, expected_types) + + +async def test_model_version_ground_truth_agreement(client: LabelStudio, async_client: AsyncLabelStudio) -> None: + expected_response: typing.Any = {"agreement": 1.1} + expected_types: typing.Any = {"agreement": None} + response = client.projects.stats.model_version_ground_truth_agreement(id=1, model_version="model_version") + validate_response(response, expected_response, expected_types) + + async_response = await async_client.projects.stats.model_version_ground_truth_agreement( + id=1, model_version="model_version" + ) + validate_response(async_response, expected_response, expected_types) + + +async def test_model_version_prediction_agreement(client: LabelStudio, async_client: AsyncLabelStudio) -> None: + expected_response: typing.Any = {"average_prediction_agreement_per_model": 1.1} + expected_types: typing.Any = {"average_prediction_agreement_per_model": None} + response = client.projects.stats.model_version_prediction_agreement(id=1, model_version="model_version") + validate_response(response, expected_response, expected_types) + + async_response = await async_client.projects.stats.model_version_prediction_agreement( + id=1, model_version="model_version" + ) + validate_response(async_response, expected_response, expected_types) + + async def test_iaa(client: LabelStudio, async_client: AsyncLabelStudio) -> None: expected_response: typing.Any = { "IAA": [[1, 0.5], [0.5, 1]],