Create a ModuleConfig<'generative-cohere', GenerativeCohereConfig> object for use when performing AI generation using the generative-cohere module.
See the documentation for detailed usage.
Create a ModuleConfig<'generative-contextualai', GenerativeContextualAIConfig | undefined> object for use when performing AI generation using the generative-contextualai module.
See the documentation for detailed usage.
Create a ModuleConfig<'generative-databricks', GenerativeDatabricksConfig> object for use when performing AI generation using the generative-databricks module.
See the documentation for detailed usage.
Create a ModuleConfig<'generative-google', GenerativeGoogleConfig> object for use when performing AI generation using the generative-google module.
See the documentation for detailed usage.
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.
Create a ModuleConfig<'generative-palm', GenerativePaLMConfig> object for use when performing AI generation using the generative-palm module.
See the documentation for detailed usage.
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.
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.
Optionalconfig: 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.
Optionalconfig: 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.
Optionalconfig: 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.
Optionalconfig: 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.
Optionalconfig: 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.
Optionalconfig: 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!
Create a MultiTenancyConfigCreate object to be used when defining the multi-tenancy configuration of your collection.
Create a VectorConfigCreate object with the vectorizer set to 'multi2multivec-jinaai'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'multi2multivec-weaviate'.
See the documentation for detailed usage.
Create a multi-vector VectorConfigCreate object with the vectorizer set to 'none'.
Create a multi-vector VectorConfigCreate object with the vectorizer set to 'text2multivec-jinaai'.
See the documentation for detailed usage.
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.
Create a ModuleConfig<'reranker-cohere', RerankerCohereConfig> object for use when reranking using the reranker-cohere module.
See the documentation for detailed usage.
Create a ModuleConfig<'reranker-contextualai', RerankerContextualAIConfig> object for use when reranking using the reranker-contextualai module.
See the documentation for detailed usage.
Create a ModuleConfig<'reranker-jinaai', RerankerJinaAIConfig> object for use when reranking using the reranker-jinaai module.
See the documentation for detailed usage.
Create a ModuleConfig<'reranker-nvidia', RerankerNvidiaConfig> object for use when reranking using the reranker-nvidia module.
See the documentation for detailed usage.
Create a ModuleConfig<'reranker-transformers', Record<string, never>> object for use when reranking using the reranker-transformers module.
See the documentation for detailed usage.
Create a ModuleConfig<'reranker-voyageai', RerankerVoyageAIConfig> object for use when reranking using the reranker-voyageai module.
See the documentation for detailed usage.
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.
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.
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.
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.
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.
Create an object of type MultiVectorConfigCreate to be used when defining the configuration of a multi-vector index.
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.
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.
Create an object of type PQConfigCreate to be used when defining the quantizer configuration of a vector index.
Create an object of type RQConfigCreate to be used when defining the quantizer configuration of a vector index.
Create an object of type SQConfigCreate to be used when defining the quantizer configuration of a vector index.
Create a VectorConfigCreate object with the vectorizer set to 'img2vec-neural'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-bind'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-clip'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-cohere'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-google'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-jinaai'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-palm'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-clip'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'none'.
Create a VectorConfigCreate object with the vectorizer set to 'ref2vec-centroid'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'none'.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-aws'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-azure-openai'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-cohere'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-contextionary'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-databricks'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-google'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-gpt4all'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-huggingface'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-jinaai'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-mistral'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-model2vec'.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-ollama'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-openai'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-palm'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-transformers'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-voyageai'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-weaviate'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'img2vec-neural'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-nvidia'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'none'.
Create a VectorConfigCreate object with the vectorizer set to 'ref2vec-centroid'.
See the documentation for detailed usage.
Create a VectorConfigCreate object with the vectorizer set to 'none'.
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 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.
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-model2vec'.
Create a set of permissions specific to Weaviate's collection aliasing functionality.
Create a set of permissions specific to Weaviate's backup functionality.
For all collections, provide the collection argument as '*'.
Create a set of permissions specific to Weaviate's cluster endpoints.
Create a set of permissions specific to any operations involving collections.
For all collections, provide the collection argument as '*'.
Create a set of permissions specific to any operations involving objects within collections and tenants.
For all collections, provide the collection argument as '*'.
For all tenants, provide the tenant argument as '*'.
Providing arrays of collections and tenants will create permissions for each combination of collection and tenant.
E.g., data({ collection: ['A', 'B'], tenant: ['X', 'Y'] }) will create permissions for tenants X and Y in both collections A and B.
This namespace contains methods to create permissions specific to RBAC groups.
Create a set of permissions for 'oidc' groups.
This namespace contains methods to create permissions specific to nodes.
Create a set of permissions specific to reading nodes with verbosity set to minimal.
Create a set of permissions specific to reading nodes with verbosity set to verbose.
Create a set of permissions specific to shard replica movement operations.
For all collections, provide the collection argument as '*'.
For all shards, provide the shard argument as '*'.
Providing arrays of collections and shards will create permissions for each combination of collection and shard.
E.g., replicate({ collection: ['A', 'B'], shard: ['X', 'Y'] }) will create permissions for shards X and Y in both collections A and B.
Create a set of permissions specific to any operations involving roles.
Create a set of permissions specific to any operations involving tenants.
For all collections, provide the collection argument as '*'.
For all tenants, provide the tenant argument as '*'.
Providing arrays of collections and tenants will create permissions for each combination of collection and tenant.
E.g., tenants({ collection: ['A', 'B'], tenant: ['X', 'Y'] }) will create permissions for tenants X and Y in both collections A and B.
Create a set of permissions specific to any operations involving users.
Create a ModuleConfig<'generative-openai', GenerativeAzureOpenAIConfig> object for use when performing AI generation using the generative-openai module.
See the documentation for detailed usage.
Create a ModuleConfig<'generative-cohere', GenerativeCohereConfig> object for use when performing AI generation using the generative-cohere module.
See the documentation for detailed usage.
Create a ModuleConfig<'generative-contextualai', GenerativeContextualAIConfig | undefined> object for use when performing AI generation using the generative-contextualai module.
See the documentation for detailed usage.
Create a ModuleConfig<'generative-databricks', GenerativeDatabricksConfig> object for use when performing AI generation using the generative-databricks module.
See the documentation for detailed usage.
Create a ModuleConfig<'generative-google', GenerativeGoogleConfig> object for use when performing AI generation using the generative-google module.
See the documentation for detailed usage.
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.
Create a ModuleConfig<'generative-palm', GenerativePaLMConfig> object for use when performing AI generation using the generative-palm module.
See the documentation for detailed usage.
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.
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.
Optionalconfig: 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.
Optionalconfig: 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.
Optionalconfig: 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.
Optionalconfig: 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.
Optionalconfig: 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.
Optionalconfig: 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!
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.
Create a ReplicationConfigUpdate object to be used when updating the replication configuration of Weaviate.
See the docs for more details.
Create a ModuleConfig<'reranker-cohere', RerankerCohereConfig> object for use when reranking using the reranker-cohere module.
See the documentation for detailed usage.
Create a ModuleConfig<'reranker-contextualai', RerankerContextualAIConfig> object for use when reranking using the reranker-contextualai module.
See the documentation for detailed usage.
Create a ModuleConfig<'reranker-jinaai', RerankerJinaAIConfig> object for use when reranking using the reranker-jinaai module.
See the documentation for detailed usage.
Create a ModuleConfig<'reranker-nvidia', RerankerNvidiaConfig> object for use when reranking using the reranker-nvidia module.
See the documentation for detailed usage.
Create a ModuleConfig<'reranker-transformers', Record<string, never>> object for use when reranking using the reranker-transformers module.
See the documentation for detailed usage.
Create a ModuleConfig<'reranker-voyageai', RerankerVoyageAIConfig> object for use when reranking using the reranker-voyageai module.
See the documentation for detailed usage.
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.
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.
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.
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.
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.
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.
Create a VectorConfigUpdate object to be used when updating the named vector configuration of Weaviate.
Create a VectorConfigUpdate object to be used when updating the named vector configuration of Weaviate.
Create a
ModuleConfig<'generative-openai', GenerativeAzureOpenAIConfig>object for use when performing AI generation using thegenerative-openaimodule.See the documentation for detailed usage.