Variable default`Const`

default: {
 ApiKey: typeof ApiKey;
 AuthAccessTokenCredentials: typeof AuthAccessTokenCredentials;
 AuthClientCredentials: typeof AuthClientCredentials;
 AuthUserPasswordCredentials: typeof AuthUserPasswordCredentials;
 client: ((params) => Promise<WeaviateClient>);
 configGuards: {
 quantizer: typeof Quantizer;
 vectorIndex: typeof VectorIndex;
 };
 configure: {
 dataType: {
 BLOB: "blob";
 BOOLEAN: "boolean";
 BOOLEAN_ARRAY: "boolean[]";
 DATE: "date";
 DATE_ARRAY: "date[]";
 GEO_COORDINATES: "geoCoordinates";
 INT: "int";
 INT_ARRAY: "int[]";
 NUMBER: "number";
 NUMBER_ARRAY: "number[]";
 OBJECT: "object";
 OBJECT_ARRAY: "object[]";
 PHONE_NUMBER: "phoneNumber";
 TEXT: "text";
 TEXT_ARRAY: "text[]";
 UUID: "uuid";
 UUID_ARRAY: "uuid[]";
 };
 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>;
 };
 invertedIndex: ((options) => {
 bm25?: {
 b?: number;
 k1?: number;
 };
 cleanupIntervalSeconds?: number;
 indexNullState?: boolean;
 indexPropertyLength?: boolean;
 indexTimestamps?: boolean;
 stopwords?: {
 additions?: (undefined | string)[];
 preset?: string;
 removals?: (undefined | string)[];
 };
 });
 multiTenancy: ((options?) => {
 autoTenantActivation?: boolean;
 autoTenantCreation?: boolean;
 enabled?: boolean;
 });
 replication: ((options) => {
 asyncEnabled?: boolean;
 deletionStrategy?: ReplicationDeletionStrategy;
 factor?: number;
 });
 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>);
 };
 sharding: ((options) => ShardingConfigCreate);
 tokenization: {
 FIELD: "field";
 GSE: "gse";
 KAGOME_KR: "kagome_kr";
 LOWERCASE: "lowercase";
 TRIGRAM: "trigram";
 WHITESPACE: "whitespace";
 WORD: "word";
 };
 vectorDistances: {
 COSINE: "cosine";
 DOT: "dot";
 HAMMING: "hamming";
 L2_SQUARED: "l2-squared";
 };
 vectorIndex: {
 dynamic: ((opts?) => ModuleConfig<"dynamic", undefined | {
 distance?: VectorDistance;
 flat?: {
 distance?: VectorDistance;
 quantizer?: {
 cache?: ...;
 rescoreLimit?: ...;
 type?: ...;
 };
 type?: "flat";
 vectorCacheMaxObjects?: number;
 };
 hnsw?: {
 cleanupIntervalSeconds?: number;
 distance?: VectorDistance;
 dynamicEfFactor?: number;
 dynamicEfMax?: number;
 dynamicEfMin?: number;
 ef?: number;
 efConstruction?: number;
 filterStrategy?: VectorIndexFilterStrategy;
 flatSearchCutoff?: number;
 maxConnections?: number;
 quantizer?: {
 cache?: ...;
 rescoreLimit?: ...;
 type?: ...;
 } | {
 bitCompression?: ...;
 centroids?: ...;
 encoder?: ...;
 segments?: ...;
 trainingLimit?: ...;
 type?: ...;
 } | {
 rescoreLimit?: ...;
 trainingLimit?: ...;
 type?: ...;
 };
 skip?: boolean;
 type?: "hnsw";
 vectorCacheMaxObjects?: number;
 };
 threshold?: number;
 type?: "dynamic";
 }>);
 flat: ((opts?) => ModuleConfig<"flat", undefined | {
 distance?: VectorDistance;
 quantizer?: {
 cache?: boolean;
 rescoreLimit?: number;
 type?: "bq";
 };
 type?: "flat";
 vectorCacheMaxObjects?: number;
 }>);
 hnsw: ((opts?) => ModuleConfig<"hnsw", undefined | {
 cleanupIntervalSeconds?: number;
 distance?: VectorDistance;
 dynamicEfFactor?: number;
 dynamicEfMax?: number;
 dynamicEfMin?: number;
 ef?: number;
 efConstruction?: number;
 filterStrategy?: VectorIndexFilterStrategy;
 flatSearchCutoff?: number;
 maxConnections?: number;
 quantizer?: {
 cache?: boolean;
 rescoreLimit?: number;
 type?: "bq";
 } | {
 bitCompression?: boolean;
 centroids?: number;
 encoder?: {
 distribution?: ...;
 type?: ...;
 };
 segments?: number;
 trainingLimit?: number;
 type?: "pq";
 } | {
 rescoreLimit?: number;
 trainingLimit?: number;
 type?: "sq";
 };
 skip?: boolean;
 type?: "hnsw";
 vectorCacheMaxObjects?: number;
 }>);
 quantizer: {
 bq: ((options?) => QuantizerRecursivePartial<BQConfig>);
 pq: ((options?) => QuantizerRecursivePartial<PQConfig>);
 sq: ((options?) => QuantizerRecursivePartial<SQConfig>);
 };
 };
 vectorizer: {
 img2VecNeural: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "img2vec-neural">);
 multi2VecBind: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-bind">);
 multi2VecClip: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-clip">);
 multi2VecCohere: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-cohere">);
 multi2VecGoogle: (<N, I>(opts) => VectorConfigCreate<never, N, I, "multi2vec-google">);
 multi2VecJinaAI: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-jinaai">);
 multi2VecPalm: (<N, I>(opts) => VectorConfigCreate<never, N, I, "multi2vec-palm">);
 multi2VecVoyageAI: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-voyageai">);
 none: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "none">);
 ref2VecCentroid: (<N, I>(opts) => VectorConfigCreate<never, N, I, "ref2vec-centroid">);
 text2VecAWS: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-aws">);
 text2VecAzureOpenAI: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-azure-openai">);
 text2VecCohere: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-cohere">);
 text2VecContextionary: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-contextionary">);
 text2VecDatabricks: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-databricks">);
 text2VecGPT4All: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-gpt4all">);
 text2VecGoogle: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-google">);
 text2VecHuggingFace: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-huggingface">);
 text2VecJinaAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-jinaai">);
 text2VecMistral: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-mistral">);
 text2VecOllama: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-ollama">);
 text2VecOpenAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-openai">);
 text2VecPalm: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-palm">);
 text2VecTransformers: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-transformers">);
 text2VecVoyageAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-voyageai">);
 text2VecWeaviate: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-weaviate">);
 };
 };
 connectToCustom: ((options) => Promise<WeaviateClient>);
 connectToLocal: ((options?) => Promise<WeaviateClient>);
 connectToWCD: ((clusterURL, options?) => Promise<WeaviateClient>);
 connectToWCS: ((clusterURL, options?) => Promise<WeaviateClient>);
 connectToWeaviateCloud: ((clusterURL, options?) => Promise<WeaviateClient>);
 permissions: {
 backup: ((args) => BackupsPermission[]);
 cluster: ((args) => ClusterPermission[]);
 collections: ((args) => CollectionsPermission[]);
 data: ((args) => DataPermission[]);
 nodes: ((args) => NodesPermission[]);
 roles: ((args) => RolesPermission[]);
 };
 reconfigure: {
 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>;
 };
 invertedIndex: ((options) => InvertedIndexConfigUpdate);
 multiTenancy: ((options) => MultiTenancyConfigUpdate);
 replication: ((options) => 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>);
 };
 vectorIndex: {
 flat: ((options) => ModuleConfig<"flat", VectorIndexConfigFlatUpdate>);
 hnsw: ((options) => ModuleConfig<"hnsw", VectorIndexConfigHNSWUpdate>);
 quantizer: {
 bq: ((options?) => BQConfigUpdate);
 pq: ((options?) => PQConfigUpdate);
 sq: ((options?) => SQConfigUpdate);
 };
 };
 vectorizer: {
 update: (<N, I>(options) => VectorConfigUpdate<N, I>);
 };
 };
} = ...

