update doc strings, error messages and ignore tags

chromadb/api/segment.py

@@ -854,6 +854,9 @@ def generate_ids_when_not_present(
             return ids
 
         (_, n) = get_n_items_from_record_set(record_set)
+        if n is None:
+            raise ValueError("Expected record set to have at least one item")
+
         generated_ids: List[str] = [str(uuid4()) for _ in range(n)]
 
         return generated_ids

chromadb/api/types.py

@@ -67,7 +67,9 @@ def maybe_cast_one_to_many_embedding(
     if isinstance(embeddings_list, List):
         # One Embedding
         if len(embeddings_list) == 0:
-            raise ValueError("Expected embeddings to be a list with at least one item")
+            raise ValueError(
+                "Expected embeddings to be a list or a numpy array with at least one item"
+            )
 
         if isinstance(embeddings_list[0], (int, float)):
             return cast(Embeddings, [embeddings_list])
@@ -602,7 +604,7 @@ def validate_record_set_consistency(record_set: RecordSet) -> None:
 
 def get_n_items_from_record_set(
     record_set: RecordSet,
-) -> Tuple[Union[str, None], Union[int, None]]:
+) -> Tuple[Optional[str], Optional[int]]:
     """
     Get the number of items in the record set.
     """

chromadb/test/api/test_api_add.py

@@ -9,18 +9,18 @@ def test_add_with_no_ids(client: ClientAPI) -> None:
 
     coll = client.create_collection("test")
     coll.add(
-        embeddings=[[1, 2, 3], [1, 2, 3], [1, 2, 3]],  # type: ignore
-        metadatas=[{"a": 1}, None, {"a": 3}],  # type: ignore
-        documents=["a", "b", None],  # type: ignore
+        embeddings=[[1, 2, 3], [1, 2, 3], [1, 2, 3]],  # type: ignore[arg-type]
+        metadatas=[{"a": 1}, None, {"a": 3}],  # type: ignore[list-item]
+        documents=["a", "b", None],  # type: ignore[list-item]
     )
 
     results = coll.get()
     assert len(results["ids"]) == 3
 
     coll.add(
-        embeddings=[[1, 2, 3], [1, 2, 3], [1, 2, 3]],  # type: ignore
-        metadatas=[{"a": 1}, None, {"a": 3}],  # type: ignore
-        documents=["a", "b", None],  # type: ignore
+        embeddings=[[1, 2, 3], [1, 2, 3], [1, 2, 3]],  # type: ignore[arg-type]
+        metadatas=[{"a": 1}, None, {"a": 3}],  # type: ignore[list-item]
+        documents=["a", "b", None],  # type: ignore[list-item]
     )
 
     results = coll.get()
@@ -36,7 +36,7 @@ def test_add_with_inconsistent_number_of_items(client: ClientAPI) -> None:
     with pytest.raises(ValueError, match="Inconsistent number of records"):
         coll.add(
             ids=["1", "2"],
-            embeddings=[[1, 2, 3], [1, 2, 3], [1, 2, 3]],  # type: ignore
+            embeddings=[[1, 2, 3], [1, 2, 3], [1, 2, 3]],  # type: ignore[arg-type]
             metadatas=[{"a": 1}, {"a": 2}, {"a": 3}],
             documents=["a", "b", "c"],
         )
@@ -45,7 +45,7 @@ def test_add_with_inconsistent_number_of_items(client: ClientAPI) -> None:
     with pytest.raises(ValueError, match="Inconsistent number of records"):
         coll.add(
             ids=["1", "2", "3"],
-            embeddings=[[1, 2, 3], [1, 2, 3]],  # type: ignore
+            embeddings=[[1, 2, 3], [1, 2, 3]],  # type: ignore[arg-type]
             metadatas=[{"a": 1}, {"a": 2}, {"a": 3}],
             documents=["a", "b", "c"],
         )
@@ -54,7 +54,7 @@ def test_add_with_inconsistent_number_of_items(client: ClientAPI) -> None:
     with pytest.raises(ValueError, match="Inconsistent number of records"):
         coll.add(
             ids=["1", "2", "3"],
-            embeddings=[[1, 2, 3], [1, 2, 3], [1, 2, 3]],  # type: ignore
+            embeddings=[[1, 2, 3], [1, 2, 3], [1, 2, 3]],  # type: ignore[arg-type]
             metadatas=[{"a": 1}, {"a": 2}],
             documents=["a", "b", "c"],
         )
@@ -63,7 +63,7 @@ def test_add_with_inconsistent_number_of_items(client: ClientAPI) -> None:
     with pytest.raises(ValueError, match="Inconsistent number of records"):
         coll.add(
             ids=["1", "2", "3"],
-            embeddings=[[1, 2, 3], [1, 2, 3], [1, 2, 3]],  # type: ignore
+            embeddings=[[1, 2, 3], [1, 2, 3], [1, 2, 3]],  # type: ignore[arg-type]
             metadatas=[{"a": 1}, {"a": 2}, {"a": 3}],
             documents=["a", "b"],
         )
@@ -72,7 +72,7 @@ def test_add_with_inconsistent_number_of_items(client: ClientAPI) -> None:
     with pytest.raises(ValueError, match="Inconsistent number of records"):
         coll.add(
             ids=["1", "2"],
-            embeddings=[[1, 2, 3], [1, 2, 3], [1, 2, 3]],  # type: ignore
+            embeddings=[[1, 2, 3], [1, 2, 3], [1, 2, 3]],  # type: ignore[arg-type]
             metadatas=[{"a": 1}],
             documents=["a", "b", "c", "d"],
         )
@@ -85,10 +85,10 @@ def test_add_with_partial_ids(client: ClientAPI) -> None:
 
     with pytest.raises(ValueError, match="Expected ID to be a str"):
         coll.add(
-            ids=["1", None],  # type: ignore
-            embeddings=[[1, 2, 3], [1, 2, 3], [1, 2, 3]],  # type: ignore
-            metadatas=[{"a": 1}, None, {"a": 3}],  # type: ignore
-            documents=["a", "b", None],  # type: ignore
+            ids=["1", None],  # type: ignore[list-item]
+            embeddings=[[1, 2, 3], [1, 2, 3], [1, 2, 3]],  # type: ignore[arg-type]
+            metadatas=[{"a": 1}, None, {"a": 3}],  # type: ignore[list-item]
+            documents=["a", "b", None],  # type: ignore[list-item]
         )
 
 
@@ -98,7 +98,8 @@ def test_add_with_no_data(client: ClientAPI) -> None:
     coll = client.create_collection("test")
 
     with pytest.raises(
-        Exception, match="Expected embeddings to be a list with at least one item"
+        Exception,
+        match="Expected embeddings to be a list or a numpy array with at least one item",
     ):
         coll.add(
             ids=["1"],

chromadb/test/property/invariants.py

@@ -133,7 +133,7 @@ def _field_matches(
     n: int,
 ) -> None:
     """
-    The actual embedding field is equal to the expected field
+    The actual record field is equal to the expected field
     field_name: one of [documents, metadatas]
     """
     # If there are no ids, then there are no data to test
@@ -190,7 +190,7 @@ def ids_match(collection: Collection, record_set: RecordSet) -> None:
 
 
 def metadatas_match(collection: Collection, record_set: RecordSet) -> None:
-    """The actual embedding metadata is equal to the expected metadata"""
+    """The actual record set metadatas are equal to the expected metadatas"""
     normalized_record_set = wrap_all(record_set)
 
     _field_matches(
@@ -204,7 +204,7 @@ def metadatas_match(collection: Collection, record_set: RecordSet) -> None:
 def metadatas_match_state_record_set(
     collection: Collection, record_set: StateMachineRecordSet
 ) -> None:
-    """The actual embedding metadata is equal to the expected metadata"""
+    """The actual metadatas within the state record set are equal to the expected metadata"""
     normalized_record_set = wrap_all(cast(RecordSet, record_set))
 
     _field_matches(
@@ -216,7 +216,7 @@ def metadatas_match_state_record_set(
 
 
 def documents_match(collection: Collection, record_set: RecordSet) -> None:
-    """The actual embedding documents is equal to the expected documents"""
+    """The actual record set documents are equal to the expected documents"""
     normalized_record_set = wrap_all(record_set)
     _field_matches(
         collection,
@@ -229,7 +229,7 @@ def documents_match(collection: Collection, record_set: RecordSet) -> None:
 def documents_match_state_record_set(
     collection: Collection, record_set: StateMachineRecordSet
 ) -> None:
-    """The actual embedding documents is equal to the expected metadata"""
+    """The actual documents within the state record set are equal to the expected documents"""
     normalized_record_set = wrap_all(cast(RecordSet, record_set))
 
     _field_matches(
@@ -241,7 +241,7 @@ def documents_match_state_record_set(
 
 
 def embeddings_match(collection: Collection, record_set: RecordSet) -> None:
-    """The actual embedding is equal to the expected documents"""
+    """The actual record set embeddings are equal to the expected embeddings"""
     normalized_record_set = wrap_all(record_set)
     _field_matches(
         collection,
@@ -254,7 +254,7 @@ def embeddings_match(collection: Collection, record_set: RecordSet) -> None:
 def embeddings_match_state_record_set(
     collection: Collection, record_set: StateMachineRecordSet
 ) -> None:
-    """The actual embedding is equal to the expected metadata"""
+    """The actual embeddings within the state record set are equal to the expected embeddings"""
     normalized_record_set = wrap_all(cast(RecordSet, record_set))
 
     _field_matches(

chromadb/test/property/test_embeddings.py

@@ -133,7 +133,7 @@ def add_embeddings(self, record_set: strategies.RecordSet) -> MultipleResults[ID
         if len(intersection) > 0:
             # Partially apply the non-duplicative records to the state
             new_ids = list(set(ids).difference(intersection))  # type: ignore[arg-type]
-            indices = [ids.index(id) for id in new_ids]  # type: ignore
+            indices = [ids.index(id) for id in new_ids]  # type: ignore[union-attr]
             filtered_record_set: strategies.NormalizedRecordSet = {
                 "ids": [ids[i] for i in indices],  # type: ignore
                 "metadatas": [normalized_record_set["metadatas"][i] for i in indices]