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 InvertedIndexConfigCreate object to be used when defining 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 indexWhether to index the null state of properties.
Optional indexWhether to index the length of properties.
Optional indexWhether to index timestamps.
Optional stopwordsAdditional stopwords to add.
Optional stopwordsThe stopwords preset to use.
Optional stopwordsStopwords to remove.
Optional bm25?: { Optional b?: numberOptional k1?: numberOptional cleanupOptional indexOptional indexOptional indexOptional stopwords?: { Optional additions?: (undefined | string)[]Optional preset?: stringOptional removals?: (undefined | string)[]Create a MultiTenancyConfigCreate object to be used when defining the multi-tenancy configuration of your collection.
Optional options: { Optional autoWhether auto-tenant activation is enabled. Default is false.
Optional autoWhether auto-tenant creation is enabled. Default is false.
Optional enabled?: booleanWhether multi-tenancy is enabled. Default is true.
Optional autoOptional autoOptional enabled?: booleanCreate a VectorConfigCreate object with the vectorizer set to 'multi2multivec-jinaai'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Multi2MultivecJinaAIConfig & { The configuration options for the multi2multivec-jinaai vectorizer.
Create a multi-vector VectorConfigCreate object with the vectorizer set to 'none'.
The configuration object.
Optional opts: ConfigureNonTextMultiVectorizerOptions<N, I, "none">The configuration options for the none vectorizer.
Create a multi-vector VectorConfigCreate object with the vectorizer set to 'text2multivec-jinaai'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Text2MultiVecJinaAIConfig & { The configuration options for the text2multivec-jinaai vectorizer.
Create a ReplicationConfigCreate object to be used when defining the replication configuration of your collection.
NOTE: You can only use one of Sharding or Replication, not both.
See the docs for more details.
Optional asyncWhether asynchronous replication is enabled. Default is false.
Optional deletionThe deletion strategy when replication conflicts are detected between deletes and reads.
Optional factor?: numberThe replication factor. Default is 1.
Optional asyncOptional deletionOptional factor?: numberCreate 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 ShardingConfigCreate object to be used when defining the sharding configuration of your collection.
NOTE: You can only use one of Sharding or Replication, not both.
See the docs for more details.
Optional desiredThe desired number of physical shards.
Optional desiredThe desired number of virtual shards.
Optional virtualThe number of virtual shards per physical shard.
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.
The configuration object.
Optional opts: VectorIndexConfigDynamicCreateOptionsThe options available for configuring the dynamic vector index.
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.
The configuration object.
Optional opts: VectorIndexConfigFlatCreateOptionsThe options available for configuring the flat vector index.
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.
The configuration object.
Optional opts: VectorIndexConfigHNSWCreateOptionsThe options available for configuring the HNSW vector index.
Define the configuration for a multi-vector index.
Specify the encoding configuration for a multi-vector index.
Create an object of type MuveraEncodingConfigCreate to be used when defining the encoding configuration of a multi-vector index using MUVERA.
The object of type MuveraEncodingConfigCreate.
Optional options: { Optional dprojections?: numberThe number of projections to use. Default is undefined.
Optional ksim?: numberThe number of nearest neighbors to consider for similarity. Default is undefined.
Optional repetitions?: numberThe number of repetitions to use. Default is undefined.
Optional dprojections?: numberOptional ksim?: numberOptional repetitions?: numberOptional type?: "muvera"Create an object of type MultiVectorConfigCreate to be used when defining the configuration of a multi-vector index.
The object of type MultiVectorConfigCreate.
Optional options: { Optional aggregation?: stringThe aggregation method to use. Default is 'maxSim'.
Optional encoding?: { The encoding configuration for the multi-vector index. Default is undefined.
Optional dprojections?: numberOptional ksim?: numberOptional repetitions?: numberOptional type?: "muvera"Define the quantizer configuration to use when creating a vector index.
Create an object of type BQConfigCreate to be used when defining the quantizer configuration of a vector index.
The object of type BQConfigCreate.
Optional options: { Optional cache?: booleanWhether to cache the quantizer. Default is false.
Optional rescoreThe rescore limit. Default is 1000.
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.
The object of type UncompressedConfig.
Create an object of type PQConfigCreate to be used when defining the quantizer configuration of a vector index.
The object of type PQConfigCreate.
Optional options: { Optional bitWhether to use bit compression.
Optional centroids?: numberThe number of centroids.
Optional encoder?: { Optional distribution?: PQEncoderDistributionOptional type?: PQEncoderTypeOptional segments?: numberThe number of segments.
Optional trainingThe training limit.
Create an object of type RQConfigCreate to be used when defining the quantizer configuration of a vector index.
The object of type RQConfigCreate.
Optional options: { Optional bits?: numberNumber of bits to user per vector element.
Optional rescoreThe rescore limit. Default is 1000.
Create an object of type SQConfigCreate to be used when defining the quantizer configuration of a vector index.
The object of type SQConfigCreate.
Optional options: { Optional rescoreThe rescore limit.
Optional trainingThe training limit.
Use configure.vectors instead.
Create a VectorConfigCreate object with the vectorizer set to 'img2vec-neural'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Img2VecNeuralConfig & { The configuration options for the img2vec-neural vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-bind'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Omit<Multi2VecBindConfig, Multi2VecOmissions> & { The configuration options for the multi2vec-bind vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-clip'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Omit<Multi2VecClipConfig, Multi2VecOmissions> & { The configuration options for the multi2vec-clip vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-cohere'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Omit<Multi2VecCohereConfig, Multi2VecOmissions> & { The configuration options for the multi2vec-cohere vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-google'.
See the documentation for detailed usage.
The configuration object.
The configuration options for the multi2vec-google vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-jinaai'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Omit<Multi2VecJinaAIConfig, Multi2VecOmissions> & { The configuration options for the multi2vec-jinaai vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-palm'.
See the documentation for detailed usage.
The configuration object.
Use multi2VecGoogle instead.
The configuration options for the multi2vec-palm vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-clip'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Omit<Multi2VecVoyageAIConfig, Multi2VecOmissions> & { The configuration options for the multi2vec-voyageai vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'none'.
The configuration object.
Use selfProvided instead.
Optional opts: { The configuration options for the none vectorizer.
Optional name?: NOptional quantizer?: QuantizerConfigCreateOptional vectorCreate a VectorConfigCreate object with the vectorizer set to 'ref2vec-centroid'.
See the documentation for detailed usage.
The configuration object.
The configuration options for the ref2vec-centroid vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'none'.
The configuration object.
Optional opts: { The configuration options for the none vectorizer.
Optional name?: NOptional quantizer?: QuantizerConfigCreateOptional vectorCreate a VectorConfigCreate object with the vectorizer set to 'text2vec-aws'.
See the documentation for detailed usage.
The configuration object.
The configuration options for the text2vec-aws vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-azure-openai'.
See the documentation for detailed usage.
The configuration object.
The configuration options for the text2vec-azure-openai vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-cohere'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Text2VecCohereConfig & { The configuration options for the text2vec-cohere vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-contextionary'.
See the documentation for detailed usage.
The configuration object.
The contextionary model is old and not recommended for use. If you are looking for a local, lightweight model try the new text2vec-model2vec module instead.
Optional opts: Text2VecContextionaryConfig & { The configuration for the text2vec-contextionary vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-databricks'.
See the documentation for detailed usage.
The configuration object.
The configuration for the text2vec-databricks vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-gpt4all'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Text2VecGPT4AllConfig & { The configuration for the text2vec-gpt4all vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-google'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Text2VecGoogleConfig & { The configuration for the text2vec-palm vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-huggingface'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Text2VecHuggingFaceConfig & { The configuration for the text2vec-huggingface vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-jinaai'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Text2VecJinaAIConfig & { The configuration for the text2vec-jinaai vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-mistral'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Text2VecMistralConfig & { The configuration for the text2vec-mistral vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-model2vec'.
The configuration object.
Optional opts: Text2VecModel2Vec & { The configuration for the text2vec-model2vec vectorizer.
Optional opts: Text2VecNvidiaConfig & { Create a VectorConfigCreate object with the vectorizer set to 'text2vec-ollama'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Text2VecOllamaConfig & { The configuration for the text2vec-ollama vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-openai'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Text2VecOpenAIConfig & { The configuration for the text2vec-openai vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-palm'.
See the documentation for detailed usage.
The configuration object.
Use text2VecGoogle instead.
Optional opts: Text2VecGoogleConfig & { The configuration for the text2vec-palm vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-transformers'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Text2VecTransformersConfig & { The configuration for the text2vec-transformers vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-voyageai'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Text2VecVoyageAIConfig & { The configuration for the text2vec-voyageai vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-weaviate'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Text2VecWeaviateConfig & { The configuration for the text2vec-weaviate vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'img2vec-neural'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Img2VecNeuralConfig & { The configuration options for the img2vec-neural vectorizer.
Optional opts: Omit<Omit<Multi2VecBindConfig, Multi2VecOmissions> & { Optional opts: Omit<Omit<Multi2VecClipConfig, Multi2VecOmissions> & { Optional opts: Omit<Omit<Multi2VecCohereConfig, Multi2VecOmissions> & { Optional opts: Omit<Omit<Multi2VecJinaAIConfig, Multi2VecOmissions> & { Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-nvidia'.
See the documentation for detailed usage.
The configuration object.
Optional opts: Omit<Multi2VecNvidiaConfig, Multi2VecOmissions> & { The configuration options for the multi2vec-nvidia vectorizer.
Optional opts: Omit<Omit<Multi2VecVoyageAIConfig, Multi2VecOmissions> & { Create a VectorConfigCreate object with the vectorizer set to 'none'.
The configuration object.
Use selfProvided instead.
Optional opts: { The configuration options for the none vectorizer.
Optional name?: NOptional quantizer?: QuantizerConfigCreateOptional vectorCreate a VectorConfigCreate object with the vectorizer set to 'ref2vec-centroid'.
See the documentation for detailed usage.
The configuration object.
The configuration options for the ref2vec-centroid vectorizer.
Create a VectorConfigCreate object with the vectorizer set to 'none'.
The configuration object.
Optional opts: { The configuration options for the none vectorizer.
Optional name?: NOptional quantizer?: QuantizerConfigCreateOptional vectorOptional opts: Omit<Text2VecCohereConfig & { The contextionary model is old and not recommended for use. If you are looking for a local, lightweight model try the new text2vec-model2vec module instead.
Optional opts: Omit<Text2VecContextionaryConfig & { The text2vec-gpt4all vectorizer is deprecated and will be removed in a future release. See the docs (https://docs.weaviate.io/weaviate/model-providers) for alternatives.
Optional opts: Omit<Text2VecGPT4AllConfig & { Optional opts: Omit<Text2VecGoogleConfig & { Create a VectorConfigCreate object with the vectorizer set to 'text2vec-google' with specific options for AI studio deployments.
See the documentation for detailed usage.
The configuration object.
Optional opts: Text2VecGoogleAiStudioConfig & { The configuration for the text2vec-google vectorizer.
Optional opts: Omit<Text2VecHuggingFaceConfig & { Optional opts: Omit<Text2VecJinaAIConfig & { Optional opts: Omit<Text2VecMistralConfig & { Create a VectorConfigCreate object with the vectorizer set to 'text2vec-model2vec'.
The configuration object.
Optional opts: Text2VecModel2Vec & { The configuration for the text2vec-model2vec vectorizer.
Optional opts: Text2VecMorphConfig & { Optional opts: Omit<Text2VecNvidiaConfig & { Optional opts: Omit<Text2VecOllamaConfig & { Optional opts: Omit<Text2VecOpenAIConfig & { Optional opts: Omit<Text2VecTransformersConfig & { Optional opts: Omit<Text2VecVoyageAIConfig & { Optional opts: Omit<Text2VecWeaviateConfig & {
Create a
ModuleConfig<'generative-openai', GenerativeAzureOpenAIConfig>object for use when performing AI generation using thegenerative-openaimodule.See the documentation for detailed usage.