Type declaration

ApiKey: typeof ApiKey
AuthAccessTokenCredentials: typeof AuthAccessTokenCredentials
AuthClientCredentials: typeof AuthClientCredentials
AuthUserPasswordCredentials: typeof AuthUserPasswordCredentials
client: ((params) => Promise<WeaviateClient>)
- - (params): Promise<WeaviateClient>
 - Parameters
 - params: ClientParams
 Returns Promise<WeaviateClient>
configGuards: {
quantizer: typeof Quantizer;
vectorIndex: typeof VectorIndex;
}
- quantizer: typeof Quantizer
- vectorIndex: typeof VectorIndex
configure: {
 dataType: {
 BLOB: "blob";
 BOOLEAN: "boolean";
 BOOLEAN_ARRAY: "boolean[]";
 DATE: "date";
 DATE_ARRAY: "date[]";
 GEO_COORDINATES: "geoCoordinates";
 INT: "int";
 INT_ARRAY: "int[]";
 NUMBER: "number";
 NUMBER_ARRAY: "number[]";
 OBJECT: "object";
 OBJECT_ARRAY: "object[]";
 PHONE_NUMBER: "phoneNumber";
 TEXT: "text";
 TEXT_ARRAY: "text[]";
 UUID: "uuid";
 UUID_ARRAY: "uuid[]";
 };
 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>;
 };
 invertedIndex: ((options) => {
 bm25?: {
 b?: number;
 k1?: number;
 };
 cleanupIntervalSeconds?: number;
 indexNullState?: boolean;
 indexPropertyLength?: boolean;
 indexTimestamps?: boolean;
 stopwords?: {
 additions?: (undefined | string)[];
 preset?: string;
 removals?: (undefined | string)[];
 };
 });
 multiTenancy: ((options?) => {
 autoTenantActivation?: boolean;
 autoTenantCreation?: boolean;
 enabled?: boolean;
 });
 replication: ((options) => {
 asyncEnabled?: boolean;
 deletionStrategy?: ReplicationDeletionStrategy;
 factor?: number;
 });
 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>);
 };
 sharding: ((options) => ShardingConfigCreate);
 tokenization: {
 FIELD: "field";
 GSE: "gse";
 KAGOME_KR: "kagome_kr";
 LOWERCASE: "lowercase";
 TRIGRAM: "trigram";
 WHITESPACE: "whitespace";
 WORD: "word";
 };
 vectorDistances: {
 COSINE: "cosine";
 DOT: "dot";
 HAMMING: "hamming";
 L2_SQUARED: "l2-squared";
 };
 vectorIndex: {
 dynamic: ((opts?) => ModuleConfig<"dynamic", undefined | {
 distance?: VectorDistance;
 flat?: {
 distance?: VectorDistance;
 quantizer?: {
 cache?: ...;
 rescoreLimit?: ...;
 type?: ...;
 };
 type?: "flat";
 vectorCacheMaxObjects?: number;
 };
 hnsw?: {
 cleanupIntervalSeconds?: number;
 distance?: VectorDistance;
 dynamicEfFactor?: number;
 dynamicEfMax?: number;
 dynamicEfMin?: number;
 ef?: number;
 efConstruction?: number;
 filterStrategy?: VectorIndexFilterStrategy;
 flatSearchCutoff?: number;
 maxConnections?: number;
 quantizer?: {
 cache?: ...;
 rescoreLimit?: ...;
 type?: ...;
 } | {
 bitCompression?: ...;
 centroids?: ...;
 encoder?: ...;
 segments?: ...;
 trainingLimit?: ...;
 type?: ...;
 } | {
 rescoreLimit?: ...;
 trainingLimit?: ...;
 type?: ...;
 };
 skip?: boolean;
 type?: "hnsw";
 vectorCacheMaxObjects?: number;
 };
 threshold?: number;
 type?: "dynamic";
 }>);
 flat: ((opts?) => ModuleConfig<"flat", undefined | {
 distance?: VectorDistance;
 quantizer?: {
 cache?: boolean;
 rescoreLimit?: number;
 type?: "bq";
 };
 type?: "flat";
 vectorCacheMaxObjects?: number;
 }>);
 hnsw: ((opts?) => ModuleConfig<"hnsw", undefined | {
 cleanupIntervalSeconds?: number;
 distance?: VectorDistance;
 dynamicEfFactor?: number;
 dynamicEfMax?: number;
 dynamicEfMin?: number;
 ef?: number;
 efConstruction?: number;
 filterStrategy?: VectorIndexFilterStrategy;
 flatSearchCutoff?: number;
 maxConnections?: number;
 quantizer?: {
 cache?: boolean;
 rescoreLimit?: number;
 type?: "bq";
 } | {
 bitCompression?: boolean;
 centroids?: number;
 encoder?: {
 distribution?: ...;
 type?: ...;
 };
 segments?: number;
 trainingLimit?: number;
 type?: "pq";
 } | {
 rescoreLimit?: number;
 trainingLimit?: number;
 type?: "sq";
 };
 skip?: boolean;
 type?: "hnsw";
 vectorCacheMaxObjects?: number;
 }>);
 quantizer: {
 bq: ((options?) => QuantizerRecursivePartial<BQConfig>);
 pq: ((options?) => QuantizerRecursivePartial<PQConfig>);
 sq: ((options?) => QuantizerRecursivePartial<SQConfig>);
 };
 };
 vectorizer: {
 img2VecNeural: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "img2vec-neural">);
 multi2VecBind: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-bind">);
 multi2VecClip: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-clip">);
 multi2VecCohere: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-cohere">);
 multi2VecGoogle: (<N, I>(opts) => VectorConfigCreate<never, N, I, "multi2vec-google">);
 multi2VecJinaAI: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-jinaai">);
 multi2VecPalm: (<N, I>(opts) => VectorConfigCreate<never, N, I, "multi2vec-palm">);
 multi2VecVoyageAI: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-voyageai">);
 none: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "none">);
 ref2VecCentroid: (<N, I>(opts) => VectorConfigCreate<never, N, I, "ref2vec-centroid">);
 text2VecAWS: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-aws">);
 text2VecAzureOpenAI: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-azure-openai">);
 text2VecCohere: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-cohere">);
 text2VecContextionary: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-contextionary">);
 text2VecDatabricks: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-databricks">);
 text2VecGPT4All: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-gpt4all">);
 text2VecGoogle: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-google">);
 text2VecHuggingFace: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-huggingface">);
 text2VecJinaAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-jinaai">);
 text2VecMistral: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-mistral">);
 text2VecOllama: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-ollama">);
 text2VecOpenAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-openai">);
 text2VecPalm: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-palm">);
 text2VecTransformers: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-transformers">);
 text2VecVoyageAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-voyageai">);
 text2VecWeaviate: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-weaviate">);
 };
}
- dataType: {
 BLOB: "blob";
 BOOLEAN: "boolean";
 BOOLEAN_ARRAY: "boolean[]";
 DATE: "date";
 DATE_ARRAY: "date[]";
 GEO_COORDINATES: "geoCoordinates";
 INT: "int";
 INT_ARRAY: "int[]";
 NUMBER: "number";
 NUMBER_ARRAY: "number[]";
 OBJECT: "object";
 OBJECT_ARRAY: "object[]";
 PHONE_NUMBER: "phoneNumber";
 TEXT: "text";
 TEXT_ARRAY: "text[]";
 UUID: "uuid";
 UUID_ARRAY: "uuid[]";
 }
 - BLOB: "blob"
 - BOOLEAN: "boolean"
 - BOOLEAN_ARRAY: "boolean[]"
 - DATE: "date"
 - DATE_ARRAY: "date[]"
 - GEO_COORDINATES: "geoCoordinates"
 - INT: "int"
 - INT_ARRAY: "int[]"
 - NUMBER: "number"
 - NUMBER_ARRAY: "number[]"
 - OBJECT: "object"
 - OBJECT_ARRAY: "object[]"
 - PHONE_NUMBER: "phoneNumber"
 - TEXT: "text"
 - TEXT_ARRAY: "text[]"
 - UUID: "uuid"
 - UUID_ARRAY: "uuid[]"
