Merge branch 'main' of https://github.com/weaviate/typescript-client into snyk-upgrade-decf84fdea74321504fd74b6fe0382d0

Author: tsmith023

package-lock.json

@@ -52,7 +52,7 @@
   "homepage": "https://github.com/weaviate/typescript-client#readme",
   "dependencies": {
     "abort-controller-x": "^0.5.0",
-    "graphql": "^16.11.0",
+    "graphql": "^16.12.0",
     "graphql-request": "^6.1.0",
     "long": "^5.3.2",
     "nice-grpc": "^2.1.12",

package.json

@@ -6,7 +6,14 @@ import BackupRestorer from './backupRestorer.js';
 
 export type Backend = 'filesystem' | 's3' | 'gcs' | 'azure';
 export type BackupStatus = 'STARTED' | 'TRANSFERRING' | 'TRANSFERRED' | 'SUCCESS' | 'FAILED';
-export type BackupCompressionLevel = 'DefaultCompression' | 'BestSpeed' | 'BestCompression';
+export type BackupCompressionLevel =
+  | 'DefaultCompression'
+  | 'BestSpeed'
+  | 'BestCompression'
+  | 'ZstdBestSpeed'
+  | 'ZstdDefaultCompression'
+  | 'ZstdBestCompression'
+  | 'NoCompression';
 
 export interface Backup {
   creator: () => BackupCreator;

src/backup/index.ts

@@ -693,7 +693,6 @@ describe('creates backup with valid compression config values', () => {
       .withWaitForCompletion(true)
       .withConfig({
         CPUPercentage: 80,
-        ChunkSize: 512,
         CompressionLevel: 'BestSpeed',
       })
       .do()
@@ -754,44 +753,6 @@ describe('fails creating backup with invalid compression config', () => {
       });
   });
 
-  it('fails creating backup with ChunkSize too high', () => {
-    return client.backup
-      .creator()
-      .withIncludeClassNames(PIZZA_CLASS_NAME)
-      .withBackend(BACKEND)
-      .withBackupId(BACKUP_ID)
-      .withConfig({
-        ChunkSize: 513, // Max is 512
-      })
-      .do()
-      .then(() => {
-        throw new Error('should fail on create backup');
-      })
-      .catch((err: Error) => {
-        expect(err.message).toContain('422');
-        expect(err.message).toContain('ChunkSize');
-      });
-  });
-
-  it('fails creating backup with ChunkSize too low', () => {
-    return client.backup
-      .creator()
-      .withIncludeClassNames(PIZZA_CLASS_NAME)
-      .withBackend(BACKEND)
-      .withBackupId(BACKUP_ID)
-      .withConfig({
-        ChunkSize: 1, // Min is 2
-      })
-      .do()
-      .then(() => {
-        throw new Error('should fail on create backup');
-      })
-      .catch((err: Error) => {
-        expect(err.message).toContain('422');
-        expect(err.message).toContain('ChunkSize');
-      });
-  });
-
   it('cleans up', () => cleanupTestFood(client));
 });
 

src/backup/journey.test.ts

