Const The configuration object.
The configuration for the generative-openai module.
Create a ModuleConfig<'generative-cohere', GenerativeCohereConfig> object for use when performing AI generation using the generative-cohere module.
See the documentation for detailed usage.
The configuration object.
Optional config: GenerativeCohereConfigCreateThe configuration for the generative-cohere module.
Create a ModuleConfig<'generative-databricks', GenerativeDatabricksConfig> object for use when performing AI generation using the generative-databricks module.
See the documentation for detailed usage.
The configuration object.
The configuration for the generative-databricks module.
Create a ModuleConfig<'generative-google', GenerativeGoogleConfig> object for use when performing AI generation using the generative-google module.
See the documentation for detailed usage.
The configuration object.
Optional config: GenerativeGoogleConfigThe configuration for the generative-palm module.
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.
The configuration object.
Optional config: GenerativeOpenAIConfigCreateThe configuration for the generative-openai module.
Create a ModuleConfig<'generative-palm', GenerativePaLMConfig> object for use when performing AI generation using the generative-palm module.
See the documentation for detailed usage.
The configuration object.
Use google instead.
Optional config: GenerativeGoogleConfigThe configuration for the generative-palm module.
Create a ModuleConfig<'generative-xai', GenerativeXAIConfig | undefined> object for use when performing AI generation using the generative-xai module.
See the documentation for detailed usage.
The configuration object.
Optional config: GenerativeXAIConfigThe configuration for the generative-xai module.
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.
Optional config: GenerativeAnthropicConfigThe configuration for the generative-anthropic module.
The configuration object.
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.
Optional config: GenerativeAnyscaleConfigThe configuration for the generative-aws module.
The configuration object.
Create a ModuleConfig<'generative-aws', GenerativeAWSConfig> object for use when performing AI generation using the generative-aws module.
See the documentation for detailed usage.
The configuration for the generative-aws module.
The configuration object.
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.
Optional config: GenerativeFriendliAIConfigCreate a ModuleConfig<'generative-mistral', GenerativeMistralConfig | undefined> object for use when performing AI generation using the generative-mistral module.
See the documentation for detailed usage.
Optional config: GenerativeMistralConfigThe configuration for the generative-mistral module.
The configuration object.
Create a ModuleConfig<'generative-nvidia', GenerativeNvidiaConfig | undefined> object for use when performing AI generation using the generative-mistral module.
See the documentation for detailed usage.
Optional config: GenerativeNvidiaConfigThe configuration for the generative-nvidia module.
The configuration object.
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.
Optional config: GenerativeOllamaConfigThe configuration for the generative-openai module.
The configuration object.
Create an InvertedIndexConfigUpdate object to be used when updating the configuration of the keyword searching algorithm of your collection.
See the docs for details!
Optional bm25b?: numberThe BM25 b parameter.
Optional bm25k1?: numberThe BM25 k1 parameter.
Optional cleanupThe interval in seconds at which the inverted index is cleaned up.
Optional stopwordsAdditional stopwords to add.
Optional stopwordsThe stopwords preset to use.
Optional stopwordsStopwords to remove.
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.
Optional autoWhether to enable auto-tenant activation.
Optional autoWhether to enable auto-tenant creation.
Create a ReplicationConfigUpdate object to be used when updating the replication configuration of Weaviate.
See the docs for more details.
Optional asyncWhether to enable asynchronous replication.
Optional deletionThe deletion strategy to update when replication conflicts are detected between deletes and reads.
Optional factor?: numberThe replication factor to update.
Create a ModuleConfig<'reranker-cohere', RerankerCohereConfig> object for use when reranking using the reranker-cohere module.
See the documentation for detailed usage.
The configuration object.
Optional config: RerankerCohereConfigThe configuration for the reranker-cohere module.
Create a ModuleConfig<'reranker-jinaai', RerankerJinaAIConfig> object for use when reranking using the reranker-jinaai module.
See the documentation for detailed usage.
The configuration object.
Optional config: RerankerJinaAIConfigThe configuration for the reranker-jinaai module.
Create a ModuleConfig<'reranker-nvidia', RerankerNvidiaConfig> object for use when reranking using the reranker-nvidia module.
See the documentation for detailed usage.
The configuration object.
Optional config: RerankerNvidiaConfigThe configuration for the reranker-nvidia module.
Create a ModuleConfig<'reranker-transformers', Record<string, never>> object for use when reranking using the reranker-transformers module.
See the documentation for detailed usage.
The configuration object.
Create a ModuleConfig<'reranker-voyageai', RerankerVoyageAIConfig> object for use when reranking using the reranker-voyageai module.
See the documentation for detailed usage.
The configuration object.
Optional config: RerankerVoyageAIConfigThe configuration for the reranker-voyage-ai module.
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.vectors method.
The configuration object.
Optional quantizer?: BQConfigUpdateThe quantizer configuration to use. Default is bq.
Optional vectorThe maximum number of objects to cache in the vector cache. Default is 1000000000000.
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.vectors method.
The configuration object.
Optional dynamicThe dynamic ef factor. Default is 8.
Optional dynamicThe dynamic ef max. Default is 500.
Optional dynamicThe dynamic ef min. Default is 100.
Optional ef?: numberThe ef parameter. Default is -1.
Optional filterThe filter strategy. Default is 'sweeping'.
Optional flatThe flat search cutoff. Default is 40000.
Optional quantizer?: PQConfigUpdate | BQConfigUpdate | SQConfigUpdate | RQConfigUpdateThe quantizer configuration to use. Use vectorIndex.quantizer.bq or vectorIndex.quantizer.pq to make one.
Optional vectorThe maximum number of objects to cache in the vector cache. Default is 1000000000000.
Define the quantizer configuration to use when creating a vector index.
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.
The configuration object.
Optional options: { Optional cache?: booleanWhether to cache the quantizer.
Optional rescoreThe new rescore limit.
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.
The configuration object.
Optional options: { Optional centroids?: numberThe new number of centroids.
Optional pqThe new encoder distribution.
Optional pqThe new encoder type.
Optional segments?: numberThe new number of segments.
Optional trainingThe new training limit.
Create an object of type RQConfigUpdate 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.
The configuration object.
Optional options: { Optional rescoreThe new rescore limit.
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.
The configuration object.
Optional options: { Optional rescoreThe rescore limit.
Optional trainingThe training limit.
Use vectors instead.
Create a VectorConfigUpdate object to be used when updating the named vector configuration of Weaviate.
The options for the named vector.
Create a VectorConfigUpdate object to be used when updating the named vector configuration of Weaviate.
The options for the named vector.
Create a
ModuleConfig<'generative-openai', GenerativeAzureOpenAIConfig>object for use when performing AI generation using thegenerative-openaimodule.See the documentation for detailed usage.