Variable reconfigureConst

Type declaration

• generative: {
      azureOpenAI: ((config) => ModuleConfig<"generative-openai", GenerativeAzureOpenAIConfig>);
      cohere: ((config?) => ModuleConfig<"generative-cohere", undefined | GenerativeCohereConfig>);
      databricks: ((config) => ModuleConfig<"generative-databricks", GenerativeDatabricksConfig>);
      google: ((config?) => ModuleConfig<"generative-google", undefined | GenerativeGoogleConfig>);
      openAI: ((config?) => ModuleConfig<"generative-openai", undefined | GenerativeOpenAIConfig>);
      palm: ((config?) => ModuleConfig<"generative-palm", undefined | GenerativeGoogleConfig>);
      anthropic(config?): ModuleConfig<"generative-anthropic", undefined | GenerativeAnthropicConfig>;
      anyscale(config?): ModuleConfig<"generative-anyscale", undefined | GenerativeAnyscaleConfig>;
      aws(config): ModuleConfig<"generative-aws", GenerativeAWSConfig>;
      friendliai(config?): ModuleConfig<"generative-friendliai", undefined | GenerativeFriendliAIConfig>;
      mistral(config?): ModuleConfig<"generative-mistral", undefined | GenerativeMistralConfig>;
      ollama(config?): ModuleConfig<"generative-ollama", undefined | GenerativeOllamaConfig>;
  }

  • azureOpenAI: ((config) => ModuleConfig<"generative-openai", GenerativeAzureOpenAIConfig>)

    Create a ModuleConfig<'generative-openai', GenerativeAzureOpenAIConfig> object for use when performing AI generation using the generative-openai module.

    See the documentation for detailed usage.

    Returns

    The configuration object.

    • • (config): ModuleConfig<"generative-openai", GenerativeAzureOpenAIConfig>

      • Parameters

        • config: GenerativeAzureOpenAIConfigCreate

          The configuration for the generative-openai module.

        Returns ModuleConfig<"generative-openai", GenerativeAzureOpenAIConfig>

  • cohere: ((config?) => ModuleConfig<"generative-cohere", undefined | GenerativeCohereConfig>)

    Create a ModuleConfig<'generative-cohere', GenerativeCohereConfig> object for use when performing AI generation using the generative-cohere module.

    See the documentation for detailed usage.

    Returns

    The configuration object.

    • • (config?): ModuleConfig<"generative-cohere", undefined | GenerativeCohereConfig>

      • Parameters

        • Optional config: GenerativeCohereConfigCreate

          The configuration for the generative-cohere module.

        Returns ModuleConfig<"generative-cohere", undefined | GenerativeCohereConfig>

  • databricks: ((config) => ModuleConfig<"generative-databricks", GenerativeDatabricksConfig>)

    Create a ModuleConfig<'generative-databricks', GenerativeDatabricksConfig> object for use when performing AI generation using the generative-databricks module.

    See the documentation for detailed usage.

    Returns

    The configuration object.

    • • (config): ModuleConfig<"generative-databricks", GenerativeDatabricksConfig>

      • Parameters

        • config: GenerativeDatabricksConfig

          The configuration for the generative-databricks module.

        Returns ModuleConfig<"generative-databricks", GenerativeDatabricksConfig>

  • google: ((config?) => ModuleConfig<"generative-google", undefined | GenerativeGoogleConfig>)

    Create a ModuleConfig<'generative-google', GenerativeGoogleConfig> object for use when performing AI generation using the generative-google module.

    See the documentation for detailed usage.

    Returns

    The configuration object.

    • • (config?): ModuleConfig<"generative-google", undefined | GenerativeGoogleConfig>

      • Parameters

        • Optional config: GenerativeGoogleConfig

          The configuration for the generative-palm module.

        Returns ModuleConfig<"generative-google", undefined | GenerativeGoogleConfig>

  • openAI: ((config?) => ModuleConfig<"generative-openai", undefined | GenerativeOpenAIConfig>)

    Create a ModuleConfig<'generative-openai', GenerativeOpenAIConfig | undefined> object for use when performing AI generation using the generative-openai module.

    See the documentation for detailed usage.

    Returns

    The configuration object.

    • • (config?): ModuleConfig<"generative-openai", undefined | GenerativeOpenAIConfig>

      • Parameters

        • Optional config: GenerativeOpenAIConfigCreate

          The configuration for the generative-openai module.

        Returns ModuleConfig<"generative-openai", undefined | GenerativeOpenAIConfig>

  • palm: ((config?) => ModuleConfig<"generative-palm", undefined | GenerativeGoogleConfig>)

    Create a ModuleConfig<'generative-palm', GenerativePaLMConfig> object for use when performing AI generation using the generative-palm module.

    See the documentation for detailed usage.

    Returns

    The configuration object.

    Deprecated

    Use google instead.

    • • (config?): ModuleConfig<"generative-palm", undefined | GenerativeGoogleConfig>

      • Parameters

        • Optional config: GenerativeGoogleConfig

          The configuration for the generative-palm module.

        Returns ModuleConfig<"generative-palm", undefined | GenerativeGoogleConfig>

  • anthropic:function

    • anthropic(config?): ModuleConfig<"generative-anthropic", undefined | GenerativeAnthropicConfig>

    • Create a ModuleConfig<'generative-anthropic', GenerativeAnthropicConfig | undefined> object for use when performing AI generation using the generative-anthropic module.

      See the documentation for detailed usage.

      Parameters

      • Optional config: GenerativeAnthropicConfig

        The configuration for the generative-anthropic module.

      Returns ModuleConfig<"generative-anthropic", undefined | GenerativeAnthropicConfig>

      The configuration object.

  • anyscale:function

    • anyscale(config?): ModuleConfig<"generative-anyscale", undefined | GenerativeAnyscaleConfig>

    • Create a ModuleConfig<'generative-anyscale', GenerativeAnyscaleConfig | undefined> object for use when performing AI generation using the generative-anyscale module.

      See the documentation for detailed usage.

      Parameters

      • Optional config: GenerativeAnyscaleConfig

        The configuration for the generative-aws module.

      Returns ModuleConfig<"generative-anyscale", undefined | GenerativeAnyscaleConfig>

      The configuration object.

  • aws:function

    • aws(config): ModuleConfig<"generative-aws", GenerativeAWSConfig>

    • Create a ModuleConfig<'generative-aws', GenerativeAWSConfig> object for use when performing AI generation using the generative-aws module.

      See the documentation for detailed usage.

      Parameters

      • config: GenerativeAWSConfig

        The configuration for the generative-aws module.

      Returns ModuleConfig<"generative-aws", GenerativeAWSConfig>

      The configuration object.

  • friendliai:function

    • friendliai(config?): ModuleConfig<"generative-friendliai", undefined | GenerativeFriendliAIConfig>

    • Create a ModuleConfig<'generative-friendliai', GenerativeFriendliAIConfig | undefined> object for use when performing AI generation using the generative-friendliai module.

      See the documentation for detailed usage.

      Parameters

      • Optional config: GenerativeFriendliAIConfig

      Returns ModuleConfig<"generative-friendliai", undefined | GenerativeFriendliAIConfig>

  • mistral:function

    • mistral(config?): ModuleConfig<"generative-mistral", undefined | GenerativeMistralConfig>

    • Create a ModuleConfig<'generative-mistral', GenerativeMistralConfig | undefined> object for use when performing AI generation using the generative-mistral module.

      See the documentation for detailed usage.

      Parameters

      • Optional config: GenerativeMistralConfig

        The configuration for the generative-mistral module.

      Returns ModuleConfig<"generative-mistral", undefined | GenerativeMistralConfig>

      The configuration object.

  • ollama:function

    • ollama(config?): ModuleConfig<"generative-ollama", undefined | GenerativeOllamaConfig>

    • Create a ModuleConfig<'generative-ollama', GenerativeOllamaConfig | undefined> object for use when performing AI generation using the generative-ollama module.

      See the documentation for detailed usage.

      Parameters

      • Optional config: GenerativeOllamaConfig

        The configuration for the generative-openai module.

      Returns ModuleConfig<"generative-ollama", undefined | GenerativeOllamaConfig>

      The configuration object.

