Variable vectorizer`Const`

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">);
 selfProvided: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "none">);
 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">);
 text2VecModel2Vec: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-model2vec">);
 text2VecNvidia: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-nvidia">);
 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">);
} = legacyVectors

Legacy export, maintained for backwards compatibility. See the comment for legacyVectors.

Type declaration

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;
 quantizer?: QuantizerConfigCreate;
 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: Omit<Multi2VecBindConfig, Multi2VecOmissions> & {
 IMUFields?: string[] | Multi2VecField[];
 audioFields?: string[] | Multi2VecField[];
 depthFields?: string[] | Multi2VecField[];
 imageFields?: string[] | Multi2VecField[];
 textFields?: string[] | Multi2VecField[];
 thermalFields?: string[] | Multi2VecField[];
 videoFields?: string[] | Multi2VecField[];
 } & {
 name?: N;
 quantizer?: QuantizerConfigCreate;
 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: Omit<Multi2VecClipConfig, Multi2VecOmissions> & {
 imageFields?: string[] | Multi2VecField[];
 textFields?: string[] | Multi2VecField[];
 } & {
 name?: N;
 quantizer?: QuantizerConfigCreate;
 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: Omit<Multi2VecCohereConfig, Multi2VecOmissions> & {
 imageFields?: string[] | Multi2VecField[];
 textFields?: string[] | Multi2VecField[];
 } & {
 name?: N;
 quantizer?: QuantizerConfigCreate;
 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: Omit<Multi2VecJinaAIConfig, Multi2VecOmissions> & {
 imageFields?: string[] | Multi2VecField[];
 textFields?: string[] | Multi2VecField[];
 } & {
 name?: N;
 quantizer?: QuantizerConfigCreate;
 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: Omit<Multi2VecVoyageAIConfig, Multi2VecOmissions> & {
 imageFields?: string[] | Multi2VecField[];
 textFields?: string[] | Multi2VecField[];
 } & {
 name?: N;
 quantizer?: QuantizerConfigCreate;
 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.

Deprecated
Use selfProvided instead.
- - <N, I>(opts?): VectorConfigCreate<never, N, I, "none">
 - Type Parameters
 - N extends undefined | string = undefined
 - I extends string = "hnsw"
 Parameters
 - Optional opts: {
 name?: N;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration options for the none vectorizer.
 
 Optional name?: N
 Optional quantizer?: QuantizerConfigCreate
 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">
selfProvided: (<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;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 }
 The configuration options for the none vectorizer.
 
 Optional name?: N
 Optional quantizer?: QuantizerConfigCreate
 Optional vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>
 Returns VectorConfigCreate<never, N, I, "none">
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;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 } & {
 sourceProperties?: PrimitiveKeys<T>[];
 }
 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.

Deprecated
The contextionary model is old and not recommended for use. If you are looking for a local, lightweight model try the new text2vec-model2vec module instead.
- - <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;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 } & {
 sourceProperties?: PrimitiveKeys<T>[];
 }
 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;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 } & {
 sourceProperties?: PrimitiveKeys<T>[];
 }
 The configuration for the text2vec-gpt4all 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;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 } & {
 sourceProperties?: PrimitiveKeys<T>[];
 }
 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;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 } & {
 sourceProperties?: PrimitiveKeys<T>[];
 }
 The configuration for the text2vec-huggingface 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;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 } & {
 sourceProperties?: PrimitiveKeys<T>[];
 }
 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;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 } & {
 sourceProperties?: PrimitiveKeys<T>[];
 }
 The configuration for the text2vec-mistral vectorizer.
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-mistral">
text2VecModel2Vec: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-model2vec">)
Create a VectorConfigCreate object with the vectorizer set to 'text2vec-model2vec'.

