pass datasetId in request body (#374)

Author: jean-lucas

CHANGELOG.md

@@ -5,6 +5,14 @@ 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.14.28](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.14.28) - 2022-11-17
+
+### Added
+- Support for appending to slice with Scene reference IDs
+- Better error handling when appending to a slice with non-existent reference IDs
+
+
 ## [0.14.27](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.14.27) - 2022-11-04
 
 ### Added

nucleus/__init__.py

@@ -869,22 +869,25 @@ def append_to_slice(
         self,
         slice_id: str,
         reference_ids: List[str],
+        dataset_id: str,
     ) -> dict:
         # TODO: migrate to Slice method and deprecate
-        """Appends dataset items to an existing slice.
+        """Appends dataset items or scenes to an existing slice.
 
         Parameters:
             slice_id: Nucleus-generated dataset ID (starts with ``slc_``). This can
               be retrieved via :meth:`Dataset.slices` or a Nucleus dashboard URL.
-            reference_ids: List of user-defined reference IDs of the dataset items
+            reference_ids: List of user-defined reference IDs of dataset items or scenes
               to append to the slice.
+            dataset_id: ID of dataset this slice belongs to.
 
         Returns:
             Empty payload response.
         """
 
         response = self.make_request(
-            {REFERENCE_IDS_KEY: reference_ids}, f"slice/{slice_id}/append"
+            {REFERENCE_IDS_KEY: reference_ids, DATASET_ID_KEY: dataset_id},
+            f"slice/{slice_id}/append",
         )
         return response
 

nucleus/slice.py

@@ -319,11 +319,11 @@ def append(
         at upload time.
 
         Parameters:
-            reference_ids: A list of user-specified IDs for DatasetItems you wish
-              to append.
+            reference_ids: List of user-defined reference IDs of dataset items or scenes
+              to append to the slice.
 
         Returns:
-            Dict of the slice_id and the newly appended DatasetItem IDs. ::
+            Dict of the slice_id and the newly appended IDs. ::
 
                 {
                     "slice_id": str,
@@ -333,6 +333,7 @@ def append(
         response = self._client.append_to_slice(
             slice_id=self.id,
             reference_ids=reference_ids,
+            dataset_id=self.dataset_id,
         )
         return response
 

pyproject.toml

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