• invertedIndex: ((options) => InvertedIndexConfigUpdate)

  Create an InvertedIndexConfigUpdate object to be used when updating the configuration of the keyword searching algorithm of your collection.

  See the docs for details!

  • • (options): InvertedIndexConfigUpdate

    • Parameters

      • options: {
            bm25b?: number;
            bm25k1?: number;
            cleanupIntervalSeconds?: number;
            stopwordsAdditions?: string[];
            stopwordsPreset?: "none" | "en";
            stopwordsRemovals?: string[];
        }

        • Optional bm25b?: number

          The BM25 b parameter.

        • Optional bm25k1?: number

          The BM25 k1 parameter.

        • Optional cleanupIntervalSeconds?: number

          The interval in seconds at which the inverted index is cleaned up.

        • Optional stopwordsAdditions?: string[]

          Additional stopwords to add.

        • Optional stopwordsPreset?: "none" | "en"

          The stopwords preset to use.

        • Optional stopwordsRemovals?: string[]

          Stopwords to remove.

      Returns InvertedIndexConfigUpdate

• multiTenancy: ((options) => MultiTenancyConfigUpdate)

  Create a MultiTenancyConfigUpdate object to be used when updating the multi-tenancy configuration of Weaviate.

  Note: You cannot update a single-tenant collection to become a multi-tenant collection. You must instead create a new multi-tenant collection and migrate the data over manually.

  • • (options): MultiTenancyConfigUpdate

    • Parameters

      • options: {
            autoTenantActivation?: boolean;
            autoTenantCreation?: boolean;
        }

        • Optional autoTenantActivation?: boolean

          Whether to enable auto-tenant activation.

        • Optional autoTenantCreation?: boolean

          Whether to enable auto-tenant creation.

      Returns MultiTenancyConfigUpdate

