[PLT-981][PLT-982] Throw user readable errors when creating a custom embedding with an existing name or too few dimensions.

Author: sfendell-labelbox

libs/labelbox/src/labelbox/adv_client.py

@@ -3,6 +3,7 @@
 import logging
 from typing import Dict, Any, Optional, List, Callable
 from urllib.parse import urlparse
+from labelbox.exceptions import ADVError
 
 import requests
 from requests import Session, Response
@@ -59,7 +60,18 @@ def _request(self,
                                         url,
                                         data=requests_data,
                                         headers=headers)
-        response.raise_for_status()
+        if response.status_code != 200:
+            response_json = response.json()
+            if response_json.get('status') == 'CONFLICT':
+                raise ADVError("A custom embedding with this name already exists. Custom embeddings must have unique names.")
+            message = response_json.get('message')
+            if message:
+                if message == "must be greater than or equal to 8":
+                    raise ADVError("Custom embeddings require at least 8 dimensions.")
+                else:
+                    raise ADVError(response.json()['message'])
+            else:
+                response.raise_for_status()
         return response.json()
 
     def _send_ndjson(self,

libs/labelbox/src/labelbox/exceptions.py

@@ -15,6 +15,9 @@ def __init__(self, message, cause=None):
     def __str__(self):
         return self.message + str(self.args)
 
+class ADVError(LabelboxError):
+    """Raised when ADV service returns an error for a REST call"""
+    pass
 
 class AuthenticationError(LabelboxError):
     """Raised when an API key fails authentication."""

libs/labelbox/src/labelbox/schema/embedding.py

@@ -1,6 +1,7 @@
 from typing import Optional, Callable, Dict, Any, List
 
 from labelbox.adv_client import AdvClient
+from labelbox.exceptions import ADVError
 from labelbox.pydantic_compat import BaseModel, PrivateAttr
 
 

libs/labelbox/tests/integration/test_embedding.py

@@ -54,6 +54,16 @@ def callback(_: Dict[str, Any]):
     assert event.wait(10.0)  # seconds
 
 
+def test_create_embedding_with_too_few_dimensions(client: Client):
+    with pytest.raises(labelbox.exceptions.ADVError):
+        client.create_embedding(f"toosmall", 1)
+
+
+def test_create_embedding_with_name_collision(client: Client, embedding: Embedding):
+    with pytest.raises(labelbox.exceptions.ADVError):
+        client.create_embedding(embedding.name, 1)
+
+
 def test_get_imported_vector_count(dataset: Dataset, embedding: Embedding):
     assert embedding.get_imported_vector_count() == 0