Subscribe to release notesStatus pageCommunity
Developer guides

What's new

See the latest version updates of the Labelbox SDK

Version 6.3.0 (2024-12-12)

Added

  • Group member upload
  • Group member export

Note

  • For security reasons, the Invite class doesn't contain actual invite id (uid) any more. This change affects all versions.

Version 6.2.0 (2024-11-26)

Added

  • Multimodal chat evaluation ontology support for two new tools:
  • Added the following new import methods that replace the deprecated BulkImportRequest class:
    • project.get_mal_prediction_imports() to retrieve the list of MAL import jobs.
    • project.get_label_imports() to to retrieve the list of ground-truth import jobs.
    • MALPredictionImport.delete() to delete a MAL import.
  • Deprecation warning to wait_until_done methods
  • Deprecation warning to get_data_row_ids

Fixed

  • Fixed relationship label bug
  • Fixed the Import lb-client exceptions for labelbox
  • Fixed get_roles return type to Dict[str, Role] (instead of List[Role])
  • Adjusted deprecation message to a new standard
  • Improved support for Client.enable_experimental

Version 6.1.0 (2024-11-12)

Added

Fixed

  • Use valid lbox.exception in client IAMIntegration validation
  • Improve SDK method name detection for Datadog dashboard
  • Limit labeling front-end visibility and mentions of a custom editor
  • Remove all unused python imports
  • Remove bulk import requests

Version 6.0.1 (2024-10-30)

Fixed

  • Updated labelbox.exceptions to lbox.exceptions for IAM Integration check

Version 6.0.0 (2024-10-15)

Added

  • Added deprecation messages to all export_v2 methods
  • Added logic to extract SDK methods to pass to Datadog dashboard
  • Added the lbox.request_client Graphql client as a separate component

Updated

  • Updated the minimum requirement of numpy version from 1.24 to 1.25 and cleaned up _TypedArray validations
  • Refactored client create_project inputs to be named parameters instead of **kwargs
  • Updated pydantic v2 deprecation warnings
  • Removed experimental from UserGroup
  • Improved labeling service error reporting
  • Switched to ruff linter

Fixed

  • Labeling dashboard serialization
  • Handling of global key in ModelEvaluationTemplate

Removed

  • Discontinued the support for Python 3.8
  • Removed various deprecated classes, methods and attributes, including:
    • QueueMode for project
    • LabelGenerator assign_feature_schema_ids
    • Label assign_feature_schema_ids
    • AttachmentType attachment_type.TEXT
    • DataRowMetadata bulk_delete deletes parameter - support for string for data row ids or global keys, use UniqueId or GlobalKey class instead
    • Dataset create_data_rows_sync. Use create_data_rows instead
    • Slice get_data_row_ids. Use get_data_row_identifiers instead
    • LabelingParameterOverrideInput remove instance of DataRow as a type of input
    • Project _update_queue_mode and get_queue_mode
    • Project.setup and Project.setup_editor. Use project.connect_ontology instead
  • Removed deprecated get stream - related classes from ExportTask
    • JsonConverter, JsonConverterOutput, FileConverter, FileConverterOutput
  • Removed label Data classes as Label data attribute. Use GenericDataRowData instead

    📘

    MaskData is NOT removed

  • Removed NDJsonConverter deserialize
  • Removed the COCO package and BulkImportRequest package, including:
    • BulkImportRequest
    • BulkImportRequestState
    • project.upload_annotations
    • project.bulk_import_requests

Version 5.2.1 (2024-10-09)

Fixed

  • Exporter encoding

Version 5.2.0 (2024-10-09)