@@ -118,7 +118,6 @@ export const backup = (connection: Connection): Backup => {
       }
       if (args.config) {
         builder = builder.withConfig({
-          ChunkSize: args.config.chunkSize,
           CompressionLevel: args.config.compressionLevel,
           CPUPercentage: args.config.cpuPercentage,
         });

src/collections/backup/client.ts

@@ -31,7 +31,7 @@ export type BackupReturn = BackupStatusReturn & {
 
 /** Configuration options available when creating a backup */
 export type BackupConfigCreate = {
-  /** The size of the chunks to use for the backup. */
+  /** Deprecated: This parameter no longer has any effect. (The size of the chunks to use for the backup.) */
   chunkSize?: number;
   /** The standard of compression to use for the backup. */
   compressionLevel?: BackupCompressionLevel;

src/collections/backup/types.ts

@@ -153,6 +153,8 @@ export type Multi2VecCohereConfig = {
   imageFields?: string[];
   /** The specific model to use. */
   model?: string;
+  /** The number of dimensions for the generated embeddings. */
+  dimensions?: number;
   /** The text fields used when vectorizing. */
   textFields?: string[];
   /** The truncation strategy to use. */
@@ -371,6 +373,8 @@ export type Text2VecCohereConfig = {
   baseURL?: string;
   /** The model to use. */
   model?: string;
+  /** The number of dimensions for the generated embeddings. */
+  dimensions?: number;
   /** Whether to truncate the input texts to fit within the context length. */
   truncate?: boolean;
   /** Whether to vectorize the collection name. */
@@ -586,6 +590,8 @@ export type Text2VecVoyageAIConfig = {
   truncate?: boolean;
   /** Whether to vectorize the collection name. */
   vectorizeCollectionName?: boolean;
+  /** The number of dimensions for the generated embeddings. */
+  dimensions?: number;
 };
 
 /**

src/collections/config/types/vectorizer.ts

@@ -331,6 +331,7 @@ describe('Unit testing of the vectorizer factory class', () => {
     const config = configure.vectors.multi2VecCohere({
       name: 'test',
       model: 'model',
+      dimensions: 512,
       imageFields: [
         { name: 'field1', weight: 0.1 },
         { name: 'field2', weight: 0.2 },
@@ -350,6 +351,7 @@ describe('Unit testing of the vectorizer factory class', () => {
         name: 'multi2vec-cohere',
         config: {
           model: 'model',
+          dimensions: 512,
           imageFields: ['field1', 'field2'],
           textFields: ['field3', 'field4'],
           weights: {
@@ -1002,6 +1004,7 @@ describe('Unit testing of the vectorizer factory class', () => {
       name: 'test',
       baseURL: 'base-url',
       model: 'model',
+      dimensions: 512,
       truncate: true,
     });
     expect(config).toEqual<VectorConfigCreate<never, 'test', 'hnsw', 'text2vec-cohere'>>({
@@ -1015,6 +1018,7 @@ describe('Unit testing of the vectorizer factory class', () => {
         config: {
           baseURL: 'base-url',
           model: 'model',
+          dimensions: 512,
           truncate: true,
         },
       },
@@ -1542,6 +1546,7 @@ describe('Unit testing of the vectorizer factory class', () => {
       baseURL: 'base-url',
       model: 'model',
       truncate: true,
+      dimensions: 256,
     });
     expect(config).toEqual<VectorConfigCreate<never, 'test', 'hnsw', 'text2vec-voyageai'>>({
       name: 'test',
@@ -1555,6 +1560,7 @@ describe('Unit testing of the vectorizer factory class', () => {
           baseURL: 'base-url',
           model: 'model',
           truncate: true,
+          dimensions: 256,
         },
       },
     });

src/collections/configure/unit.test.ts

@@ -57,6 +57,7 @@ describe('Journey testing of the client using a WCD cluster', () => {
       .then(async (config) => {
         expect(config).toEqual<CollectionConfig>({
           name: collectionName,
+          description: undefined,
           generative: {
             name: 'generative-cohere',
             config: {},
@@ -85,6 +86,8 @@ describe('Journey testing of the client using a WCD cluster', () => {
             {
               name: 'name',
               dataType: 'text',
+              description: undefined,
+              nestedProperties: undefined,
               indexFilterable: true,
               indexInverted: false,
               indexRangeFilters: false,
@@ -100,6 +103,8 @@ describe('Journey testing of the client using a WCD cluster', () => {
             {
               name: 'age',
               dataType: 'int',
+              description: undefined,
+              nestedProperties: undefined,
               indexFilterable: true,
               indexInverted: false,
               indexRangeFilters: false,
@@ -115,6 +120,8 @@ describe('Journey testing of the client using a WCD cluster', () => {
             {
               name: 'location',
               dataType: 'geoCoordinates',
+              description: undefined,
+              nestedProperties: undefined,
               indexFilterable: true,
               indexInverted: false,
               indexRangeFilters: false,
@@ -130,6 +137,8 @@ describe('Journey testing of the client using a WCD cluster', () => {
             {
               name: 'dateOfBirth',
               dataType: 'date',
+              description: undefined,
+              nestedProperties: undefined,
               indexFilterable: true,
               indexInverted: false,
               indexRangeFilters: false,
@@ -165,6 +174,7 @@ describe('Journey testing of the client using a WCD cluster', () => {
           },
           vectorizers: {
             default: {
+              properties: undefined,
               vectorizer: {
                 name: 'text2vec-cohere',
                 config: {
@@ -182,7 +192,7 @@ describe('Journey testing of the client using a WCD cluster', () => {
                 dynamicEfFactor: 8,
                 ef: -1,
                 efConstruction: 128,
-                filterStrategy: 'sweeping',
+                filterStrategy: 'acorn',
                 flatSearchCutoff: 40000,
                 maxConnections: (await client.getWeaviateVersion().then((ver) => ver.isLowerThan(1, 26, 0)))
                   ? 64

src/collections/journey.test.ts

@@ -264,8 +264,6 @@ const getMetadataWithEmbeddingServiceAuth = (config: GrpcConnectionParams, beare
           ...config.headers,
           authorization: bearerToken,
           'X-Weaviate-Cluster-Url': config.host,
-          //  keeping for backwards compatibility for older clusters for now. On newer clusters, Embedding Service reuses Authorization header.
-          'X-Weaviate-Api-Key': bearerToken,
         }
       : config.headers
   );