Skip to content

2.1.0

Latest

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 200201
Prompts Structured response on get-default-version-name
PATCH project Response schema expanded (LseProjectUpdateLseProjectResponse)

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