Merge branch 'main' of https://github.com/weaviate/typescript-client into dev/1.26

Author: tsmith023

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "weaviate-client",
-  "version": "3.0.8",
+  "version": "3.0.9",
   "description": "JS/TS client for Weaviate",
   "main": "dist/node/cjs/index.js",
   "type": "module",
@@ -51,7 +51,7 @@
   },
   "homepage": "https://github.com/weaviate/typescript-client#readme",
   "dependencies": {
-    "graphql": "^16.8.1",
+    "graphql": "^16.8.2",
     "graphql-request": "^6.1.0",
     "long": "^5.2.3",
     "nice-grpc": "^2.1.9",

package.json

@@ -59,7 +59,7 @@ export type GenerativePaLMConfig = {
   apiEndpoint?: string;
   maxOutputTokens?: number;
   modelId?: string;
-  projectId: string;
+  projectId?: string;
   temperature?: number;
   topK?: number;
   topP?: number;

src/collections/config/types/generative.ts

@@ -24,6 +24,7 @@ export type Vectorizer =
   | 'text2vec-gpt4all'
   | 'text2vec-huggingface'
   | 'text2vec-jina'
+  | 'text2vec-octoai'
   | 'text2vec-ollama'
   | 'text2vec-openai'
   | 'text2vec-palm'
@@ -254,6 +255,20 @@ export type Text2VecJinaConfig = {
   vectorizeCollectionName?: boolean;
 };
 
+/**
+ * The configuration for text vectorization using OctoAI.
+ *
+ * See the [documentation](https://weaviate.io/developers/weaviate/modules/retriever-vectorizer-modules/text2vec-octoai) for detailed usage.
+ */
+export type Text2VecOctoAIConfig = {
+  /** The base URL to use where API requests should go. */
+  baseURL?: string;
+  /** The model to use. */
+  model?: string;
+  /** Whether to vectorize the collection name. */
+  vectorizeCollectionName?: boolean;
+};
+
 /**
  * The configuration for text vectorization using Ollama.
  *
@@ -378,6 +393,8 @@ export type VectorizerConfigType<V> = V extends 'img2vec-neural'
   ? Text2VecHuggingFaceConfig | undefined
   : V extends 'text2vec-jina'
   ? Text2VecJinaConfig | undefined
+  : V extends 'text2vec-octoai'
+  ? Text2VecOctoAIConfig | undefined
   : V extends 'text2vec-ollama'
   ? Text2VecOllamaConfig | undefined
   : V extends 'text2vec-openai'

src/collections/config/types/vectorizer.ts

@@ -182,10 +182,12 @@ export default {
    *
    * See the [documentation](https://weaviate.io/developers/weaviate/modules/reader-generator-modules/generative-palm) for detailed usage.
    *
-   * @param {GenerativePaLMConfigCreate} config The configuration for the `generative-palm` module.
+   * @param {GenerativePaLMConfigCreate} [config] The configuration for the `generative-palm` module.
    * @returns {ModuleConfig<'generative-palm', GenerativePaLMConfig>} The configuration object.
    */
-  palm: (config: GenerativePaLMConfigCreate): ModuleConfig<'generative-palm', GenerativePaLMConfig> => {
+  palm: (
+    config?: GenerativePaLMConfigCreate
+  ): ModuleConfig<'generative-palm', GenerativePaLMConfig | undefined> => {
     return {
       name: 'generative-palm',
       config,

src/collections/configure/generative.ts

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

src/collections/configure/types/vectorizer.ts

@@ -822,6 +822,45 @@ describe('Unit testing of the vectorizer factory class', () => {
     });
   });
 
+  it('should create the correct Text2VecOctoAIConfig type with defaults', () => {
+    const config = configure.vectorizer.text2VecOctoAI();
+    expect(config).toEqual<VectorConfigCreate<never, undefined, 'hnsw', 'text2vec-octoai'>>({
+      name: undefined,
+      vectorIndex: {
+        name: 'hnsw',
+        config: undefined,
+      },
+      vectorizer: {
+        name: 'text2vec-octoai',
+        config: undefined,
+      },
+    });
+  });
+
+  it('should create the correct Text2VecOctoAIConfig type with all values', () => {
+    const config = configure.vectorizer.text2VecOctoAI({
+      name: 'test',
+      baseURL: 'base-url',
+      model: 'model',
+      vectorizeCollectionName: true,
+    });
+    expect(config).toEqual<VectorConfigCreate<never, 'test', 'hnsw', 'text2vec-octoai'>>({
+      name: 'test',
+      vectorIndex: {
+        name: 'hnsw',
+        config: undefined,
+      },
+      vectorizer: {
+        name: 'text2vec-octoai',
+        config: {
+          baseURL: 'base-url',
+          model: 'model',
+          vectorizeCollectionName: true,
+        },
+      },
+    });
+  });
+
   it('should create the correct Text2VecOllamaConfig type with defaults', () => {
     const config = configure.vectorizer.text2VecOllama();
     expect(config).toEqual<VectorConfigCreate<never, undefined, 'hnsw', 'text2vec-ollama'>>({
@@ -1256,14 +1295,10 @@ describe('Unit testing of the generative factory class', () => {
   });
 
   it('should create the correct GenerativePaLMConfig type with required & default values', () => {
-    const config = configure.generative.palm({
-      projectId: 'project-id',
-    });
-    expect(config).toEqual<ModuleConfig<'generative-palm', GenerativePaLMConfig>>({
+    const config = configure.generative.palm();
+    expect(config).toEqual<ModuleConfig<'generative-palm', undefined>>({
       name: 'generative-palm',
-      config: {
-        projectId: 'project-id',
-      },
+      config: undefined,
     });
   });
 

src/collections/configure/unit.test.ts

@@ -362,6 +362,22 @@ export const vectorizer = {
       },
     });
   },
+  /**
+   *
+   */
+  text2VecOctoAI: <T, N extends string | undefined = undefined, I extends VectorIndexType = 'hnsw'>(
+    opts?: ConfigureTextVectorizerOptions<T, N, I, 'text2vec-octoai'>
+  ): VectorConfigCreate<PrimitiveKeys<T>, N, I, 'text2vec-octoai'> => {
+    const { name, sourceProperties, vectorIndexConfig, ...config } = opts || {};
+    return makeVectorizer(name, {
+      sourceProperties,
+      vectorIndexConfig,
+      vectorizerConfig: {
+        name: 'text2vec-octoai',
+        config: Object.keys(config).length === 0 ? undefined : config,
+      },
+    });
+  },
   /**
    * Create a `VectorConfigCreate` object with the vectorizer set to `'text2vec-openai'`.
    *

src/collections/configure/vectorizer.ts

@@ -193,6 +193,7 @@ const data = <T>(
     if (Array.isArray(object.vectors)) {
       const supportsNamedVectors = await dbVersionSupport.supportsNamedVectors();
       if (supportsNamedVectors.supports) {
+        obj.vector = object.vectors;
         obj.vectors = { default: object.vectors };
       } else {
         obj.vector = object.vectors;

src/collections/data/index.ts

@@ -2,7 +2,7 @@
 /* eslint-disable @typescript-eslint/no-non-null-asserted-optional-chain */
 import { v4 } from 'uuid';
 import { WeaviateUnsupportedFeatureError } from '../../errors.js';
-import weaviate, { WeaviateClient } from '../../index.js';
+import weaviate, { WeaviateClient, weaviateV2 } from '../../index.js';
 import { GeoCoordinate, PhoneNumber } from '../../proto/v1/properties.js';
 import { Collection } from '../collection/index.js';
 import { CrossReference, CrossReferences, Reference } from '../references/index.js';
@@ -1000,3 +1000,40 @@ describe('Testing of the collection.data methods with a vector index', () => {
     expect(obj2?.vectors.default).toEqual([5, 6, 7, 8]);
   });
 });
+
+describe('Testing of BYOV insertion with legacy vectorizer', () => {
+  const collectionName = 'TestBYOVEdgeCase';
+  const oldClient = weaviateV2.client({ scheme: 'http', host: 'localhost:8080' });
+
+  beforeAll(() =>
+    oldClient.schema
+      .classCreator()
+      .withClass({
+        class: collectionName,
+        vectorizer: 'none',
+      })
+      .do()
+  );
+
+  afterAll(() => oldClient.schema.classDeleter().withClassName(collectionName).do());
+
+  it('should insert and retrieve many vectors using the new client', async () => {
+    const client = await weaviate.connectToLocal();
+    const collection = client.collections.get(collectionName);
+    const { uuids } = await collection.data.insertMany([{ vectors: [1, 2, 3] }, { vectors: [4, 5, 6] }]);
+    await collection.query
+      .fetchObjectById(uuids[0], { includeVector: true })
+      .then((res) => expect(res?.vectors.default).toEqual([1, 2, 3]));
+    await collection.query
+      .fetchObjectById(uuids[1], { includeVector: true })
+      .then((res) => expect(res?.vectors.default).toEqual([4, 5, 6]));
+  });
+
+  it('should insert and retrieve single vectors using the new client', async () => {
+    const client = await weaviate.connectToLocal();
+    const collection = client.collections.get(collectionName);
+    const id = await collection.data.insert({ vectors: [7, 8, 9] });
+    const object = await collection.query.fetchObjectById(id, { includeVector: true });
+    expect(object?.vectors.default).toEqual([7, 8, 9]);
+  });
+});