Type alias VectorIndexConfigHNSWCreateOptions

VectorIndexConfigHNSWCreateOptions: {
    cleanupIntervalSeconds?: number;
    distanceMetric?: VectorDistance;
    dynamicEfFactor?: number;
    dynamicEfMax?: number;
    dynamicEfMin?: number;
    ef?: number;
    efConstruction?: number;
    filterStrategy?: VectorIndexFilterStrategy;
    flatSearchCutoff?: number;
    maxConnections?: number;
    multiVector?: MultiVectorConfigCreate;
    quantizer?: QuantizerConfigCreate;
    skip?: boolean;
    vectorCacheMaxObjects?: number;
}

Type declaration

  • Optional cleanupIntervalSeconds?: number

    The interval in seconds at which to clean up the index. Default is 300.

  • Optional distanceMetric?: VectorDistance

    The distance metric to use. Default is 'cosine'.

  • Optional dynamicEfFactor?: number

    The dynamic ef factor. Default is 8.

  • Optional dynamicEfMax?: number

    The dynamic ef max. Default is 500.

  • Optional dynamicEfMin?: number

    The dynamic ef min. Default is 100.

  • Optional ef?: number

    The ef parameter. Default is -1.

  • Optional efConstruction?: number

    The ef construction parameter. Default is 128.

  • Optional filterStrategy?: VectorIndexFilterStrategy

    The filter strategy to use. Default is 'sweeping'.

  • Optional flatSearchCutoff?: number

    The flat search cutoff. Default is 40000.

  • Optional maxConnections?: number

    The maximum number of connections. Default is 64.

  • Optional multiVector?: MultiVectorConfigCreate

    The multi-vector configuration to use. Use vectorIndex.multiVector to make one.

  • Optional quantizer?: QuantizerConfigCreate

    The quantizer configuration to use. Use vectorIndex.quantizer.bq or vectorIndex.quantizer.pq to make one.

  • Optional skip?: boolean

    Whether to skip the index. Default is false.

  • Optional vectorCacheMaxObjects?: number

    The maximum number of objects to cache in the vector cache. Default is 1000000000000.

Settings

Member Visibility

Theme