Merge pull request #98 from scaleapi/jihan/indexing-api

API for continuous indexing and manual image indexing

Author: jihan-yin

nucleus/__init__.py

@@ -94,6 +94,7 @@
     JOB_CREATION_TIME_KEY,
     IMAGE_KEY,
     IMAGE_URL_KEY,
+    INDEX_CONTINUOUS_ENABLE_KEY,
     ITEM_METADATA_SCHEMA_KEY,
     ITEMS_KEY,
     KEEP_HISTORY_KEY,
@@ -1206,6 +1207,37 @@ def delete_custom_index(self, dataset_id: str):
             requests_command=requests.delete,
         )
 
+    def set_continuous_indexing(self, dataset_id: str, enable: bool = True):
+        """
+        Sets continuous indexing for a given dataset, which will automatically generate embeddings whenever
+        new images are uploaded. This endpoint is currently only enabled for enterprise customers.
+        Please reach out to nucleus@scale.com if you wish to learn more.
+
+        :param
+        dataset_id: id of dataset that continuous indexing is being toggled for
+        enable: boolean, sets whether we are enabling or disabling continuous indexing. The default behavior is to enable.
+        """
+        return self.make_request(
+            {INDEX_CONTINUOUS_ENABLE_KEY: enable},
+            f"indexing/{dataset_id}/setContinuous",
+            requests_command=requests.post,
+        )
+
+    def create_image_index(self, dataset_id: str):
+        """
+        Starts generating embeddings for images that don't have embeddings in a given dataset. These embeddings will
+        be used for autotag and similarity search. This endpoint is currently only enabled for enterprise customers.
+        Please reach out to nucleus@scale.com if you wish to learn more.
+
+        :param
+        dataset_id: id of dataset for generating embeddings on.
+        """
+        return self.make_request(
+            {},
+            f"indexing/{dataset_id}/internal/image",
+            requests_command=requests.post,
+        )
+
     def make_request(
         self, payload: dict, route: str, requests_command=requests.post
     ) -> dict:

nucleus/constants.py

@@ -44,6 +44,7 @@
 IMAGE_LOCATION_KEY = "image_location"
 IMAGE_URL_KEY = "image_url"
 INDEX_KEY = "index"
+INDEX_CONTINUOUS_ENABLE_KEY = "enable"
 ITEMS_KEY = "items"
 ITEM_ID_KEY = "item_id"
 ITEM_KEY = "item"

nucleus/dataset.py

@@ -400,6 +400,13 @@ def create_custom_index(self, embeddings_urls: list, embedding_dim: int):
     def delete_custom_index(self):
         return self._client.delete_custom_index(self.id)
 
+    def set_continuous_indexing(self, enable: bool = True):
+        return self._client.set_continuous_indexing(self.id, enable)
+
+    def create_image_index(self):
+        response = self._client.create_image_index(self.id)
+        return AsyncJob.from_json(response, self._client)
+
     def check_index_status(self, job_id: str):
         return self._client.check_index_status(job_id)
 

pyproject.toml

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

tests/test_indexing.py

@@ -57,3 +57,10 @@ def test_index_integration(dataset):
     assert STATUS_KEY in job_status_response
     assert JOB_ID_KEY in job_status_response
     assert MESSAGE_KEY in job_status_response
+
+
+def test_generate_image_index_integration(dataset):
+    job = dataset.create_image_index()
+    job.sleep_until_complete()
+    job.status()
+    assert job.job_last_known_status == "Completed"