Skip to content

Releases

2.1.4

Choose a tag to compare

@yyassi-heartex yyassi-heartex released this 05 Nov 16:32

What's Changed

Breaking Changes

Change Detail
client.users.update (and PATCH /api/users/{id} request type) username removed
S3 with IAM Role storage (client.import_storage.s3s.*, client.export_storage.s3s.*) create/update/validate external_id removed

Features

Endpoint(s) / surface Change
Projects (LseProject, LseProjectResponse, AllRolesProjectList) New state_source, state_marked_done_at, state_marked_done_by: Managers+ can mark a project as Done

Bug Fixes

  • Interface CLI: interface preview Save no longer fails with "Label Studio authentication failed" after the preview has been open for 5+ minutes.
  • Auth: LABEL_STUDIO_API_KEY now accepts a JWT access token as well as a JWT refresh token ("PAT")

Other Changes

  • Docstring cleanups after feature-flag removals (annotation history lazy load, FSM state fields)
  • ci: bump release-drafter/release-drafter from 7.2.1 to 7.10.0 (#832)
  • ci: bump thehanimo/pr-title-checker from 1.4.3 to 2.0.0 (#831)

Full Changelog: 2.1.3...2.1.4

2.1.3

Choose a tag to compare

@matt-bernstein matt-bernstein released this 29 Oct 12:54

What's Changed

Breaking Changes

Change Detail
Python Requires 3.11+ (3.10 dropped)
client.interfaces.duplicate No longer accepts code or required compiled/title (+ artifacts/schemas/…).

Features

Endpoint(s) / surface Change
POST /api/interfaces/{id}/move/ New
GET /api/projects/{id}/imports/, reimports client.tasks.create_many_status -> client.projects.imports.get; New client.projects.imports.list, reimports.list / get
GET /api/analytics/kpis/... segment_by_user, segment_by_project
Org / project / workspace member bulk Select-all filters: filters, search, tags, activity bounds (parity with member tables)
GET .../members/paginated/ tags_operator (Any / All / None of tags)
Organization invite expired, expires_at; update token_expires_at
PATCH /api/organizations/{id} allow_unsafe_instruction_tags
Workspaces interfaces_count
Permission options requires, excluded_by
Converter to_appen_report(...)
Interface CLI Local preview cache

Request fields removed

Endpoint(s) Fields removed
Project templates create/update created_by, organization
Prompt versions / third-party model version organization

Bug Fixes

  • Import status path docs: project id vs import pk on tasks.create_many_status
  • Prompt version org scoping
  • Invite link expiry
  • Member tags Any/All/None via tags_operator

Other Changes

  • Drop Python 3.10; security dependency bumps
  • Sample region generation no longer depends on jsf

Full Changelog: 2.1.2...2.1.3

2.1.2

Choose a tag to compare

@nikitabelonogov nikitabelonogov released this 25 Sep 12:55

What's Changed

Other Changes

  • docs: Add in-flight project migration runbook and supporting scripts by @smohan123 in #823

New Contributors

Full Changelog: 2.1.1...2.1.2

2.1.1

Choose a tag to compare

@matt-bernstein matt-bernstein released this 10 Aug 15:47

What's Changed

Features

Endpoint(s) Change
/api/dm/views/:id/ is_locked, locked_at, locked_by: user who locked this view
/api/dm/views/:id/ [*].filter_group.filters[*].child_filters: multiple child_filters for annotation and prediction results
/api/projects/:id/members/export/ export project members as CSV
/api/users etc. organization_membership: support Flex users
/api/users etc. organization_membership.role: support View-Only users
/api/projects/:id annotator_evaluation_metric: GT agreement, acceptance score, or rejection rate
/api/projects/:id review_settings.annotator_batch_percent
/api/projects/:id review_settings.sampling: by_annotator
/api/projects/:id permissions: project level permissions
/api/analytics/kpis publish APIs used for Analytics and Project Dashboards
/api/current-user/hotkeys project: per-project hotkeys

Bug Fixes

Many undocumented fields due to schema drift are now documented.

Requests

Endpoint(s) Fields Added Fields Removed Fields Now Required
POST/PATCH /api/storages/*[/validate] recursive_scan, synchronizable last_sync, last_sync_count, last_sync_job, meta, status, traceback (read-only) project
POST/PATCH /api/tasks/{id}/annotations[/{id}] bulk_created, draft_created_at, import_id, last_action, last_created_by, parent_annotation, parent_prediction, unique_id
POST /api/tasks/{id}/annotations/bulk discriminated oneOf (all=false+included vs all=true+excluded)
POST/PATCH /api/tasks/{id}/predictions[/{id}] cluster, mislabeling, model, model_run, neighbors, project result, task (POST)
POST /api/ml auto_update, model_version project, url
PATCH /api/ml/{id} auto_update, model_version
POST /api/dm/actions filters, ordering, selectedItems (schemas)
POST/PATCH /api/dm/actions[/{id}] data (schema)
POST /api/projects/{id}/tasks/assignees filters, selectedItems (schemas)
PATCH /api/projects/{id}/tasks/{task_pk}/assignees type, users (unrequired)
POST /api/users active_organization, custom_hotkeys, date_joined, password avatar, id, initials username
PATCH /api/users/{id}/ active_organization, custom_hotkeys, date_joined, email_notification_settings, is_email_verified, onboarding_state, password avatar, email, id, initials
POST /api/project-templates/{id}/create-project workspace_id (unrequired)

Responses

Endpoints(s) Change
GET/POST /api/prompts/{prompt_id}/versions/{version_id}/inference-runs + model_version
  • various nullable type fixes (eg string -> string | None)
  • CSV export: Preserve CSV columns when task data keys collide with control tag names

Full Changelog: release/2.1.0...release/2.1.1

2.1.0

Choose a tag to compare

@github-actions github-actions released this 15 Jul 18:00

What's changed

Features

Several optional query parameter additions and new/changed fields.

New query parameters

Endpoint New params
GET /api/ml/ is_interactive
GET /api/organizations/{id}/memberships is_deleted, user__last_activity__gte/lte, user_type
GET /api/predictions/ task_project
GET /api/projects/, GET /api/projects/counts/ source_interface_id
GET /api/projects/{id}/annotation-history/ created_at_from, created_at_to
GET /api/projects/{id}/members/paginated/ user_type
GET /prompts/compatible-projects archived, ids, source_interface_id, state, title, workspaces

New/changed fields

Area Change
Projects internal_description on create/update/get (UTC-1032)
Project roles role_source on POST /api/projects/roles/ (FIT-1779)
Dimensions is_categorical, values_enum on dimension GET
Data Manager views is_locked, locked_at, locked_by (UTC-949)
FSM backfill Documented 400 { error } on trigger/cancel
JWT tokens detail field on rotate/blacklist errors
Invite reset Success 200 → 201
Prompts Structured response on get-default-version-name
PATCH project Response schema expanded (LseProjectUpdate → LseProjectResponse)

Bug Fixes

The theme of this release is typing! Many fields across the SDK which were "stringly typed" now have proper types.

Field Now Endpoints
active_organization_meta object GET/PATCH /api/current-user, GET /api/current-user/whoami, GET/PATCH/POST /api/users/
pause object GET /api/current-user/whoami, GET/PATCH/POST /api/users/
email_notification_settings object GET/PATCH /api/organizations/{id}
react_code_settings object GET/PATCH /api/organizations/{id}
custom_scripts_enabled boolean GET/PATCH /api/organizations/{id}
concurrency object PATCH /api/organizations/{id}/memberships
members object GET /api/projects/{id}/, POST /api/project-templates/{id}/create-project
prompts object GET/PATCH /api/projects/{id}/, POST /api/project-templates/{id}/create-project
is_dimensions_enabled boolean GET /api/projects/{id}/, POST /api/project-templates/{id}/create-project
workspace integer GET /api/projects/{id}/, POST /api/project-templates/{id}/create-project
queue_done / queue_left / queue_total / reviewer_queue_total integer POST /api/project-templates/{id}/create-project
agreement_threshold integer GET/POST /api/projects/{id}/metricparam/
allowed boolean GET/POST /api/projects/{id}/metricparam/
allowed_metrics_with_params object GET /api/projects/{project_pk}/dimensions/{id}/
model_params object GET/PATCH /api/model-provider-connections/{id}/, POST /api/model-provider-connections/
score number GET/PATCH /api/prompts/{prompt_id}/versions/{version_id}, POST /api/prompts/{prompt_id}/versions
created_by_user object GET/PATCH/POST /api/workspaces/
membership object GET/PATCH/POST /api/workspaces/
triggered_by object GET /api/dimensions/backfill/status/
annotations object (array) POST /api/tasks/
agreement / agreement_selected number POST /api/tasks/
  • All Enum types now have proper names; eg Role9e7Enum -> OrganizationRoleEnum

  • All id path params are now properly typed as integer

  • The following endpoints have richer, expanded response schemas

    • GET /api/prompts/{id}/get-default-version-name
    • PATCH /api/projects/{id}/
    • POST /api/fsm/backfill/, DELETE /api/fsm/backfill/
    • POST /api/token/rotate/
    • POST /api/token/blacklist/
    • POST /api/invite/reset-token

Other changes

  • Endpoint path changed from /api/organizations/{id}/permissions/{permission} -> /api/organizations/{id}/permissions/{permission_key}

  • POST /api/invite/reset-token response changed from 200 -> 201

Full Changelog: release/2.0.23...release/2.1.0

2.0.23

Choose a tag to compare

@github-actions github-actions released this 26 May 16:04

Full Changelog: 2.0.22...2.0.23

2.0.22

Choose a tag to compare

@github-actions github-actions released this 12 May 10:29

What's Changed

Other Changes

  • feat: Add interface CLI by @deppp in #809
  • feat: Add interface pull and draft sync support by @deppp in #811

Full Changelog: 2.0.21...2.0.22

2.0.21

Choose a tag to compare

@github-actions github-actions released this 04 May 20:59

What's Changed

Other Changes

  • ci: bump release-drafter/release-drafter from 7.1.1 to 7.2.1 by @dependabot[bot] in #808
  • ci: bump slackapi/slack-github-action from 3.0.1 to 3.0.2 by @dependabot[bot] in #807
  • ci: bump actions/github-script from 8 to 9 by @dependabot[bot] in #806

Full Changelog: 2.0.20...2.0.21

2.0.20

Choose a tag to compare

@github-actions github-actions released this 13 Apr 20:04
f7331f1

What's Changed

Features

Label Studio SDK CLI

Bug Fixes

Other Changes

Full Changelog: 2.0.19...2.0.20

What's Changed

Features

Bug Fixes

Other Changes

Full Changelog: 2.0.19...2.0.20

2.0.19

Choose a tag to compare

@matt-bernstein matt-bernstein released this 03 Mar 20:21
a61807b

What's Changed

Enable Finite State Management endpoints for Label Studio Enterprise.

Other Changes

Full Changelog: 2.0.18...2.0.19

What's Changed

Other Changes

Full Changelog: 2.0.18...2.0.19