• replication: ((options) => ReplicationConfigUpdate)

  Create a ReplicationConfigUpdate object to be used when updating the replication configuration of Weaviate.

  See the docs for more details.

  • • (options): ReplicationConfigUpdate

    • Parameters

      • options: {
            asyncEnabled?: boolean;
            deletionStrategy?: ReplicationDeletionStrategy;
            factor?: number;
        }

        • Optional asyncEnabled?: boolean

          Whether to enable asynchronous replication.

        • Optional deletionStrategy?: ReplicationDeletionStrategy

          The deletion strategy to update when replication conflicts are detected between deletes and reads.

        • Optional factor?: number

          The replication factor to update.

      Returns ReplicationConfigUpdate

• reranker: {
      cohere: ((config?) => ModuleConfig<"reranker-cohere", undefined | RerankerCohereConfig>);
      jinaai: ((config?) => ModuleConfig<"reranker-jinaai", undefined | RerankerJinaAIConfig>);
      transformers: (() => ModuleConfig<"reranker-transformers", Record<string, never>>);
      voyageAI: ((config?) => ModuleConfig<"reranker-voyageai", undefined | RerankerVoyageAIConfig>);
  }

  • cohere: ((config?) => ModuleConfig<"reranker-cohere", undefined | RerankerCohereConfig>)

    Create a ModuleConfig<'reranker-cohere', RerankerCohereConfig> object for use when reranking using the reranker-cohere module.

    See the documentation for detailed usage.

    Returns

    The configuration object.

    • • (config?): ModuleConfig<"reranker-cohere", undefined | RerankerCohereConfig>

      • Parameters

        • Optional config: RerankerCohereConfig

          The configuration for the reranker-cohere module.

        Returns ModuleConfig<"reranker-cohere", undefined | RerankerCohereConfig>

  • jinaai: ((config?) => ModuleConfig<"reranker-jinaai", undefined | RerankerJinaAIConfig>)

    Create a ModuleConfig<'reranker-jinaai', RerankerJinaAIConfig> object for use when reranking using the reranker-jinaai module.

    See the documentation for detailed usage.

    Returns

    The configuration object.

    • • (config?): ModuleConfig<"reranker-jinaai", undefined | RerankerJinaAIConfig>

      • Parameters

        • Optional config: RerankerJinaAIConfig

          The configuration for the reranker-jinaai module.

        Returns ModuleConfig<"reranker-jinaai", undefined | RerankerJinaAIConfig>

  • transformers: (() => ModuleConfig<"reranker-transformers", Record<string, never>>)

    Create a ModuleConfig<'reranker-transformers', Record<string, never>> object for use when reranking using the reranker-transformers module.

    See the documentation for detailed usage.

    Returns

    The configuration object.

    • • (): ModuleConfig<"reranker-transformers", Record<string, never>>

      • Returns ModuleConfig<"reranker-transformers", Record<string, never>>

  • voyageAI: ((config?) => ModuleConfig<"reranker-voyageai", undefined | RerankerVoyageAIConfig>)

    Create a ModuleConfig<'reranker-voyageai', RerankerVoyageAIConfig> object for use when reranking using the reranker-voyageai module.

    See the documentation for detailed usage.

    Returns

    The configuration object.

    • • (config?): ModuleConfig<"reranker-voyageai", undefined | RerankerVoyageAIConfig>

      • Parameters

        • Optional config: RerankerVoyageAIConfig

          The configuration for the reranker-voyage-ai module.

        Returns ModuleConfig<"reranker-voyageai", undefined | RerankerVoyageAIConfig>

