FE-611 | Add Vector Index Feature (#21793)

arangodb · mchacki · Jul 8, 2025 · Jun 23, 2025 · Jun 23, 2025 · Jun 23, 2025
commit 5021b04f8459c7776bb2e529b43db3695ff0a1b6
diff --git a/CHANGELOG b/CHANGELOG
@@ -5,6 +5,8 @@ devel
   a better performing query. This should help on larger graphs
   having more, not displayed data.
 
+* FE-611: Add support for experimental vector index to the collection Indexes view with "beta" label, shown only if --experimental-vector-index flag is enabled.
+
 * Add inner product metric for vector index and APPROX_NEAR_INNER_PRODUCT()
   AQL function. The inner product metric is similar to cosine metric except
   vectors are not normalized.

diff --git a/...s/system/_admin/aardvark/APP/react/src/views/collections/indices/CollectionIndex.types.ts b/...s/system/_admin/aardvark/APP/react/src/views/collections/indices/CollectionIndex.types.ts
@@ -5,4 +5,20 @@ type MdiPrefixed = Omit<MdiIndex, "type"> & {
   prefixFields: string[];
 };
 
-export type CollectionIndex = Index | MdiIndex | MdiPrefixed;
+type Vector = {
+  type: "vector";
+  fields: string[];
+  name?: string;
+  params: {
+    metric: "cosine" | "l2" | string;
+    dimension: number;
+    nLists: number;
+    defaultNProbe?: number;
+    trainingIterations?: number;
+    factory?: string;
+  };
+  parallelism: number;
+  inBackground: boolean;
+};
+
+export type CollectionIndex = Index | MdiIndex | MdiPrefixed | Vector;
diff --git a/.../system/_admin/aardvark/APP/react/src/views/collections/indices/addIndex/AddIndexForm.tsx b/.../system/_admin/aardvark/APP/react/src/views/collections/indices/addIndex/AddIndexForm.tsx
@@ -11,6 +11,7 @@ import { MDIIndexForm } from "./MDIIndexForm";
 import { MDIPrefixedIndexForm } from "./MDIPrefixedIndexForm";
 import { PersistentIndexForm } from "./PersistentIndexForm";
 import { TTLIndexForm } from "./TTLIndexForm";
+import { VectorIndexForm } from "./vectorIndex/VectorIndexForm";
 
 export const AddIndexForm = ({ onClose }: { onClose: () => void }) => {
   const { indexTypeOptions } = useCollectionIndicesContext();
@@ -79,5 +80,8 @@ const IndexTypeForm = ({
   if (type === "mdi-prefixed") {
     return <MDIPrefixedIndexForm onClose={onClose} />;
   }
+  if (type === "vector") {
+    return <VectorIndexForm onClose={onClose} />;
+  }
   return <></>;
 };
diff --git a/...tem/_admin/aardvark/APP/react/src/views/collections/indices/addIndex/IndexFieldsHelper.ts b/...tem/_admin/aardvark/APP/react/src/views/collections/indices/addIndex/IndexFieldsHelper.ts
@@ -14,16 +14,15 @@ export const commonFieldsMap = {
     label: "Name",
     name: "name",
     type: "text",
-    tooltip:
-      "Index name. If left blank, the name will be auto-generated. Example: byValue",
+    tooltip: "Index name. If left blank, the name will be auto-generated. Example: byValue",
     initialValue: ""
   },
   inBackground: {
     label: "Create in background",
     name: "inBackground",
     type: "boolean",
     initialValue: true,
-    tooltip: "Create the index in background."
+    tooltip: "Enable this option to keep the collection/shards available for write operations by not using an exclusive write lock for the duration of the index creation."
   }
 };
 const traditionalNameSchema = Yup.string()

diff --git a/...aardvark/APP/react/src/views/collections/indices/addIndex/vectorIndex/VectorIndexForm.tsx b/...aardvark/APP/react/src/views/collections/indices/addIndex/vectorIndex/VectorIndexForm.tsx
@@ -0,0 +1,22 @@
+import React from "react";
+import { IndexFormInner } from "../IndexFormInner";
+import {
+  FIELDS,
+  INITIAL_VALUES,
+  SCHEMA,
+  useCreateVectorIndex
+} from "./useCreateVectorIndex";
+
+export const VectorIndexForm = ({ onClose }: { onClose: () => void }) => {
+  const { onCreate } = useCreateVectorIndex();
+
+  return (
+    <IndexFormInner<typeof INITIAL_VALUES, typeof FIELDS, typeof SCHEMA>
+      initialValues={INITIAL_VALUES}
+      schema={SCHEMA}
+      fields={FIELDS}
+      onCreate={onCreate}
+      onClose={onClose}
+    />
+  );
+};
diff --git a/...vark/APP/react/src/views/collections/indices/addIndex/vectorIndex/useCreateVectorIndex.ts b/...vark/APP/react/src/views/collections/indices/addIndex/vectorIndex/useCreateVectorIndex.ts
@@ -0,0 +1,114 @@
+import * as Yup from "yup";
+import { commonFieldsMap, commonSchema } from "../IndexFieldsHelper";
+import { useCreateIndex } from "../useCreateIndex";
+
+export const INITIAL_VALUES = {
+  type: "vector",
+  fields: "",
+  name: commonFieldsMap.name.initialValue,
+  params: {
+    metric: "",
+    dimension: undefined,
+    nLists: undefined,
+    defaultNProbe: 1,
+    trainingIterations: 25,
+    factory: undefined
+  },
+  parallelism: 2,
+  inBackground: commonFieldsMap.inBackground.initialValue
+};
+
+export const FIELDS = [
+  {
+    label: "Field",
+    name: "fields",
+    type: "text",
+    isRequired: true,
+    tooltip: "The name of the attribute that contains the vector embeddings. Only a single attribute is supported."
+  },
+  commonFieldsMap.name,
+  {
+    label: "Metric",
+    name: "params.metric",
+    type: "creatableSingleSelect",
+    isRequired: true,
+    options: [
+      { label: "Cosine", value: "cosine" },
+      { label: "L2 (Euclidean)", value: "l2" }
+    ],
+    tooltip: "Distance metric used for similarity search. Choose between cosine similarity or Euclidean distance."
+  },
+  {
+    label: "Dimension",
+    name: "params.dimension",
+    type: "number",
+    isRequired: true,
+    tooltip: "The dimensionality of the vector embeddings. The indexed attribute must contain vectors of this length."
+  },
+  {
+    label: "Number of Lists (nLists)",
+    name: "params.nLists",
+    type: "number",
+    isRequired: true,
+    tooltip: "The number of Voronoi cells (nLists) to partition the vector space into. A higher value improves recall but increases indexing time. The value must not exceed the number of documents. Suggested: 15 * sqrt(N), where N is the number of documents."
+  },
+  {
+    label: "Default Number of Probes",
+    name: "params.defaultNProbe",
+    type: "number",
+    tooltip: "The number of inverted lists (clusters) to search during queries by default. Increasing this value improves recall at the cost of speed. The default is 1."
+  },
+  {
+    label: "Training Iterations",
+    name: "params.trainingIterations",
+    type: "number",
+    tooltip: "The number of iterations to use during index training. More iterations improve cluster quality and accuracy, but increase training time. The default is 25."
+  },
+  {
+    label: "Index Factory",
+    name: "params.factory",
+    type: "text",
+    tooltip: `Defines the FAISS index factory. Must start with "IVF". Example: IVF100_HNSW10,Flat. The number following "IVF" must match nLists (e.g. IVF100 → nLists = 100).`
+  },
+  {
+    label: "Parallelism",
+    name: "parallelism",
+    type: "number",
+    tooltip: "Number of threads to use for indexing. The default is 2."
+  },
+  commonFieldsMap.inBackground,
+];
+
+export const SCHEMA = Yup.object({
+  fields: Yup.string().trim().required("Field is required"),
+  name: commonSchema.name,
+  params: Yup.object({
+    metric: Yup.string().required("Metric is required"),
+    dimension: Yup.number().required("Dimension is required"),
+    nLists: Yup.number().required("Number of lists (nLists) is required"),
+    defaultNProbe: Yup.number().optional(),
+    trainingIterations: Yup.number().optional(),
+    factory: Yup.string().optional()
+  }),
+  parallelism: Yup.number().optional(),
+  inBackground: commonSchema.inBackground
+});
+
+type ValuesType = Omit<typeof INITIAL_VALUES, "fields"> & {
+  fields: string[];
+};
+
+export const useCreateVectorIndex = () => {
+  const { onCreate: onCreateIndex } = useCreateIndex<ValuesType>();
+  const onCreate = async ({ values }: { values: typeof INITIAL_VALUES }) => {
+    return onCreateIndex({
+      type: values.type,
+      fields: [values.fields.trim()],
+      name: values.name,
+      params: values.params,
+      parallelism: values.parallelism,
+      inBackground: values.inBackground
+    });
+  };
+  return { onCreate };
+};
diff --git a/...system/_admin/aardvark/APP/react/src/views/collections/indices/useSupportedIndexTypes.tsx b/...system/_admin/aardvark/APP/react/src/views/collections/indices/useSupportedIndexTypes.tsx
@@ -63,5 +63,9 @@ const indexTypeOptions: {
   {
     label: "Inverted Index",
     value: "inverted"
+  },
+  {
+    label: "Vector index (beta)",
+    value: "vector"
   }
 ];