changelog (#385)

Author: jean-lucas

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to the [Nucleus Python Client](https://github.com/scaleapi/n
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.15.6](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.15.6) - 2023-06-03
+
+### Changed
+- Document new restrictions to slice create/append.
+- `Dataset.create_slice` and `Slice.append` methods cannot exceed 10,000 items per request.
+
 ## [0.15.5](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.15.5) - 2023-05-8
 
 ### Fixed

nucleus/dataset.py

@@ -887,10 +887,13 @@ def create_slice(
 
         Parameters:
             name: A human-readable name for the slice.
-            reference_ids: List of reference IDs of dataset items to add to the slice::
+            reference_ids: List of reference IDs of dataset items to add to the slice, cannot exceed 10,000 items.
 
         Returns:
             :class:`Slice`: The newly constructed slice item.
+
+        Raises:
+            BadRequest: If length of reference_ids is too large (> 10,000 items)
         """
         payload = {NAME_KEY: name, REFERENCE_IDS_KEY: reference_ids}
         response = self._client.make_request(

nucleus/slice.py

@@ -340,7 +340,7 @@ def append(
         """Appends existing DatasetItems from a Dataset to a Slice.
 
         The endpoint expects a list of DatasetItem reference IDs which are set
-        at upload time.
+        at upload time. The length of reference_ids cannot exceed 10,000 items per request.
 
         Parameters:
             reference_ids: List of user-defined reference IDs of dataset items or scenes
@@ -353,6 +353,9 @@ def append(
                     "slice_id": str,
                     "new_items": List[str]
                 }
+
+        Raises:
+            BadRequest: If length of reference_ids is too large (> 10,000 items)
         """
         response = self._client.append_to_slice(
             slice_id=self.id,

pyproject.toml

@@ -21,7 +21,7 @@ exclude = '''
 
 [tool.poetry]
 name = "scale-nucleus"
-version = "0.15.5"
+version = "0.15.6"
 description = "The official Python client library for Nucleus, the Data Platform for AI"
 license =  "MIT"
 authors = ["Scale AI Nucleus Team <nucleusapi@scaleapi.com>"]