• vectorIndex: {
      flat: ((options) => ModuleConfig<"flat", VectorIndexConfigFlatUpdate>);
      hnsw: ((options) => ModuleConfig<"hnsw", VectorIndexConfigHNSWUpdate>);
      quantizer: {
          bq: ((options?) => BQConfigUpdate);
          pq: ((options?) => PQConfigUpdate);
          sq: ((options?) => SQConfigUpdate);
      };
  }

  • flat: ((options) => ModuleConfig<"flat", VectorIndexConfigFlatUpdate>)

    Create a ModuleConfig<'flat', VectorIndexConfigFlatUpdate> object to update the configuration of the FLAT vector index.

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

    Returns

    The configuration object.

    • • (options): ModuleConfig<"flat", VectorIndexConfigFlatUpdate>

      • Parameters

        • options: {
              quantizer?: BQConfigUpdate;
              vectorCacheMaxObjects?: number;
          }

          • Optional quantizer?: BQConfigUpdate

            The quantizer configuration to use. Default is bq.

          • Optional vectorCacheMaxObjects?: number

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

        Returns ModuleConfig<"flat", VectorIndexConfigFlatUpdate>

  • hnsw: ((options) => ModuleConfig<"hnsw", VectorIndexConfigHNSWUpdate>)

    Create a ModuleConfig<'hnsw', VectorIndexConfigHNSWCreate> object to update the configuration of the HNSW vector index.

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

    Returns

    The configuration object.

    • • (options): ModuleConfig<"hnsw", VectorIndexConfigHNSWUpdate>

      • Parameters

        • options: {
              dynamicEfFactor?: number;
              dynamicEfMax?: number;
              dynamicEfMin?: number;
              ef?: number;
              filterStrategy?: VectorIndexFilterStrategy;
              flatSearchCutoff?: number;
              quantizer?: PQConfigUpdate | BQConfigUpdate | SQConfigUpdate;
              vectorCacheMaxObjects?: number;
          }

          • 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 filterStrategy?: VectorIndexFilterStrategy

            The filter strategy. Default is 'sweeping'.

          • Optional flatSearchCutoff?: number

            The flat search cutoff. Default is 40000.

          • Optional quantizer?: PQConfigUpdate | BQConfigUpdate | SQConfigUpdate

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

          • Optional vectorCacheMaxObjects?: number

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

        Returns ModuleConfig<"hnsw", VectorIndexConfigHNSWUpdate>

  • quantizer: {
        bq: ((options?) => BQConfigUpdate);
        pq: ((options?) => PQConfigUpdate);
        sq: ((options?) => SQConfigUpdate);
    }

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

    • bq: ((options?) => BQConfigUpdate)

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

      NOTE: If the vector index already has a quantizer configured, you cannot change its quantizer type; only its values. So if you want to change the quantizer type, you must recreate the collection.

      Returns

      The configuration object.

      • • (options?): BQConfigUpdate

        • Parameters

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

            • Optional cache?: boolean

              Whether to cache the quantizer.

            • Optional rescoreLimit?: number

              The new rescore limit.

          Returns BQConfigUpdate

    • pq: ((options?) => PQConfigUpdate)

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

      NOTE: If the vector index already has a quantizer configured, you cannot change its quantizer type; only its values. So if you want to change the quantizer type, you must recreate the collection.

      Returns

      The configuration object.

      • • (options?): PQConfigUpdate

        • Parameters

          • Optional options: {
                centroids?: number;
                pqEncoderDistribution?: PQEncoderDistribution;
                pqEncoderType?: PQEncoderType;
                segments?: number;
                trainingLimit?: number;
            }

            • Optional centroids?: number

              The new number of centroids.

            • Optional pqEncoderDistribution?: PQEncoderDistribution

              The new encoder distribution.

            • Optional pqEncoderType?: PQEncoderType

              The new encoder type.

            • Optional segments?: number

              The new number of segments.

            • Optional trainingLimit?: number

              The new training limit.

          Returns PQConfigUpdate

    • sq: ((options?) => SQConfigUpdate)

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

      NOTE: If the vector index already has a quantizer configured, you cannot change its quantizer type; only its values. So if you want to change the quantizer type, you must recreate the collection.

      Returns

      The configuration object.

      • • (options?): SQConfigUpdate

        • Parameters

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

            • Optional rescoreLimit?: number

              The rescore limit.

            • Optional trainingLimit?: number

              The training limit.

          Returns SQConfigUpdate

• vectorizer: {
      update: (<N, I>(options) => VectorConfigUpdate<N, I>);
  }

  • update: (<N, I>(options) => VectorConfigUpdate<N, I>)

    Create a VectorConfigUpdate object to be used when updating the named vector configuration of Weaviate.

    • • <N, I>(options): VectorConfigUpdate<N, I>

      • Type Parameters

        • N extends undefined | string
        • I extends string

        Parameters

        • options: VectorizerUpdateOptions<N, I>

          The options for the named vector.

        Returns VectorConfigUpdate<N, I>