Adding new vector index fields

Author: apetenchea

arangoasync/collection.py

@@ -397,7 +397,7 @@ async def add_index(
 
         Args:
             type (str): Type attribute (ex. "persistent", "inverted", "ttl", "mdi",
-                "geo").
+                "geo", "vector").
             fields (dict | list): Fields to index.
             options (dict | None): Additional index options.
 

arangoasync/typings.py

@@ -727,6 +727,10 @@ def key_options(self) -> KeyOptions:
     def computed_values(self) -> Optional[Json]:
         return self._data.get("computedValues")
 
+    @property
+    def supportsRBAC(self) -> Optional[bool]:
+        return self._data.get("supportsRBAC")
+
     @property
     def object_id(self) -> str:
         return self._data["objectId"]  # type: ignore[no-any-return]
@@ -808,6 +812,8 @@ def compatibility_formatter(data: Json) -> Json:
             result["computedValues"] = data["computedValues"]
         if "internalValidatorType" in data:
             result["internal_validator_type"] = data["internalValidatorType"]
+        if "supportsRBAC" in data:
+            result["supportsRBAC"] = data["supportsRBAC"]
         return result
 
     def format(self, formatter: Optional[Formatter] = None) -> Json:
@@ -1121,6 +1127,14 @@ def include_all_fields(self) -> Optional[bool]:
     def features(self) -> Optional[List[str]]:
         return self._data.get("features")
 
+    @property
+    def error_message(self) -> Optional[str]:
+        return self._data.get("errorMessage")
+
+    @property
+    def training_state(self) -> Optional[str]:
+        return self._data.get("trainingState")
+
     @staticmethod
     def compatibility_formatter(data: Json) -> Json:
         """python-arango compatibility formatter."""
@@ -1179,6 +1193,10 @@ def compatibility_formatter(data: Json) -> Json:
             result["writebuffer_max_size"] = data["writebufferSizeMax"]
         if "optimizeTopK" in data:
             result["optimizeTopK"] = data["optimizeTopK"]
+        if "errorMessage" in data:
+            result["error_message"] = data["errorMessage"]
+        if "trainingState" in data:
+            result["training_state"] = data["trainingState"]
         return result
 
     def format(self, formatter: Optional[Formatter] = None) -> Json:

arangoasync/version.py

@@ -1 +1 @@
-__version__ = "1.2.1"
+__version__ = "1.2.2"

tests/static/cluster-3.12.conf

@@ -9,7 +9,12 @@ jwt-secret = /tests/static/keyfile
 
 [args]
 all.database.password = passwd
+all.vector-index = true
 all.database.extended-names = true
 all.log.api-enabled = true
 all.javascript.allow-admin-execute = true
 all.server.options-api = admin
+all.javascript.files-allowlist = ".*";
+all.javascript.environment-variables-allowlist = ".*";
+all.javascript.endpoints-allowlist = ".*";
+all.javascript.startup-options-allowlist = ".*";

tests/static/single-3.12.conf

@@ -8,6 +8,12 @@ jwt-secret = /tests/static/keyfile
 
 [args]
 all.database.password = passwd
+all.vector-index = true
 all.database.extended-names = true
+all.log.api-enabled = true
 all.javascript.allow-admin-execute = true
 all.server.options-api = admin
+all.javascript.files-allowlist = ".*";
+all.javascript.environment-variables-allowlist = ".*";
+all.javascript.endpoints-allowlist = ".*";
+all.javascript.startup-options-allowlist = ".*";

tests/test_collection.py

@@ -228,15 +228,36 @@ async def test_collection_index(doc_col, bad_col, cluster):
         await bad_col.load_indexes()
     assert err.value.error_code == DATA_SOURCE_NOT_FOUND
 
+    # Create a vector index
+    docs = []
+    for key in range(100):
+        docs.append({"_key": f"key_{key}", "embedding": [1] * 128})
+    await doc_col.insert_many(docs)
+    idx4 = await doc_col.add_index(
+        "vector",
+        ["embedding"],
+        {
+            "name": "vector_index",
+            "params": {
+                "metric": "cosine",
+                "dimension": 128,
+                "nLists": 2,
+            },
+        },
+    )
+    assert idx4.name == "vector_index"
+
     # Delete indexes
-    del1, del2, del3 = await asyncio.gather(
+    del1, del2, del3, del4 = await asyncio.gather(
         doc_col.delete_index(idx1.id),
         doc_col.delete_index(idx2.numeric_id),
         doc_col.delete_index(str(idx3.numeric_id)),
+        doc_col.delete_index(idx4.id),
     )
     assert del1 is True
     assert del2 is True
     assert del3 is True
+    assert del4 is True
 
     # Now, the indexes should be gone
     with pytest.raises(IndexDeleteError) as err: