easier fetch bulk import ndjson

Author: Matt Sokoloff

labelbox/schema/bulk_import_request.py

@@ -113,6 +113,37 @@ class BulkImportRequest(DbObject):
     project = Relationship.ToOne("Project")
     created_by = Relationship.ToOne("User", False, "created_by")
 
+    @property
+    def inputs(self):
+        """
+        Inputs for each individual annotation uploaded.
+        * This should match the ndjson annotations that you have uploaded. 
+        * This information will expire after 24 hours.
+        """        
+        return  self._fetch_remote_ndjson(self.input_file_url)
+        
+    @property
+    def errors(self):
+        """
+        Errors for each individual annotation uploaded.
+        * Returns an empty list if there are no errors and None if the update is still running.
+        * This information will expire after 24 hours.        
+        """
+        return  self._fetch_remote_ndjson(self.error_file_url)
+
+    @property
+    def statuses(self):
+        """
+        Status for each individual annotation uploaded.
+        * Returns a status for each row if the upload is done running and was successful. Otherwise it returns None.
+        * This information will expire after 24 hours.        
+        """
+        return  self._fetch_remote_ndjson(self.status_file_url)
+
+    def _fetch_remote_ndjson(self, url):
+        if url is not None:
+            return ndjson.loads(requests.get(url).text)
+
     def refresh(self) -> None:
         """Synchronizes values of all fields with the database.
         """

labelbox/schema/enums.py

@@ -3,6 +3,19 @@
 
 class BulkImportRequestState(Enum):
     """ State of the import job when importing annotations (RUNNING, FAILED, or FINISHED).
+
+    .. list-table::
+       :widths: 15 150
+       :header-rows: 1 
+
+       * - State
+         - Description
+       * - RUNNING
+         - Indicates that the import job is not done yet.
+       * - FAILED
+         - Indicates the import job failed. Check `BulkImportRequest.errors` for more information
+       * - FINISHED
+         - Indicates the import job is no longer running. Check `BulkImportRequest.statuses` for more information
     """
     RUNNING = "RUNNING"
     FAILED = "FAILED"

tests/integration/bulk_import/test_bulk_import_request.py

@@ -133,6 +133,9 @@ def test_wait_till_done(configured_project):
     assert (bulk_import_request.state == BulkImportRequestState.FINISHED or
             bulk_import_request.state == BulkImportRequestState.FAILED)
 
+    assert bulk_import_request.errors is not None
+    assert bulk_import_request.inputs is not None
+
 
 def assert_file_content(url: str, predictions):
     response = requests.get(url)