add dimensions param to text2vec-weaviate vectorizer (#238)

* add dimensions param to text2vec-weaviate vectorizer * adjust unit test
weaviate · Dec 4, 2024 · f3e6ddf · f3e6ddf
1 parent 799d409
commit f3e6ddf
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/src/collections/config/types/vectorizer.ts b/src/collections/config/types/vectorizer.ts
@@ -410,11 +410,13 @@ export type Text2VecVoyageAIConfig = {
 /**
  * The configuration for text vectorization using Weaviate's self-hosted text-based embedding models.
  *
- * TODO: add documentation reference once available.
+ * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/weaviate/embeddings) for detailed usage.
  */
 export type Text2VecWeaviateConfig = {
   /** The base URL to use where API requests should go. */
   baseURL?: string;
+  /** The dimensions to use. */
+  dimensions?: number;
   /** The model to use. */
   model?: 'Snowflake/snowflake-arctic-embed-m-v1.5' | string;
   /** Whether to vectorize the collection name. */

diff --git a/src/collections/configure/unit.test.ts b/src/collections/configure/unit.test.ts
@@ -1362,6 +1362,7 @@ describe('Unit testing of the vectorizer factory class', () => {
     const config = configure.vectorizer.text2VecWeaviate({
       name: 'test',
       baseURL: 'base-url',
+      dimensions: 256,
       model: 'model',
       vectorizeCollectionName: true,
     });
@@ -1375,6 +1376,7 @@ describe('Unit testing of the vectorizer factory class', () => {
         name: 'text2vec-weaviate',
         config: {
           baseURL: 'base-url',
+          dimensions: 256,
           model: 'model',
           vectorizeCollectionName: true,
         },

diff --git a/src/collections/configure/vectorizer.ts b/src/collections/configure/vectorizer.ts
@@ -604,7 +604,7 @@ export const vectorizer = {
   /**
    * Create a `VectorConfigCreate` object with the vectorizer set to `'text2vec-weaviate'`.
    *
-   * TODO: add documentation reference once available.
+   * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/weaviate/embeddings) for detailed usage.
    *
    * @param {ConfigureTextVectorizerOptions<T, N, I, 'text2vec-weaviate'>} [opts] The configuration for the `text2vec-weaviate` vectorizer.
    * @returns {VectorConfigCreate<PrimitiveKeys<T>, N, I, 'text2vec-weaviate'>} The configuration object.