Returns
The configuration object.
- - <T, N, I>(opts?): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-model2vec">
 - Type Parameters
 - T
 - N extends undefined | string = undefined
 - I extends string = "hnsw"
 Parameters
 - Optional opts: Text2VecModel2Vec & {
 name?: N;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 } & {
 sourceProperties?: PrimitiveKeys<T>[];
 }
 The configuration for the text2vec-model2vec vectorizer.
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-model2vec">
text2VecNvidia: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-nvidia">)
- - <T, N, I>(opts?): VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-nvidia">
 - Type Parameters
 - T
 - N extends undefined | string = undefined
 - I extends string = "hnsw"
 Parameters
 - Optional opts: Text2VecNvidiaConfig & {
 name?: N;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 } & {
 sourceProperties?: PrimitiveKeys<T>[];
 }
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-nvidia">
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;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 } & {
 sourceProperties?: PrimitiveKeys<T>[];
 }
 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;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 } & {
 sourceProperties?: PrimitiveKeys<T>[];
 }
 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;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 } & {
 sourceProperties?: PrimitiveKeys<T>[];
 }
 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;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 } & {
 sourceProperties?: PrimitiveKeys<T>[];
 }
 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;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 } & {
 sourceProperties?: PrimitiveKeys<T>[];
 }
 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;
 quantizer?: QuantizerConfigCreate;
 vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType>;
 } & {
 sourceProperties?: PrimitiveKeys<T>[];
 }
 The configuration for the text2vec-weaviate vectorizer.
 Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-weaviate">

Deprecated

Use vectors instead.

Variable vectorizerConst

Type declaration

img2VecNeural: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "img2vec-neural">)

Returns

Type Parameters

Parameters

Returns VectorConfigCreate<never, N, I, "img2vec-neural">

multi2VecBind: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-bind">)

Returns

Type Parameters

Parameters

Returns VectorConfigCreate<never, N, I, "multi2vec-bind">

multi2VecClip: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-clip">)

Returns

Type Parameters

Parameters

Returns VectorConfigCreate<never, N, I, "multi2vec-clip">

multi2VecCohere: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-cohere">)

Returns

Type Parameters

Parameters

Returns VectorConfigCreate<never, N, I, "multi2vec-cohere">

multi2VecGoogle: (<N, I>(opts) => VectorConfigCreate<never, N, I, "multi2vec-google">)

Returns

Type Parameters

Parameters

Returns VectorConfigCreate<never, N, I, "multi2vec-google">

multi2VecJinaAI: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-jinaai">)

Returns

Type Parameters

Parameters

Returns VectorConfigCreate<never, N, I, "multi2vec-jinaai">

multi2VecPalm: (<N, I>(opts) => VectorConfigCreate<never, N, I, "multi2vec-palm">)

Returns

Deprecated

Type Parameters

Parameters

Returns VectorConfigCreate<never, N, I, "multi2vec-palm">

multi2VecVoyageAI: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "multi2vec-voyageai">)

Returns

Type Parameters

Parameters

Returns VectorConfigCreate<never, N, I, "multi2vec-voyageai">

none: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "none">)

Returns

Deprecated

Type Parameters

Parameters

Optional name?: N

Optional quantizer?: QuantizerConfigCreate

Optional vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>

Returns VectorConfigCreate<never, N, I, "none">

ref2VecCentroid: (<N, I>(opts) => VectorConfigCreate<never, N, I, "ref2vec-centroid">)

Returns

Type Parameters

Parameters

Returns VectorConfigCreate<never, N, I, "ref2vec-centroid">

selfProvided: (<N, I>(opts?) => VectorConfigCreate<never, N, I, "none">)

Returns

Type Parameters

Parameters

Optional name?: N

Optional quantizer?: QuantizerConfigCreate

Optional vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>

Returns VectorConfigCreate<never, N, I, "none">

text2VecAWS: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-aws">)

Returns

Type Parameters

Parameters

Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-aws">

text2VecAzureOpenAI: (<T, N, I>(opts) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-azure-openai">)

Returns

Type Parameters

Parameters

Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-azure-openai">

text2VecCohere: (<T, N, I>(opts?) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-cohere">)

Returns

Type Parameters

Parameters

Returns VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-cohere">

Variable vectorizer`Const`

`Optional` name?: N

`Optional` quantizer?: QuantizerConfigCreate

`Optional` vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>

`Optional` name?: N

`Optional` quantizer?: QuantizerConfigCreate

`Optional` vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>