Added

  • Support data row / batch for live mmc projects(#1856)

Version 5.1.0 (2024-09-27)

Added

  • Support self-signed SSL certs(#1811)
  • Rectangle units now correctly support percent inputs(#1848)

Version 5.0.0 (2024-09-17)

Updated

  • Set tasks_remaining_countattribute of labeling service dashboard to None if labeling has not started.
  • Improve error messaging when creating LLM project with invalid dataset id parameter.

Removed

  • BREAKING CHANGE: Export v1 SDK methods are all removed. Use the latest export methods instead.
  • BREAKING CHANGE: Unused labelbox_v1 serialization package is removed.

Fixed

  • Fixed CUID dependencies that cause a crash if numpy is not installed.

Version 4.0.0 (2024-09-10)

Added

  • BREAKING CHANGE for Pydantic v1 users: Labelbox Python SDK now uses Pydantic v2.
  • Added automation test support for multiple SDK versions.

Fixed

  • Fixed flaky tests.

Version 3.78.1 (2024-09-10)

Fixed

  • Fixed labeling dashboard query for tags.

Version 3.78.0 (2024-09-03)

Added

Version 3.77.1 (2024-08-28)

Fixed

  • Restored client.headers.

Version 3.77.0 (2024-08-09)

Added

  • Added labeling_service.request(), which validates all project requirements and requests a labeling service. See Labeling Workforce.
  • Added the is_benchmark_reference flag that supports importing ground truth labels as benchmarks. See import annotations guides for example payloads.

Updated

  • get_labeling_service() now automatically requests labeling service if none has been used on a project. See Labeling Workforce.

Removed

  • BREAKING CHANGE: Removed Project.labeling_frontend.disconnect(). Now you can only have one default labeling front end per project and can't disconnect it.
  • BREAKING CHANGE: Removed the experimental method project.request_labeling_service(). See Labeling Workforce for the latest approach.

Version 3.76.0 (2024-07-29)

Added

  • Added experimental methods Project.get_labeling_service(), request_labeling_service() and get_labeling_service_status() that support requesting and checking the status of labeling service. See Labeling Workforce.
  • Added Client.create_prompt_response_generation_project() and create_response_creation_project() methods that support project and ontology creation for prompt response projects. See Import prompt and response annotations and Prompt and response projects to learn how to use these methods to set up prompt and response projects.
  • Added is_benchmark_enabled and is_consensus_enabled flags that specify whether a project supports benchmarks and consensus .

Updated

  • Made Project quality modes a list to allow combining more than 1 quality mode per project.

Notebooks

  • Added back the python notebook on migrating from Export V1 to the latest export().
  • Added correct data param to the video notebooks.

Other

  • Use connection pool for all http and graphql requests

Version 3.75.1 (2024-07-16)

Removed

  • Project media_type no longer supports JSON

Version 3.75.0 (2024-07-10)

Added

  • Added project.set_project_model_setup_complete() method
  • Added user group management methods.
  • Refactored dataset.create_data_rows_sync to upsert
  • Added upload_type to Project
  • Added prompt classification for python object
  • Alias wait_xxx functions

Fixed

  • Predictions missing during Catalog slice Export
  • Prevented adding batches to live chat evaluation projects
  • Added missing media types
  • Deprecate project.setup_editor in favor of project.connect_ontology
  • Bumped dateutil max version
  • Bumped version rye
  • Updated create ontology for project setup

Version 3.74.0 (2024-06-24)

Added

  • Include predictions in export
  • Adds upsert label feedback method client upsert_label_feedback()

Removed

  • Removed deprecated class LabelList

Version 3.73.0 (2024-06-20)

Added

  • Conversational data row checks
  • UI ontology mode support
  • Empty data row validation

Fixed

  • Numpy semver locked to < 2.0.0

Version 3.72.2 (2024-06-10)

Added

  • SLSA provenance generation

Version 3.72.1 (2024-06-06)

Fixed

  • Fix client.get_project() for LLM projects
  • Throw user-friendly errors when creating a custom embedding

Version 3.72.0 (2024-06-04)

Added

  • Update Dataset create_data_rows to allow upload of unlimited number of data rows
  • New Dataset methods for iam_integraton: add_iam_integration, remove_iam_integration

Notebooks

  • Added model evaluation SDK method notebook
  • Added quick start notebook geared towards new users

Version 3.71.0 (2024-05-28)

Added

  • project.get_overview() to be able to retrieve project details
  • project.clone() to be able to clone projects
  • Support for Rye 0.34
  • Requirements.lock, Requirements-dev.lock to latest depdenencies
  • ExportTask.get_buffered_stream to replace ExportTask.get_stream

Fixed

  • ExportTask.result / ExportTask.errors parsing content incorrectly
  • Lack of exceptions related to updating model config

Version 3.70.0 (2024-05-20)

Added

  • Added chat model evaluation support:
    • client.create_model_config()
    • project.project_model_configs()
    • project.add_model_config()
    • project.delete_project_model_config()
    • ProjectModelConfig.delete()
    • client.create_model_evaluation_project()
  • Update existing methods to support chat model evaluation project
    • client.create_ontology()
    • client.create_ontology_from_feature_schemas()
  • Coco deprecation message

Fixed

  • Fixed error reporting for client.create_project()
  • Do not retry http 422 errors

Notebooks

  • Send_to_annotate_from_catalog functionalities outside Foundry

Fixed in Notebooks

  • Fixed meta notebook
  • Modified queue_management.ipynb to remove some parameters
  • Update_huggingface.ipynb
  • Corrected_HF.ipynb

Version 3.69.1 (2024-05-01)

Fixed

  • Fixed a bug with certain types of content not being returned as a result of ExportTask.result or ExportTask.errors

Version 3.69.0 (2024-04-25)

Added

  • Support to export embeddings from the SDK

Fixed

  • Used OpenCV's headless library in replacement of OpenCV's default library

Version 3.68.0 (2024-04-16)

Added

  • Added support for embeddings.
  • Introduced the use of 'rye' as a package manager for SDK contributors.
  • Implemented a unified 'create' method for AnnotationImport, MEAPredictionImport, and MALPredictionImport.
  • Enhanced annotation upload functionality to accept data row IDs, global keys, or external IDs directly for labelbox.data.annotation_types.label

Fixed

  • Ensure items in dataset.upsert_data_rows are not empty
  • Streamable export fix to report export_v2 errors as list of dictionaries, compatible with older releases

Version 3.67.0 (2024-04-05)

Added

  • Added SECURITY.md file
  • Made export_v2 methods use streamable backend
  • Added support for custom embeddings to dataset create data row(s) methods
  • Added ability to upsert data rows via dataset.upsert_data_rows() method
  • Added AssetAttachment with an ability to update() and delete()

Updated

  • Added check for 5000 labels per annotation per data row

Fixed

  • Errors and Failed data rows are included in the task.result for dataset.create_data_rows()
  • Fixed 500 error handling and reporting

Notebooks

  • Updated import notebook for image data
  • Added attachment PDF example, removed requirements around text_layer_url
  • Included the get_catalog() method to the export notebook
  • Added workflow status filter to export_data notebook for projects
  • Send predictions to a project demo
  • Removed model diagnostic notebooks

Version 3.66.0 (2024-03-20)

Notes

Added

  • Added support for Python 3.11, 3.12
  • Added update method to attachments

Notebooks

  • Improved notebooks for integration and model diagnostics
  • Removed databricks integrations notebooks

Updated

  • Updated README for clarity and contribution guidelines

Removed

  • Removed support Python 3.7 as it has been end of life since June 2023

Version 3.65.0 (2024-03-05)

Notes

  • Rerelease of 3.64.0

Version 3.64.0 (2024-02-29)

Added

  • Client.get_catalog Add catalog schema class. Catalog exports can now be made without creating a slice first
  • last_activity_at filter added to export_v2, allowing users to specify a datetime window without a slice

Removed

  • Review related WebhookDataSource topics

Notebooks

  • Added get_catalog notebook
  • Update custom metrics notebook
  • Update notebooks for video and image annotation import

Version 3.63.0 (2024-02-19)

Added

  • Ability for users to install and use sdk with pydantic v.2. while still maintaining support for pydantic v1.
  • ModelRun export() and export_v2() add model_run_details to support splits

Notebooks

  • Add composite mask notebook

Version 3.62.0 (2024-02-12)

Added

  • Support custom metrics for predictions (all applicable annotation classes)
  • FoundryClient.run_app Add data_row identifier validation for running foundry app
  • Client.get_error_status_code Default to 500 error if a server error is unparseable instead of throwing an exception

Updated

  • DataRowMetadata, DataRowMetadataBatchResponse, _UpsertBatchDataRowMetadata Make data_row_id and global_key optional in all schema types

Fixed

  • ExportTask.__str__ Fix returned type in ExportTask instance representation

Removed

  • Project.upsert_review_queue

Notebooks

  • Update notebooks to new export methods
  • Add model slice notebook
  • Added support for annotation import with img bytes
  • Update user prompts for huggingface colab

Version 3.61.2 (2024-01-29)

Added

  • ModelSlice.get_data_row_identifiers for Foundry data rows

Fixed

  • ModelSlice.get_data_row_identifiers scoping by model run id

Version 3.61.1 (2024-01-25)

Fixed

  • Removed export API limit (5000)

Version 3.61.0 (2024-01-22)

Added

  • ModelSlice.get_data_row_identifiers
    • Fetches all data row ids and global keys for the model slice
    • NOTE Foundry model slices are note supported yet

Updated

  • Updated exports v1 deprecation date to April 30th, 2024
  • Remove streamable param from export_v2 methods

Version 3.60.0 (2024-01-17)

Added

  • Get resource tags from a project
  • Method to CatalogSlice to get data row identifiers (both uids and global keys)
  • Added deprecation notice for the upsert_review_queue method in project

Notebooks

  • Update notebook for Project move_data_rows_to_task_queue
  • Added notebook for model foundry
  • Added notebook for migrating from Exports V1 to V2

Version 3.59.0 (2024-01-05)

Added

  • Support set_labeling_parameter_overrides for global keys
  • Support bulk_delete of data row metadata for global keys
  • Support bulk_export of data row metadata for global keys

Fixed

  • Stop overwriting class annotations on prediction upload
  • Prevent users from uploading video annotations over the API limit (5000)
  • Make description optional for foundry app