Add support for text2vec-mistral

Author: tsmith023

src/collections/config/types/vectorizer.ts

@@ -24,6 +24,7 @@ export type Vectorizer =
   | 'text2vec-gpt4all'
   | 'text2vec-huggingface'
   | 'text2vec-jina'
+  | 'text2vec-mistral'
   | 'text2vec-octoai'
   | 'text2vec-ollama'
   | 'text2vec-openai'
@@ -255,6 +256,18 @@ export type Text2VecJinaConfig = {
   vectorizeCollectionName?: boolean;
 };
 
+/**
+ * The configuration for text vectorization using Mistral.
+ *
+ * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/mistral/embeddings) for detailed usage.
+ */
+export type Text2VecMistralConfig = {
+  /** The model to use. */
+  model?: 'mistral-embed' | string;
+  /** Whether to vectorize the collection name. */
+  vectorizeCollectionName?: boolean;
+};
+
 /**
  * The configuration for text vectorization using OctoAI.
  *
@@ -393,6 +406,8 @@ export type VectorizerConfigType<V> = V extends 'img2vec-neural'
   ? Text2VecHuggingFaceConfig | undefined
   : V extends 'text2vec-jina'
   ? Text2VecJinaConfig | undefined
+  : V extends 'text2vec-mistral'
+  ? Text2VecMistralConfig | undefined
   : V extends 'text2vec-octoai'
   ? Text2VecOctoAIConfig | undefined
   : V extends 'text2vec-ollama'

src/collections/configure/types/vectorizer.ts

@@ -10,6 +10,7 @@ import {
   Text2VecGPT4AllConfig,
   Text2VecHuggingFaceConfig,
   Text2VecJinaConfig,
+  Text2VecMistralConfig,
   Text2VecOctoAIConfig,
   Text2VecOllamaConfig,
   Text2VecOpenAIConfig,
@@ -145,6 +146,8 @@ export type Text2VecHuggingFaceConfigCreate = Text2VecHuggingFaceConfig;
 
 export type Text2VecJinaConfigCreate = Text2VecJinaConfig;
 
+export type Text2VecMistralConfigCreate = Text2VecMistralConfig;
+
 export type Text2VecOctoAIConfigCreate = Text2VecOctoAIConfig;
 
 export type Text2VecOllamaConfigCreate = Text2VecOllamaConfig;
@@ -179,6 +182,8 @@ export type VectorizerConfigCreateType<V> = V extends 'img2vec-neural'
   ? Text2VecHuggingFaceConfigCreate | undefined
   : V extends 'text2vec-jina'
   ? Text2VecJinaConfigCreate | undefined
+  : V extends 'text2vec-mistral'
+  ? Text2VecMistralConfigCreate | undefined
   : V extends 'text2vec-octoai'
   ? Text2VecOctoAIConfigCreate | undefined
   : V extends 'text2vec-ollama'

src/collections/configure/unit.test.ts

@@ -823,6 +823,43 @@ describe('Unit testing of the vectorizer factory class', () => {
     });
   });
 
+  it('should create the correct Text2VecMistralConfig type with defaults', () => {
+    const config = configure.vectorizer.text2VecMistral();
+    expect(config).toEqual<VectorConfigCreate<never, undefined, 'hnsw', 'text2vec-mistral'>>({
+      name: undefined,
+      vectorIndex: {
+        name: 'hnsw',
+        config: undefined,
+      },
+      vectorizer: {
+        name: 'text2vec-mistral',
+        config: undefined,
+      },
+    });
+  });
+
+  it('should create the correct Text2VecMistralConfig type with all values', () => {
+    const config = configure.vectorizer.text2VecMistral({
+      name: 'test',
+      model: 'model',
+      vectorizeCollectionName: true,
+    });
+    expect(config).toEqual<VectorConfigCreate<never, 'test', 'hnsw', 'text2vec-mistral'>>({
+      name: 'test',
+      vectorIndex: {
+        name: 'hnsw',
+        config: undefined,
+      },
+      vectorizer: {
+        name: 'text2vec-mistral',
+        config: {
+          model: 'model',
+          vectorizeCollectionName: true,
+        },
+      },
+    });
+  });
+
   it('should create the correct Text2VecOctoAIConfig type with defaults', () => {
     const config = configure.vectorizer.text2VecOctoAI();
     expect(config).toEqual<VectorConfigCreate<never, undefined, 'hnsw', 'text2vec-octoai'>>({

src/collections/configure/vectorizer.ts

@@ -362,6 +362,27 @@ export const vectorizer = {
       },
     });
   },
+  /**
+   * Create a `VectorConfigCreate` object with the vectorizer set to `'text2vec-mistral'`.
+   *
+   * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/mistral/embeddings) for detailed usage.
+   *
+   * @param {ConfigureTextVectorizerOptions<T, N, I, 'text2vec-mistral'>} [opts] The configuration for the `text2vec-mistral` vectorizer.
+   * @returns {VectorConfigCreate<PrimitiveKeys<T>, N, I, 'text2vec-mistral'>} The configuration object.
+   */
+  text2VecMistral: <T, N extends string | undefined = undefined, I extends VectorIndexType = 'hnsw'>(
+    opts?: ConfigureTextVectorizerOptions<T, N, I, 'text2vec-mistral'>
+  ): VectorConfigCreate<PrimitiveKeys<T>, N, I, 'text2vec-mistral'> => {
+    const { name, sourceProperties, vectorIndexConfig, ...config } = opts || {};
+    return makeVectorizer(name, {
+      sourceProperties,
+      vectorIndexConfig,
+      vectorizerConfig: {
+        name: 'text2vec-mistral',
+        config: Object.keys(config).length === 0 ? undefined : config,
+      },
+    });
+  },
   /**
    *
    */