Continuous indexing API update (#163)

Updates the continuous indexing endpoint to now support returning an AsyncJob for backfilling unindexed images in the dataset.

Author: jihan-yin

nucleus/constants.py

@@ -3,6 +3,7 @@
 ANNOTATIONS_PROCESSED_KEY = "annotations_processed"
 ANNOTATION_ID_KEY = "annotation_id"
 ANNOTATION_METADATA_SCHEMA_KEY = "annotation_metadata_schema"
+BACKFILL_JOB_KEY = "backfill_job"
 BOX_TYPE = "box"
 POLYGON_TYPE = "polygon"
 MASK_TYPE = "mask"

nucleus/dataset.py

@@ -33,9 +33,12 @@
 from .constants import (
     ANNOTATIONS_KEY,
     AUTOTAG_SCORE_THRESHOLD,
+    BACKFILL_JOB_KEY,
+    DATASET_ID_KEY,
     DEFAULT_ANNOTATION_UPDATE_MODE,
     EXPORTED_ROWS,
     KEEP_HISTORY_KEY,
+    MESSAGE_KEY,
     NAME_KEY,
     REFERENCE_IDS_KEY,
     REQUEST_ID_KEY,
@@ -769,9 +772,21 @@ def set_continuous_indexing(self, enable: bool = True):
                 {
                     "dataset_id": str,
                     "message": str
+                    "backfill_job": AsyncJob,
                 }
         """
-        return self._client.set_continuous_indexing(self.id, enable)
+        preprocessed_response = self._client.set_continuous_indexing(
+            self.id, enable
+        )
+        response = {
+            DATASET_ID_KEY: preprocessed_response[DATASET_ID_KEY],
+            MESSAGE_KEY: preprocessed_response[MESSAGE_KEY],
+        }
+        if enable:
+            response[BACKFILL_JOB_KEY] = (
+                AsyncJob.from_json(preprocessed_response, self._client),
+            )
+        return response
 
     def create_image_index(self):
         """Creates or updates image index by generating embeddings for images that do not already have embeddings.

pyproject.toml

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