Type alias VectorIndexDescription

VectorIndexDescription: IndexDescriptionType<"vector", [string], {
    errorMessage?: string;
    inBackground: boolean;
    parallelism: number;
    params: {
        defaultNProbe?: number;
        dimension: number;
        factory?: string;
        metric: "cosine" | "l2" | "innerProduct";
        nLists: number;
        trainingIterations?: number;
    };
    storedValues?: string[];
    trainingState?: VectorIndexTrainingState;
}>

An object representing a vector index.

Type declaration

  • Optional errorMessage?: string

    Optional detail when training fails or the index is unusable (for example, insufficient training data).

    Introduced in: ArangoDB 3.12.9. Only present when there is a problem with the index.

  • inBackground: boolean
  • parallelism: number
  • params: {
        defaultNProbe?: number;
        dimension: number;
        factory?: string;
        metric: "cosine" | "l2" | "innerProduct";
        nLists: number;
        trainingIterations?: number;
    }
    • Optional defaultNProbe?: number
    • dimension: number
    • Optional factory?: string
    • metric: "cosine" | "l2" | "innerProduct"
    • nLists: number
    • Optional trainingIterations?: number
  • Optional storedValues?: string[]

    An array of attribute paths that are stored in the index for efficient filtering.

    Introduced in: ArangoDB 3.12.7

  • Optional trainingState?: VectorIndexTrainingState

    Current training state of the vector index.

    Introduced in: ArangoDB 3.12.9. Omitted on older server versions.

Settings

Theme