Variable vectorIndexConst

Type declaration

• dynamic: ((opts?) => ModuleConfig<"dynamic", undefined | RecursivePartial<VectorIndexConfigDynamic>>)

  Create a ModuleConfig<'dynamic', VectorIndexConfigDynamicCreate | undefined> object when defining the configuration of the dynamic vector index.

  Use this method when defining the options.vectorIndexConfig argument of the configure.vectorizer method.

  Returns

  The configuration object.

  • • (opts?): ModuleConfig<"dynamic", undefined | RecursivePartial<VectorIndexConfigDynamic>>

    • Parameters

      • Optional opts: VectorIndexConfigDynamicCreateOptions

        The options available for configuring the dynamic vector index.

      Returns ModuleConfig<"dynamic", undefined | RecursivePartial<VectorIndexConfigDynamic>>

• flat: ((opts?) => ModuleConfig<"flat", undefined | RecursivePartial<VectorIndexConfigFlat>>)

  Create a ModuleConfig<'flat', VectorIndexConfigFlatCreate | undefined> object when defining the configuration of the FLAT vector index.

  Use this method when defining the options.vectorIndexConfig argument of the configure.vectorizer method.

  Returns

  The configuration object.

  • • (opts?): ModuleConfig<"flat", undefined | RecursivePartial<VectorIndexConfigFlat>>

    • Parameters

      • Optional opts: VectorIndexConfigFlatCreateOptions

        The options available for configuring the flat vector index.

      Returns ModuleConfig<"flat", undefined | RecursivePartial<VectorIndexConfigFlat>>

• hnsw: ((opts?) => ModuleConfig<"hnsw", undefined | RecursivePartial<VectorIndexConfigHNSW>>)

  Create a ModuleConfig<'hnsw', VectorIndexConfigHNSWCreate | undefined> object when defining the configuration of the HNSW vector index.

  Use this method when defining the options.vectorIndexConfig argument of the configure.vectorizer method.

  Returns

  The configuration object.

  • • (opts?): ModuleConfig<"hnsw", undefined | RecursivePartial<VectorIndexConfigHNSW>>

    • Parameters

      • Optional opts: VectorIndexConfigHNSWCreateOptions

        The options available for configuring the HNSW vector index.

      Returns ModuleConfig<"hnsw", undefined | RecursivePartial<VectorIndexConfigHNSW>>

• quantizer: {
      bq: ((options?) => QuantizerRecursivePartial<BQConfig>);
      pq: ((options?) => QuantizerRecursivePartial<PQConfig>);
      sq: ((options?) => QuantizerRecursivePartial<SQConfig>);
  }

  Define the quantizer configuration to use when creating a vector index.

  • bq: ((options?) => QuantizerRecursivePartial<BQConfig>)

    Create an object of type BQConfigCreate to be used when defining the quantizer configuration of a vector index.

    Returns

    The object of type BQConfigCreate.

    • • (options?): QuantizerRecursivePartial<BQConfig>

      • Parameters

        • Optional options: {
              cache?: boolean;
              rescoreLimit?: number;
          }

          • Optional cache?: boolean

            Whether to cache the quantizer. Default is false.

          • Optional rescoreLimit?: number

            The rescore limit. Default is 1000.

        Returns QuantizerRecursivePartial<BQConfig>

  • pq: ((options?) => QuantizerRecursivePartial<PQConfig>)

    Create an object of type PQConfigCreate to be used when defining the quantizer configuration of a vector index.

    Returns

    The object of type PQConfigCreate.

    • • (options?): QuantizerRecursivePartial<PQConfig>

      • Parameters

        • Optional options: {
              bitCompression?: boolean;
              centroids?: number;
              encoder?: {
                  distribution?: PQEncoderDistribution;
                  type?: PQEncoderType;
              };
              segments?: number;
              trainingLimit?: number;
          }

          • Optional bitCompression?: boolean

            Whether to use bit compression.

          • Optional centroids?: number

            The number of centroids[.

          • Optional encoder?: {
                distribution?: PQEncoderDistribution;
                type?: PQEncoderType;
            }

            • Optional distribution?: PQEncoderDistribution

            • Optional type?: PQEncoderType

          • Optional segments?: number

            The number of segments.

          • Optional trainingLimit?: number

            The training limit.

        Returns QuantizerRecursivePartial<PQConfig>

  • sq: ((options?) => QuantizerRecursivePartial<SQConfig>)

    Create an object of type SQConfigCreate to be used when defining the quantizer configuration of a vector index.

    Returns

    The object of type SQConfigCreate.

    • • (options?): QuantizerRecursivePartial<SQConfig>

      • Parameters

        • Optional options: {
              rescoreLimit?: number;
              trainingLimit?: number;
          }

          • Optional rescoreLimit?: number

            The rescore limit.

          • Optional trainingLimit?: number

            The training limit.

        Returns QuantizerRecursivePartial<SQConfig>