- 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.
 Defined in collections/configure/generative.ts:39
 - 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.
 Defined in collections/configure/generative.ts:55
 - 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.
 Defined in collections/configure/generative.ts:71
 - 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>
 Defined in collections/configure/generative.ts:148
 - 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.
 Defined in collections/configure/generative.ts:164
 - 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.
 Defined in collections/configure/generative.ts:180
- invertedIndex: ((options) => {
 bm25?: {
 b?: number;
 k1?: number;
 };
 cleanupIntervalSeconds?: number;
 indexNullState?: boolean;
 indexPropertyLength?: boolean;
 indexTimestamps?: boolean;
 stopwords?: {
 additions?: (undefined | string)[];
 preset?: string;
 removals?: (undefined | string)[];
 };
 })
 Create an InvertedIndexConfigCreate object to be used when defining the configuration of the keyword searching algorithm of your collection.
 
 See the docs for details!
 - - (options): {
 bm25?: {
 b?: number;
 k1?: number;
 };
 cleanupIntervalSeconds?: number;
 indexNullState?: boolean;
 indexPropertyLength?: boolean;
 indexTimestamps?: boolean;
 stopwords?: {
 additions?: (undefined | string)[];
 preset?: string;
 removals?: (undefined | string)[];
 };
 }
 - Parameters
 options: {
 bm25b?: number;
 bm25k1?: number;
 cleanupIntervalSeconds?: number;
 indexNullState?: boolean;
 indexPropertyLength?: boolean;
 indexTimestamps?: boolean;
 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 indexNullState?: boolean
 Whether to index the null state of properties.
 
 Optional indexPropertyLength?: boolean
 Whether to index the length of properties.
 
 Optional indexTimestamps?: boolean
 Whether to index timestamps.
 
 Optional stopwordsAdditions?: string[]
 Additional stopwords to add.
 
 Optional stopwordsPreset?: "none" | "en"
 The stopwords preset to use.
 
 Optional stopwordsRemovals?: string[]
 Stopwords to remove.
 Returns {
 bm25?: {
 b?: number;
 k1?: number;
 };
 cleanupIntervalSeconds?: number;
 indexNullState?: boolean;
 indexPropertyLength?: boolean;
 indexTimestamps?: boolean;
 stopwords?: {
 additions?: (undefined | string)[];
 preset?: string;
 removals?: (undefined | string)[];
 };
 }
 - Optional bm25?: {
 b?: number;
 k1?: number;
 }
 Optional b?: number
 Optional k1?: number
 - Optional cleanupIntervalSeconds?: number
 - Optional indexNullState?: boolean
 - Optional indexPropertyLength?: boolean
 - Optional indexTimestamps?: boolean
 - Optional stopwords?: {
 additions?: (undefined | string)[];
 preset?: string;
 removals?: (undefined | string)[];
 }
 Optional additions?: (undefined | string)[]
 Optional preset?: string
 Optional removals?: (undefined | string)[]
- multiTenancy: ((options?) => {
 autoTenantActivation?: boolean;
 autoTenantCreation?: boolean;
 enabled?: boolean;
 })
 Create a MultiTenancyConfigCreate object to be used when defining the multi-tenancy configuration of your collection.
 - - (options?): {
 autoTenantActivation?: boolean;
 autoTenantCreation?: boolean;
 enabled?: boolean;
 }
 - Parameters
 Optional options: {
 autoTenantActivation?: boolean;
 autoTenantCreation?: boolean;
 enabled?: boolean;
 }
 Optional autoTenantActivation?: boolean
 Whether auto-tenant activation is enabled. Default is false.
 
 Optional autoTenantCreation?: boolean
 Whether auto-tenant creation is enabled. Default is false.
 
 Optional enabled?: boolean
 Whether multi-tenancy is enabled. Default is true.
 Returns {
 autoTenantActivation?: boolean;
 autoTenantCreation?: boolean;
 enabled?: boolean;
 }
 - Optional autoTenantActivation?: boolean
 - Optional autoTenantCreation?: boolean
 - Optional enabled?: boolean
- replication: ((options) => {
 asyncEnabled?: boolean;
 deletionStrategy?: ReplicationDeletionStrategy;
 factor?: number;
 })
 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.
 - - (options): {
 asyncEnabled?: boolean;
 deletionStrategy?: ReplicationDeletionStrategy;
 factor?: number;
 }
 - Parameters
 options: {
 asyncEnabled?: boolean;
 deletionStrategy?: ReplicationDeletionStrategy;
 factor?: number;
 }
 Optional asyncEnabled?: boolean
 Whether asynchronous replication is enabled. Default is false.
 
 Optional deletionStrategy?: ReplicationDeletionStrategy
 The deletion strategy when replication conflicts are detected between deletes and reads.
 
 Optional factor?: number
 The replication factor. Default is 1.
 Returns {
 asyncEnabled?: boolean;
 deletionStrategy?: ReplicationDeletionStrategy;
 factor?: number;
 }
 - Optional asyncEnabled?: boolean
 - Optional deletionStrategy?: ReplicationDeletionStrategy
 - Optional factor?: number
- 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>
- sharding: ((options) => ShardingConfigCreate)
 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.
 - - (options): ShardingConfigCreate
 - Parameters
 options: {
 desiredCount?: number;
 desiredVirtualCount?: number;
 virtualPerPhysical?: number;
 }
 Optional desiredCount?: number
 The desired number of physical shards.
 
 Optional desiredVirtualCount?: number
 The desired number of virtual shards.
 
 Optional virtualPerPhysical?: number
 The number of virtual shards per physical shard.
 Returns ShardingConfigCreate
- tokenization: {
 FIELD: "field";
 GSE: "gse";
 KAGOME_KR: "kagome_kr";
 LOWERCASE: "lowercase";
 TRIGRAM: "trigram";
 WHITESPACE: "whitespace";
 WORD: "word";
 }
 - FIELD: "field"
 - GSE: "gse"
 - KAGOME_KR: "kagome_kr"
 - LOWERCASE: "lowercase"
 - TRIGRAM: "trigram"
 - WHITESPACE: "whitespace"
 - WORD: "word"
- vectorDistances: {
 COSINE: "cosine";
 DOT: "dot";
 HAMMING: "hamming";
 L2_SQUARED: "l2-squared";
 }
 - COSINE: "cosine"
 - DOT: "dot"
 - HAMMING: "hamming"
 - L2_SQUARED: "l2-squared"
- vectorIndex: {
 dynamic: ((opts?) => ModuleConfig<"dynamic", undefined | {
 distance?: VectorDistance;
 flat?: {
 distance?: VectorDistance;
 quantizer?: {
 cache?: ...;
 rescoreLimit?: ...;
 type?: ...;
 };
 type?: "flat";
 vectorCacheMaxObjects?: number;
 };
 hnsw?: {
 cleanupIntervalSeconds?: number;
 distance?: VectorDistance;
 dynamicEfFactor?: number;
 dynamicEfMax?: number;
 dynamicEfMin?: number;
 ef?: number;
 efConstruction?: number;
 filterStrategy?: VectorIndexFilterStrategy;
 flatSearchCutoff?: number;
 maxConnections?: number;
 quantizer?: {
 cache?: ...;
 rescoreLimit?: ...;
 type?: ...;
 } | {
 bitCompression?: ...;
 centroids?: ...;
 encoder?: ...;
 segments?: ...;
 trainingLimit?: ...;
 type?: ...;
 } | {
 rescoreLimit?: ...;
 trainingLimit?: ...;
 type?: ...;
 };
 skip?: boolean;
 type?: "hnsw";
 vectorCacheMaxObjects?: number;
 };
 threshold?: number;
 type?: "dynamic";
 }>);
 flat: ((opts?) => ModuleConfig<"flat", undefined | {
 distance?: VectorDistance;
 quantizer?: {
 cache?: boolean;
 rescoreLimit?: number;
 type?: "bq";
 };
 type?: "flat";
 vectorCacheMaxObjects?: number;
 }>);
 hnsw: ((opts?) => ModuleConfig<"hnsw", undefined | {
 cleanupIntervalSeconds?: number;
 distance?: VectorDistance;
 dynamicEfFactor?: number;
 dynamicEfMax?: number;
 dynamicEfMin?: number;
 ef?: number;
 efConstruction?: number;
 filterStrategy?: VectorIndexFilterStrategy;
 flatSearchCutoff?: number;
 maxConnections?: number;
 quantizer?: {
 cache?: boolean;
 rescoreLimit?: number;
 type?: "bq";
 } | {
 bitCompression?: boolean;
 centroids?: number;
 encoder?: {
 distribution?: ...;
 type?: ...;
 };
 segments?: number;
 trainingLimit?: number;
 type?: "pq";
 } | {
 rescoreLimit?: number;
 trainingLimit?: number;
 type?: "sq";
 };
 skip?: boolean;
 type?: "hnsw";
 vectorCacheMaxObjects?: number;
 }>);
 quantizer: {
 bq: ((options?) => QuantizerRecursivePartial<BQConfig>);
 pq: ((options?) => QuantizerRecursivePartial<PQConfig>);
 sq: ((options?) => QuantizerRecursivePartial<SQConfig>);
 };
 }
 - dynamic: ((opts?) => ModuleConfig<"dynamic", undefined | {
 distance?: VectorDistance;
 flat?: {
 distance?: VectorDistance;
 quantizer?: {
 cache?: ...;
 rescoreLimit?: ...;
 type?: ...;
 };
 type?: "flat";
 vectorCacheMaxObjects?: number;
 };
 hnsw?: {
 cleanupIntervalSeconds?: number;
 distance?: VectorDistance;
 dynamicEfFactor?: number;
 dynamicEfMax?: number;
 dynamicEfMin?: number;
 ef?: number;
 efConstruction?: number;
 filterStrategy?: VectorIndexFilterStrategy;
 flatSearchCutoff?: number;
 maxConnections?: number;
 quantizer?: {
 cache?: ...;
 rescoreLimit?: ...;
 type?: ...;
 } | {
 bitCompression?: ...;
 centroids?: ...;
 encoder?: ...;
 segments?: ...;
 trainingLimit?: ...;
 type?: ...;
 } | {
 rescoreLimit?: ...;
 trainingLimit?: ...;
 type?: ...;
 };
 skip?: boolean;
 type?: "hnsw";
 vectorCacheMaxObjects?: number;
 };
 threshold?: number;
 type?: "dynamic";
 }>)
 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.vectorizer method.
 
 Returns
 The configuration object.
 - - (opts?): ModuleConfig<"dynamic", undefined | {
 distance?: VectorDistance;
 flat?: {
 distance?: VectorDistance;
 quantizer?: {
 cache?: ...;
 rescoreLimit?: ...;
 type?: ...;
 };
 type?: "flat";
 vectorCacheMaxObjects?: number;
 };
 hnsw?: {
 cleanupIntervalSeconds?: number;
 distance?: VectorDistance;
 dynamicEfFactor?: number;
 dynamicEfMax?: number;
 dynamicEfMin?: number;
 ef?: number;
 efConstruction?: number;
 filterStrategy?: VectorIndexFilterStrategy;
 flatSearchCutoff?: number;
 maxConnections?: number;
 quantizer?: {
 cache?: ...;
 rescoreLimit?: ...;
 type?: ...;
 } | {
 bitCompression?: ...;
 centroids?: ...;
 encoder?: ...;
 segments?: ...;
 trainingLimit?: ...;
 type?: ...;
 } | {
 rescoreLimit?: ...;
 trainingLimit?: ...;
 type?: ...;
 };
 skip?: boolean;
 type?: "hnsw";
 vectorCacheMaxObjects?: number;
 };
 threshold?: number;
 type?: "dynamic";
 }>
 - Parameters
 Optional opts: VectorIndexConfigDynamicCreateOptions
 The options available for configuring the dynamic vector index.
 
 Returns ModuleConfig<"dynamic", undefined | {
 distance?: VectorDistance;
 flat?: {
 distance?: VectorDistance;
 quantizer?: {
 cache?: ...;
 rescoreLimit?: ...;
 type?: ...;
 };
 type?: "flat";
 vectorCacheMaxObjects?: number;
 };
 hnsw?: {
 cleanupIntervalSeconds?: number;
 distance?: VectorDistance;
 dynamicEfFactor?: number;
 dynamicEfMax?: number;
 dynamicEfMin?: number;
 ef?: number;
 efConstruction?: number;
 filterStrategy?: VectorIndexFilterStrategy;
 flatSearchCutoff?: number;
 maxConnections?: number;
 quantizer?: {
 cache?: ...;
 rescoreLimit?: ...;
 type?: ...;
 } | {
 bitCompression?: ...;
 centroids?: ...;
 encoder?: ...;
 segments?: ...;
 trainingLimit?: ...;
 type?: ...;
 } | {
 rescoreLimit?: ...;
 trainingLimit?: ...;
 type?: ...;
 };
 skip?: boolean;
 type?: "hnsw";
 vectorCacheMaxObjects?: number;
 };
 threshold?: number;
 type?: "dynamic";
 }>
 - flat: ((opts?) => ModuleConfig<"flat", undefined | {
 distance?: VectorDistance;
 quantizer?: {
 cache?: boolean;
 rescoreLimit?: number;
 type?: "bq";
 };
 type?: "flat";
 vectorCacheMaxObjects?: number;
 }>)
 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.vectorizer method.
 
 Returns
 The configuration object.
 - - (opts?): ModuleConfig<"flat", undefined | {
 distance?: VectorDistance;
 quantizer?: {
 cache?: boolean;
 rescoreLimit?: number;
 type?: "bq";
 };
 type?: "flat";
 vectorCacheMaxObjects?: number;
 }>
 - Parameters
 Optional opts: VectorIndexConfigFlatCreateOptions
 The options available for configuring the flat vector index.
 
 Returns ModuleConfig<"flat", undefined | {
 distance?: VectorDistance;
 quantizer?: {
 cache?: boolean;
 rescoreLimit?: number;
 type?: "bq";
 };
 type?: "flat";
 vectorCacheMaxObjects?: number;
 }>
 - hnsw: ((opts?) => ModuleConfig<"hnsw", undefined | {
 cleanupIntervalSeconds?: number;
 distance?: VectorDistance;
 dynamicEfFactor?: number;
 dynamicEfMax?: number;
 dynamicEfMin?: number;
 ef?: number;
 efConstruction?: number;
 filterStrategy?: VectorIndexFilterStrategy;
 flatSearchCutoff?: number;
 maxConnections?: number;
 quantizer?: {
 cache?: boolean;
 rescoreLimit?: number;
 type?: "bq";
 } | {
 bitCompression?: boolean;
 centroids?: number;
 encoder?: {
 distribution?: ...;
 type?: ...;
 };
 segments?: number;
 trainingLimit?: number;
 type?: "pq";
 } | {
 rescoreLimit?: number;
 trainingLimit?: number;
 type?: "sq";
 };
 skip?: boolean;
 type?: "hnsw";
 vectorCacheMaxObjects?: number;
 }>)
 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.vectorizer method.
 
 Returns
 The configuration object.
 - - (opts?): ModuleConfig<"hnsw", undefined | {
 cleanupIntervalSeconds?: number;
 distance?: VectorDistance;
 dynamicEfFactor?: number;
 dynamicEfMax?: number;
 dynamicEfMin?: number;
 ef?: number;
 efConstruction?: number;
 filterStrategy?: VectorIndexFilterStrategy;
 flatSearchCutoff?: number;
 maxConnections?: number;
 quantizer?: {
 cache?: boolean;
 rescoreLimit?: number;
 type?: "bq";
 } | {
 bitCompression?: boolean;
 centroids?: number;
 encoder?: {
 distribution?: ...;
 type?: ...;
 };
 segments?: number;
 trainingLimit?: number;
 type?: "pq";
 } | {
 rescoreLimit?: number;
 trainingLimit?: number;
 type?: "sq";
 };
 skip?: boolean;
 type?: "hnsw";
 vectorCacheMaxObjects?: number;
 }>
 - Parameters
 Optional opts: VectorIndexConfigHNSWCreateOptions
 The options available for configuring the HNSW vector index.
 
 Returns ModuleConfig<"hnsw", undefined | {
 cleanupIntervalSeconds?: number;
 distance?: VectorDistance;
 dynamicEfFactor?: number;
 dynamicEfMax?: number;
 dynamicEfMin?: number;
 ef?: number;
 efConstruction?: number;
 filterStrategy?: VectorIndexFilterStrategy;
 flatSearchCutoff?: number;
 maxConnections?: number;
 quantizer?: {
 cache?: boolean;
 rescoreLimit?: number;
 type?: "bq";
 } | {
 bitCompression?: boolean;
 centroids?: number;
 encoder?: {
 distribution?: ...;
 type?: ...;
 };
 segments?: number;
 trainingLimit?: number;
 type?: "pq";
 } | {
 rescoreLimit?: number;
 trainingLimit?: number;
 type?: "sq";
 };
 skip?: boolean;
 type?: "hnsw";
 vectorCacheMaxObjects?: number;
 }>
 - quantizer: {
 bq: ((options?) => QuantizerRecursivePartial<BQConfig>);
 pq: ((options?) => QuantizerRecursivePartial<PQConfig>);
 sq: ((options?) => QuantizerRecursivePartial<SQConfig>);
 }
 Define the quantizer configuration to use when creating a vector index.
 - bq: ((options?) => QuantizerRecursivePartial<BQConfig>)
 Create an object of type BQConfigCreate to be used when defining the quantizer configuration of a vector index.
 
 Returns
 The object of type BQConfigCreate.
 - (options?): QuantizerRecursivePartial<BQConfig>
 Parameters
 Optional options: {
 cache?: boolean;
 rescoreLimit?: number;
 }
 Optional cache?: boolean
 Whether to cache the quantizer. Default is false.
 
 Optional rescoreLimit?: number
 The rescore limit. Default is 1000.
 
 Returns QuantizerRecursivePartial<BQConfig>
 - pq: ((options?) => QuantizerRecursivePartial<PQConfig>)
 Create an object of type PQConfigCreate to be used when defining the quantizer configuration of a vector index.
 
 Returns
 The object of type PQConfigCreate.
 - (options?): QuantizerRecursivePartial<PQConfig>
 Parameters
 Optional options: {
 bitCompression?: boolean;
 centroids?: number;
 encoder?: {
 distribution?: PQEncoderDistribution;
 type?: PQEncoderType;
 };
 segments?: number;
 trainingLimit?: number;
 }
 Optional bitCompression?: boolean
 Whether to use bit compression.
 
 Optional centroids?: number
 The number of centroids[.
 
 Optional encoder?: {
 distribution?: PQEncoderDistribution;
 type?: PQEncoderType;
 }
 Optional distribution?: PQEncoderDistribution
 Optional type?: PQEncoderType
 Optional segments?: number
 The number of segments.
 
 Optional trainingLimit?: number
 The training limit.
 
 Returns QuantizerRecursivePartial<PQConfig>
 - sq: ((options?) => QuantizerRecursivePartial<SQConfig>)
 Create an object of type SQConfigCreate to be used when defining the quantizer configuration of a vector index.
 
 Returns
 The object of type SQConfigCreate.
 - (options?): QuantizerRecursivePartial<SQConfig>
 Parameters
 Optional options: {
 rescoreLimit?: number;
 trainingLimit?: number;
 }
 Optional rescoreLimit?: number
 The rescore limit.
 
 Optional trainingLimit?: number
 The training limit.
 
 Returns QuantizerRecursivePartial<SQConfig>
- vectorizer: {
 img2VecNeural: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "img2vec-neural">);
 multi2VecBind: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-bind">);
 multi2VecClip: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-clip">);
 multi2VecCohere: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-cohere">);
 multi2VecGoogle: (<N, I>(opts) => VectorConfigCreate<never, N, I, "multi2vec-google">);
 multi2VecJinaAI: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-jinaai">);
 multi2VecPalm: (<N, I>(opts) => VectorConfigCreate<never, N, I, "multi2vec-palm">);
 multi2VecVoyageAI: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-voyageai">);
 none: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "none">);
 ref2VecCentroid: (<N, I>(opts) => VectorConfigCreate<never, N, I, "ref2vec-centroid">);
 text2VecAWS: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-aws">);
 text2VecAzureOpenAI: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-azure-openai">);
 text2VecCohere: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-cohere">);
 text2VecContextionary: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-contextionary">);
 text2VecDatabricks: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-databricks">);
 text2VecGPT4All: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-gpt4all">);
 text2VecGoogle: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-google">);
 text2VecHuggingFace: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-huggingface">);
 text2VecJinaAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-jinaai">);
 text2VecMistral: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-mistral">);
 text2VecOllama: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-ollama">);
 text2VecOpenAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-openai">);
 text2VecPalm: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-palm">);
 text2VecTransformers: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-transformers">);
 text2VecVoyageAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-voyageai">);
 text2VecWeaviate: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-weaviate">);
 }
 - img2VecNeural: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "img2vec-neural">)
 Create a VectorConfigCreate object with the vectorizer set to 'img2vec-neural'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <N, I>(opts?): VectorConfigCreate<never, N, I, "img2vec-neural">
 - Type Parameters
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Img2VecNeuralConfig & {
 name?: N;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration options for the img2vec-neural vectorizer.
 
 Returns VectorConfigCreate<never, N, I, "img2vec-neural">
 - multi2VecBind: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-bind">)
 Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-bind'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <N, I>(opts?): VectorConfigCreate<never, N, I, "multi2vec-bind">
 - Type Parameters
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Multi2VecBindConfigCreate & {
 name?: N;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration options for the multi2vec-bind vectorizer.
 
 Returns VectorConfigCreate<never, N, I, "multi2vec-bind">
 - multi2VecClip: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-clip">)
 Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-clip'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <N, I>(opts?): VectorConfigCreate<never, N, I, "multi2vec-clip">
 - Type Parameters
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Multi2VecClipConfigCreate & {
 name?: N;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration options for the multi2vec-clip vectorizer.
 
 Returns VectorConfigCreate<never, N, I, "multi2vec-clip">
 - multi2VecCohere: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-cohere">)
 Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-cohere'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <N, I>(opts?): VectorConfigCreate<never, N, I, "multi2vec-cohere">
 - Type Parameters
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Multi2VecCohereConfigCreate & {
 name?: N;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration options for the multi2vec-cohere vectorizer.
 
 Returns VectorConfigCreate<never, N, I, "multi2vec-cohere">
 - multi2VecGoogle: (<N, I>(opts) => VectorConfigCreate<never, N, I, "multi2vec-google">)
 Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-google'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <N, I>(opts): VectorConfigCreate<never, N, I, "multi2vec-google">
 - Type Parameters
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 opts: ConfigureNonTextVectorizerOptions<N, I, "multi2vec-google">
 The configuration options for the multi2vec-google vectorizer.
 
 Returns VectorConfigCreate<never, N, I, "multi2vec-google">
 - multi2VecJinaAI: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-jinaai">)
 Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-jinaai'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <N, I>(opts?): VectorConfigCreate<never, N, I, "multi2vec-jinaai">
 - Type Parameters
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Multi2VecJinaAIConfigCreate & {
 name?: N;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration options for the multi2vec-jinaai vectorizer.
 
 Returns VectorConfigCreate<never, N, I, "multi2vec-jinaai">
 - multi2VecPalm: (<N, I>(opts) => VectorConfigCreate<never, N, I, "multi2vec-palm">)
 Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-palm'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 
 Deprecated
 Use multi2VecGoogle instead.
 - - <N, I>(opts): VectorConfigCreate<never, N, I, "multi2vec-palm">
 - Type Parameters
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 opts: ConfigureNonTextVectorizerOptions<N, I, "multi2vec-palm">
 The configuration options for the multi2vec-palm vectorizer.
 
 Returns VectorConfigCreate<never, N, I, "multi2vec-palm">
 - multi2VecVoyageAI: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-voyageai">)
 Create a VectorConfigCreate object with the vectorizer set to 'multi2vec-clip'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <N, I>(opts?): VectorConfigCreate<never, N, I, "multi2vec-voyageai">
 - Type Parameters
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Multi2VecVoyageAIConfigCreate & {
 name?: N;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration options for the multi2vec-voyageai vectorizer.
 
 Returns VectorConfigCreate<never, N, I, "multi2vec-voyageai">
 - none: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "none">)
 Create a VectorConfigCreate object with the vectorizer set to 'none'.
 
 Returns
 The configuration object.
 - - <N, I>(opts?): VectorConfigCreate<never, N, I, "none">
 - Type Parameters
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: {
 name?: N;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration options for the none vectorizer.
 
 Optional name?: N
 Optional vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>
 Returns VectorConfigCreate<never, N, I, "none">
 - ref2VecCentroid: (<N, I>(opts) => VectorConfigCreate<never, N, I, "ref2vec-centroid">)
 Create a VectorConfigCreate object with the vectorizer set to 'ref2vec-centroid'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <N, I>(opts): VectorConfigCreate<never, N, I, "ref2vec-centroid">
 - Type Parameters
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 opts: ConfigureNonTextVectorizerOptions<N, I, "ref2vec-centroid">
 The configuration options for the ref2vec-centroid vectorizer.
 
 Returns VectorConfigCreate<never, N, I, "ref2vec-centroid">
 - text2VecAWS: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-aws">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-aws'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <T, N, I>(opts): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-aws">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 opts: ConfigureTextVectorizerOptions<T, N, I, "text2vec-aws">
 The configuration options for the text2vec-aws vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-aws">
 - text2VecAzureOpenAI: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-azure-openai">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-azure-openai'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <T, N, I>(opts): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-azure-openai">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 opts: ConfigureTextVectorizerOptions<T, N, I, "text2vec-azure-openai">
 The configuration options for the text2vec-azure-openai vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-azure-openai">
 - text2VecCohere: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-cohere">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-cohere'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <T, N, I>(opts?): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-cohere">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Text2VecCohereConfig & {
 name?: N;
 sourceProperties?: PrimitiveKeys<T>[];
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration options for the text2vec-cohere vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-cohere">
 - text2VecContextionary: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-contextionary">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-contextionary'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <T, N, I>(opts?): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-contextionary">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Text2VecContextionaryConfig & {
 name?: N;
 sourceProperties?: PrimitiveKeys<T>[];
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration for the text2vec-contextionary vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-contextionary">
 - text2VecDatabricks: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-databricks">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-databricks'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <T, N, I>(opts): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-databricks">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 opts: ConfigureTextVectorizerOptions<T, N, I, "text2vec-databricks">
 The configuration for the text2vec-databricks vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-databricks">
 - text2VecGPT4All: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-gpt4all">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-gpt4all'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <T, N, I>(opts?): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-gpt4all">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Text2VecGPT4AllConfig & {
 name?: N;
 sourceProperties?: PrimitiveKeys<T>[];
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration for the text2vec-contextionary vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-gpt4all">
 - text2VecGoogle: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-google">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-google'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <T, N, I>(opts?): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-google">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Text2VecGoogleConfig & {
 name?: N;
 sourceProperties?: PrimitiveKeys<T>[];
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration for the text2vec-palm vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-google">
 - text2VecHuggingFace: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-huggingface">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-huggingface'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <T, N, I>(opts?): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-huggingface">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Text2VecHuggingFaceConfig & {
 name?: N;
 sourceProperties?: PrimitiveKeys<T>[];
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration for the text2vec-contextionary vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-huggingface">
 - text2VecJinaAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-jinaai">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-jinaai'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <T, N, I>(opts?): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-jinaai">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Text2VecJinaAIConfig & {
 name?: N;
 sourceProperties?: PrimitiveKeys<T>[];
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration for the text2vec-jinaai vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-jinaai">
 - text2VecMistral: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-mistral">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-mistral'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <T, N, I>(opts?): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-mistral">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Text2VecMistralConfig & {
 name?: N;
 sourceProperties?: PrimitiveKeys<T>[];
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration for the text2vec-mistral vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-mistral">
 - text2VecOllama: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-ollama">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-ollama'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <T, N, I>(opts?): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-ollama">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Text2VecOllamaConfig & {
 name?: N;
 sourceProperties?: PrimitiveKeys<T>[];
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration for the text2vec-ollama vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-ollama">
 - text2VecOpenAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-openai">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-openai'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <T, N, I>(opts?): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-openai">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Text2VecOpenAIConfig & {
 name?: N;
 sourceProperties?: PrimitiveKeys<T>[];
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration for the text2vec-openai vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-openai">
 - text2VecPalm: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-palm">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-palm'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 
 Deprecated
 Use text2VecGoogle instead.
 - - <T, N, I>(opts?): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-palm">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Text2VecGoogleConfig & {
 name?: N;
 sourceProperties?: PrimitiveKeys<T>[];
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration for the text2vec-palm vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-palm">
 - text2VecTransformers: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-transformers">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-transformers'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <T, N, I>(opts?): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-transformers">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Text2VecTransformersConfig & {
 name?: N;
 sourceProperties?: PrimitiveKeys<T>[];
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration for the text2vec-transformers vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-transformers">
 - text2VecVoyageAI: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-voyageai">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-voyageai'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <T, N, I>(opts?): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-voyageai">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Text2VecVoyageAIConfig & {
 name?: N;
 sourceProperties?: PrimitiveKeys<T>[];
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration for the text2vec-voyageai vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-voyageai">
 - text2VecWeaviate: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-weaviate">)
 Create a VectorConfigCreate object with the vectorizer set to 'text2vec-weaviate'.
 
 See the documentation for detailed usage.
 
 Returns
 The configuration object.
 - - <T, N, I>(opts?): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-weaviate">
 - Type Parameters
 T
 N extends undefined | string = undefined
 I extends string = "hnsw"
 Parameters
 Optional opts: Text2VecWeaviateConfig & {
 name?: N;
 sourceProperties?: PrimitiveKeys<T>[];
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration for the text2vec-weaviate vectorizer.
 
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-weaviate">
connectToCustom: ((options) => Promise<WeaviateClient>)
- - (options): Promise<WeaviateClient>
 - Connect to a custom Weaviate deployment, e.g. your own self-hosted Kubernetes cluster.
 Parameters
 - options: ConnectToCustomOptions
 Options for the connection.
 Returns Promise<WeaviateClient>
 A Promise that resolves to a client connected to your custom Weaviate deployment.
connectToLocal: ((options?) => Promise<WeaviateClient>)
- - (options?): Promise<WeaviateClient>
 - Connect to a locally-deployed Weaviate instance, e.g. as a Docker compose stack.
 Parameters
 - Optional options: ConnectToLocalOptions
 Options for the connection.
 Returns Promise<WeaviateClient>
 A Promise that resolves to a client connected to your local Weaviate instance.
connectToWCD: ((clusterURL, options?) => Promise<WeaviateClient>)
- - (clusterURL, options?): Promise<WeaviateClient>
 - Connect to your own Weaviate Cloud (WCD) instance.
 Parameters
 - clusterURL: string
 The URL of your WCD instance. E.g., https://example.weaviate.network.
 - Optional options: ConnectToWeaviateCloudOptions
 Additional options for the connection.
 Returns Promise<WeaviateClient>
 A Promise that resolves to a client connected to your WCD instance.
 
 Deprecated
 Use connectToWeaviateCloud instead.
connectToWCS: ((clusterURL, options?) => Promise<WeaviateClient>)
- - (clusterURL, options?): Promise<WeaviateClient>
 - Connect to your own Weaviate Cloud Service (WCS) instance.
 Parameters
 - clusterURL: string
 The URL of your WCD instance. E.g., https://example.weaviate.network.
 - Optional options: ConnectToWeaviateCloudOptions
 Additional options for the connection.
 Returns Promise<WeaviateClient>
 A Promise that resolves to a client connected to your WCS instance.
 
 Deprecated
 Use connectToWeaviateCloud instead.
connectToWeaviateCloud: ((clusterURL, options?) => Promise<WeaviateClient>)
- - (clusterURL, options?): Promise<WeaviateClient>
 - Connect to your own Weaviate Cloud (WCD) instance.
 Parameters
 - clusterURL: string
 The URL of your WCD instance. E.g., https://example.weaviate.network.
 - Optional options: ConnectToWeaviateCloudOptions
 Additional options for the connection.
 Returns Promise<WeaviateClient>
 A Promise that resolves to a client connected to your WCD instance.
permissions: {
    backup: ((args) => BackupsPermission[]);
    cluster: ((args) => ClusterPermission[]);
    collections: ((args) => CollectionsPermission[]);
    data: ((args) => DataPermission[]);
    nodes: ((args) => NodesPermission[]);
    roles: ((args) => RolesPermission[]);
}
- backup: ((args) => BackupsPermission[])
  - - (args): BackupsPermission[]
    - Parameters
      args: {
      collection: string | string[];
      manage?: boolean;
      }
      collection: string | string[]
      Optional manage?: boolean
      Returns BackupsPermission[]
- cluster: ((args) => ClusterPermission[])
  - - (args): ClusterPermission[]
    - Parameters
      args: {
      read?: boolean;
      }
      Optional read?: boolean
      Returns ClusterPermission[]
- collections: ((args) => CollectionsPermission[])
  - - (args): CollectionsPermission[]
    - Parameters
      args: {
          collection: string | string[];
          create_collection?: boolean;
          delete_collection?: boolean;
          read_config?: boolean;
          update_config?: boolean;
      }
      collection: string | string[]
      Optional create_collection?: boolean
      Optional delete_collection?: boolean
      Optional read_config?: boolean
      Optional update_config?: boolean
      Returns CollectionsPermission[]
- data: ((args) => DataPermission[])
  - - (args): DataPermission[]
    - Parameters
      args: {
          collection: string | string[];
          create?: boolean;
          delete?: boolean;
          read?: boolean;
          update?: boolean;
      }
      collection: string | string[]
      Optional create?: boolean
      Optional delete?: boolean
      Optional read?: boolean
      Optional update?: boolean
      Returns DataPermission[]
- nodes: ((args) => NodesPermission[])
  - - (args): NodesPermission[]
    - Parameters
      args: {
          collection: string | string[];
          read?: boolean;
          verbosity?: "verbose" | "minimal";
      }
      collection: string | string[]
      Optional read?: boolean
      Optional verbosity?: "verbose" | "minimal"
      Returns NodesPermission[]
- roles: ((args) => RolesPermission[])
  - - (args): RolesPermission[]
    - Parameters
      args: {
          manage?: boolean;
          read?: boolean;
          role: string | string[];
      }
      Optional manage?: boolean
      Optional read?: boolean
      role: string | string[]
      Returns RolesPermission[]
reconfigure: {
 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>;
 };
 invertedIndex: ((options) => InvertedIndexConfigUpdate);
 multiTenancy: ((options) => MultiTenancyConfigUpdate);
 replication: ((options) => 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>);
 };
 vectorIndex: {
 flat: ((options) => ModuleConfig<"flat", VectorIndexConfigFlatUpdate>);
 hnsw: ((options) => ModuleConfig<"hnsw", VectorIndexConfigHNSWUpdate>);
 quantizer: {
 bq: ((options?) => BQConfigUpdate);
 pq: ((options?) => PQConfigUpdate);
 sq: ((options?) => SQConfigUpdate);
 };
 };
 vectorizer: {
 update: (<N, I>(options) => VectorConfigUpdate<N, I>);
 };
}
- 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.
 Defined in collections/configure/generative.ts:39
 - 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.
 Defined in collections/configure/generative.ts:55
 - 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.
 Defined in collections/configure/generative.ts:71
 - 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>
 Defined in collections/configure/generative.ts:148
 - 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.
 Defined in collections/configure/generative.ts:164
 - 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.
 Defined in collections/configure/generative.ts:180
- 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>

Variable defaultConst

Type declaration

ApiKey: typeof ApiKey

AuthAccessTokenCredentials: typeof AuthAccessTokenCredentials

AuthClientCredentials: typeof AuthClientCredentials

AuthUserPasswordCredentials: typeof AuthUserPasswordCredentials

client: ((params) => Promise<WeaviateClient>)

Parameters

Returns Promise<WeaviateClient>

configGuards: { quantizer: typeof Quantizer; vectorIndex: typeof VectorIndex; }

quantizer: typeof Quantizer

vectorIndex: typeof VectorIndex

BLOB: "blob"

BOOLEAN: "boolean"

BOOLEAN_ARRAY: "boolean[]"

DATE: "date"

DATE_ARRAY: "date[]"

GEO_COORDINATES: "geoCoordinates"

INT: "int"

INT_ARRAY: "int[]"

NUMBER: "number"

NUMBER_ARRAY: "number[]"

OBJECT: "object"

OBJECT_ARRAY: "object[]"

PHONE_NUMBER: "phoneNumber"

TEXT: "text"

TEXT_ARRAY: "text[]"

UUID: "uuid"

UUID_ARRAY: "uuid[]"

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

Returns

Parameters

Returns ModuleConfig<"generative-openai", GenerativeAzureOpenAIConfig>

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

Returns

Parameters

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

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

Returns

Parameters

Returns ModuleConfig<"generative-databricks", GenerativeDatabricksConfig>

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

Returns

Parameters

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

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

Returns

Parameters

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

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

Returns

Deprecated

Parameters

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

anthropic:function

Parameters

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

anyscale:function

Parameters

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

aws:function

Parameters

Returns ModuleConfig<"generative-aws", GenerativeAWSConfig>

friendliai:function

Parameters

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

mistral:function

Parameters

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

ollama:function

Parameters

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

invertedIndex: ((options) => { bm25?: { b?: number; k1?: number; }; cleanupIntervalSeconds?: number; indexNullState?: boolean; indexPropertyLength?: boolean; indexTimestamps?: boolean; stopwords?: { additions?: (undefined | string)[]; preset?: string; removals?: (undefined | string)[]; }; })

Parameters

Optional bm25b?: number

Optional bm25k1?: number

Optional cleanupIntervalSeconds?: number

Optional indexNullState?: boolean

Optional indexPropertyLength?: boolean

Optional indexTimestamps?: boolean

Variable default`Const`

configGuards: {
quantizer: typeof Quantizer;
vectorIndex: typeof VectorIndex;
}

invertedIndex: ((options) => {
bm25?: {
b?: number;
k1?: number;
};
cleanupIntervalSeconds?: number;
indexNullState?: boolean;
indexPropertyLength?: boolean;
indexTimestamps?: boolean;
stopwords?: {
additions?: (undefined | string)[];
preset?: string;
removals?: (undefined | string)[];
};
})

`Optional` bm25b?: number

`Optional` bm25k1?: number

`Optional` cleanupIntervalSeconds?: number

`Optional` indexNullState?: boolean

`Optional` indexPropertyLength?: boolean

`Optional` indexTimestamps?: boolean

`Optional` stopwordsAdditions?: string[]

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

`Optional` stopwordsRemovals?: string[]

Returns {
bm25?: {
b?: number;
k1?: number;
};
cleanupIntervalSeconds?: number;
indexNullState?: boolean;
indexPropertyLength?: boolean;
indexTimestamps?: boolean;
stopwords?: {
additions?: (undefined | string)[];
preset?: string;
removals?: (undefined | string)[];
};
}

`Optional` bm25?: {
b?: number;
k1?: number;
}

`Optional` b?: number

`Optional` k1?: number

`Optional` cleanupIntervalSeconds?: number

`Optional` indexNullState?: boolean

`Optional` indexPropertyLength?: boolean

`Optional` indexTimestamps?: boolean

`Optional` stopwords?: {
additions?: (undefined | string)[];
preset?: string;
removals?: (undefined | string)[];
}

`Optional` additions?: (undefined | string)[]

`Optional` preset?: string

`Optional` removals?: (undefined | string)[]

multiTenancy: ((options?) => {
autoTenantActivation?: boolean;
autoTenantCreation?: boolean;
enabled?: boolean;
})

`Optional` autoTenantActivation?: boolean

`Optional` autoTenantCreation?: boolean

`Optional` enabled?: boolean

Returns {
autoTenantActivation?: boolean;
autoTenantCreation?: boolean;
enabled?: boolean;
}

`Optional` autoTenantActivation?: boolean

`Optional` autoTenantCreation?: boolean

`Optional` enabled?: boolean

replication: ((options) => {
asyncEnabled?: boolean;
deletionStrategy?: ReplicationDeletionStrategy;
factor?: number;
})

`Optional` asyncEnabled?: boolean

`Optional` deletionStrategy?: ReplicationDeletionStrategy

`Optional` factor?: number

Returns {
asyncEnabled?: boolean;
deletionStrategy?: ReplicationDeletionStrategy;
factor?: number;
}

`Optional` asyncEnabled?: boolean

`Optional` deletionStrategy?: ReplicationDeletionStrategy

`Optional` factor?: number

`Optional` desiredCount?: number

`Optional` desiredVirtualCount?: number

`Optional` virtualPerPhysical?: number

tokenization: {
FIELD: "field";
GSE: "gse";
KAGOME_KR: "kagome_kr";
LOWERCASE: "lowercase";
TRIGRAM: "trigram";
WHITESPACE: "whitespace";
WORD: "word";
}

vectorDistances: {
COSINE: "cosine";
DOT: "dot";
HAMMING: "hamming";
L2_SQUARED: "l2-squared";
}