Variable vectorIndexConst

Type Declaration

• dynamic: (
      opts?: VectorIndexConfigDynamicCreateOptions,
  ) => ModuleConfig<"dynamic", VectorIndexConfigDynamicCreate | undefined>

  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.vectors method.

• flat: (
      opts?: VectorIndexConfigFlatCreateOptions,
  ) => ModuleConfig<"flat", VectorIndexConfigFlatCreate | undefined>

  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.vectors method.

• hfresh: (
      opts?: VectorIndexConfigHFreshCreateOptions,
  ) => ModuleConfig<"hfresh", VectorIndexConfigHFreshCreate | undefined>

  Create a ModuleConfig<'hfresh', VectorIndexConfigHFreshCreate | undefined> object when defining the configuration of the HFresh vector index.

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

• hnsw: (
      opts?: VectorIndexConfigHNSWCreateOptions,
  ) => ModuleConfig<"hnsw", VectorIndexConfigHNSWCreate | undefined>

  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.vectors method.

• multiVector: {
      encoding: {
          muvera: (
              options?: {
                  dprojections?: number;
                  ksim?: number;
                  repetitions?: number;
              },
          ) => MuveraEncodingConfigCreate;
      };
      multiVector: (
          options?: {
              aggregation?: "maxSim" | string;
              encoding?: MultiVectorConfigCreate["encoding"];
          },
      ) => MultiVectorConfigCreate;
  }

  Define the configuration for a multi-vector index.

  • encoding: {
        muvera: (
            options?: {
                dprojections?: number;
                ksim?: number;
                repetitions?: number;
            },
        ) => MuveraEncodingConfigCreate;
    }

    Specify the encoding configuration for a multi-vector index.

    • muvera: (
          options?: { dprojections?: number; ksim?: number; repetitions?: number },
      ) => MuveraEncodingConfigCreate

      Create an object of type MuveraEncodingConfigCreate to be used when defining the encoding configuration of a multi-vector index using MUVERA.

  • multiVector: (
        options?: {
            aggregation?: "maxSim" | string;
            encoding?: MultiVectorConfigCreate["encoding"];
        },
    ) => MultiVectorConfigCreate

    Create an object of type MultiVectorConfigCreate to be used when defining the configuration of a multi-vector index.

• quantizer: {
      bq: (
          options?: { cache?: boolean; rescoreLimit?: number },
      ) => BQConfigCreate;
      none: () => UncompressedConfig;
      pq: (
          options?: {
              bitCompression?: boolean;
              centroids?: number;
              encoder?: { distribution?: PQEncoderDistribution; type?: PQEncoderType };
              segments?: number;
              trainingLimit?: number;
          },
      ) => PQConfigCreate;
      rq: (options?: { bits?: number; rescoreLimit?: number }) => RQConfigCreate;
      sq: (
          options?: { rescoreLimit?: number; trainingLimit?: number },
      ) => SQConfigCreate;
  }

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

  • bq: (options?: { cache?: boolean; rescoreLimit?: number }) => BQConfigCreate

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

  • none: () => UncompressedConfig

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

    This is useful for disabling the default quantization present in Weaviate>=1.33.0.

  • pq: (
        options?: {
            bitCompression?: boolean;
            centroids?: number;
            encoder?: { distribution?: PQEncoderDistribution; type?: PQEncoderType };
            segments?: number;
            trainingLimit?: number;
        },
    ) => PQConfigCreate

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

  • rq: (options?: { bits?: number; rescoreLimit?: number }) => RQConfigCreate

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

  • sq: (options?: { rescoreLimit?: number; trainingLimit?: number }) => SQConfigCreate

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