Type alias EnsureVectorIndexOptions

EnsureVectorIndexOptions: EnsureIndexOptionsType<"vector", [string], {
    parallelism?: number;
    params: {
        defaultNProbe?: number;
        dimension: number;
        factory?: string;
        metric: "cosine" | "l2" | "innerProduct";
        nLists: number;
        trainingIterations?: number;
    };
    storedValues?: string[];
}>

Options for creating a vector index.

Type declaration

  • Optional parallelism?: number

    The number of threads to use for indexing. Default is 2.

  • params: {
        defaultNProbe?: number;
        dimension: number;
        factory?: string;
        metric: "cosine" | "l2" | "innerProduct";
        nLists: number;
        trainingIterations?: number;
    }

    Vector index parameters, following Faiss configuration.

    • Optional defaultNProbe?: number

      How many neighboring centroids to probe by default. Higher = slower, better recall.

    • dimension: number

      Vector dimension. Must match the length of vectors in documents.

    • Optional factory?: string

      Advanced Faiss index factory string. If not specified, defaults to IVF,Flat.

    • metric: "cosine" | "l2" | "innerProduct"

      Whether to use cosine, l2 (Euclidean), or innerProduct distance. innerProduct was introduced in ArangoDB 3.12.6.

    • nLists: number

      Number of Voronoi cells (centroids) for IVF. Affects accuracy and index build time.

    • Optional trainingIterations?: number

      Training iterations for index build. Default is 25.

  • Optional storedValues?: string[]

    An array of attribute paths that will be stored in the index for efficient filtering. Unlike with other index types, this is not for covering projections with the index but for adding attributes that you filter on. This lets you make the lookup in the vector index more efficient because it avoids materializing documents twice, once for the filtering and once for the matches.

    The maximum number of attributes that you can use in storedValues is 32.

    Introduced in: ArangoDB 3.12.7

Settings

Theme