Type alias VectorIndexDescription

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: VectorIndexNLists;
      numberOfDocsPerCentroid?: number;
      trainingIterations?: number;
  }

  • Optional defaultNProbe?: number

  • dimension: number

  • Optional factory?: string

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

  • nLists: VectorIndexNLists

  • Optional numberOfDocsPerCentroid?: number

    Maximum number of vectors per centroid included in the training sample.

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

  • Optional trainingIterations?: number

• Optional shards?: Record<string, VectorIndexShardDescription>

  Per-shard training details. On a single server, the collection name is used as the key.

  Introduced in: ArangoDB 3.12.10. Only present when listing indexes with the withHidden option.

• Optional storedValues?: string[]

  An array of attribute paths that are stored in the index for efficient filtering and, from ArangoDB 3.12.10 onward, covering projections.

  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.