Merge branch 'main' of https://github.com/weaviate/typescript-client into mt/allow-updating-config

Author: tsmith023

src/collections/collection/index.ts

@@ -63,6 +63,12 @@ export interface Collection<T = undefined, N = string> {
    * are returned. Use `wvc.QueryReference` to specify which references to return.
    */
   iterator: (opts?: IteratorOptions<T>) => Iterator<T>;
+  /**
+   * Use this method to return the total number of objects in the collection.
+   *
+   * This is a short-hand for calling `collection.aggregate.overAll().then(({ totalCount }) => totalCount)`.
+   */
+  length: () => Promise<number>;
   /**
    * Use this method to return a collection object specific to a single consistency level.
    *
@@ -111,9 +117,16 @@ const collection = <T, N>(
     throw new WeaviateInvalidInputError(`The collection name must be a string, got: ${typeof name}`);
   }
   const capitalizedName = capitalizeCollectionName(name);
+  const aggregateCollection = aggregate<T>(
+    connection,
+    capitalizedName,
+    dbVersionSupport,
+    consistencyLevel,
+    tenant
+  );
   const queryCollection = query<T>(connection, capitalizedName, dbVersionSupport, consistencyLevel, tenant);
   return {
-    aggregate: aggregate<T>(connection, capitalizedName, dbVersionSupport, consistencyLevel, tenant),
+    aggregate: aggregateCollection,
     backup: backupCollection(connection, capitalizedName),
     config: config<T>(connection, capitalizedName, dbVersionSupport, tenant),
     data: data<T>(connection, capitalizedName, dbVersionSupport, consistencyLevel, tenant),
@@ -139,6 +152,7 @@ const collection = <T, N>(
           })
           .then((res) => res.objects)
       ),
+    length: () => aggregateCollection.overAll().then(({ totalCount }) => totalCount),
     withConsistency: (consistencyLevel: ConsistencyLevel) =>
       collection<T, N>(connection, capitalizedName, dbVersionSupport, consistencyLevel, tenant),
     withTenant: <TT extends TenantBase>(tenant: string | TT) =>

src/collections/config/types/generative.ts

@@ -58,13 +58,6 @@ export type GenerativeMistralConfig = {
   temperature?: number;
 };
 
-export type GenerativeOctoAIConfig = {
-  baseURL?: string;
-  maxTokens?: number;
-  model?: string;
-  temperature?: number;
-};
-
 export type GenerativeOllamaConfig = {
   apiEndpoint?: string;
   model?: string;
@@ -102,7 +95,6 @@ export type GenerativeConfig =
   | GenerativeGoogleConfig
   | GenerativeFriendliAIConfig
   | GenerativeMistralConfig
-  | GenerativeOctoAIConfig
   | GenerativeOllamaConfig
   | GenerativeOpenAIConfig
   | GenerativePaLMConfig
@@ -127,8 +119,6 @@ export type GenerativeConfigType<G> = G extends 'generative-anthropic'
   ? GenerativeFriendliAIConfig
   : G extends 'generative-mistral'
   ? GenerativeMistralConfig
-  : G extends 'generative-octoai'
-  ? GenerativeOctoAIConfig
   : G extends 'generative-ollama'
   ? GenerativeOllamaConfig
   : G extends 'generative-openai'
@@ -152,7 +142,6 @@ export type GenerativeSearch =
   | 'generative-google'
   | 'generative-friendliai'
   | 'generative-mistral'
-  | 'generative-octoai'
   | 'generative-ollama'
   | 'generative-openai'
   | GenerativePalm

src/collections/config/types/vectorizer.ts

@@ -20,6 +20,7 @@ type Text2VecPalmVectorizer = 'text2vec-palm';
 export type Vectorizer =
   | 'img2vec-neural'
   | 'multi2vec-clip'
+  | 'multi2vec-cohere'
   | 'multi2vec-bind'
   | Multi2VecPalmVectorizer
   | 'multi2vec-google'
@@ -33,7 +34,6 @@ export type Vectorizer =
   | 'text2vec-huggingface'
   | 'text2vec-jina'
   | 'text2vec-mistral'
-  | 'text2vec-octoai'
   | 'text2vec-ollama'
   | 'text2vec-openai'
   | Text2VecPalmVectorizer
@@ -81,6 +81,33 @@ export type Multi2VecClipConfig = {
   };
 };
 
+/**
+ * The configuration for multi-media vectorization using the Cohere module.
+ *
+ * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/cohere/embeddings-multimodal) for detailed usage.
+ */
+export type Multi2VecCohereConfig = {
+  /** The base URL to use where API requests should go. */
+  baseURL?: string;
+  /** The image fields used when vectorizing. */
+  imageFields?: string[];
+  /** The specific model to use. */
+  model?: string;
+  /** The text fields used when vectorizing. */
+  textFields?: string[];
+  /** The truncation strategy to use. */
+  truncate?: string;
+  /** Whether the collection name is vectorized. */
+  vectorizeCollectionName?: boolean;
+  /** The weights of the fields used for vectorization. */
+  weights?: {
+    /** The weights of the image fields. */
+    imageFields?: number[];
+    /** The weights of the text fields. */
+    textFields?: number[];
+  };
+};
+
 /** The configuration for multi-media vectorization using the Bind module.
  *
  * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/imagebind/embeddings-multimodal) for detailed usage.
@@ -290,20 +317,6 @@ export type Text2VecMistralConfig = {
   vectorizeCollectionName?: boolean;
 };
 
-/**
- * The configuration for text vectorization using the OctoAI module.
- *
- * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/octoai/embeddings) 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 the Ollama module.
  *
@@ -421,6 +434,8 @@ export type VectorizerConfigType<V> = V extends 'img2vec-neural'
   ? Img2VecNeuralConfig | undefined
   : V extends 'multi2vec-clip'
   ? Multi2VecClipConfig | undefined
+  : V extends 'multi2vec-cohere'
+  ? Multi2VecCohereConfig | undefined
   : V extends 'multi2vec-bind'
   ? Multi2VecBindConfig | undefined
   : V extends 'multi2vec-google'
@@ -447,8 +462,6 @@ export type VectorizerConfigType<V> = V extends 'img2vec-neural'
   ? Text2VecJinaConfig | undefined
   : V extends 'text2vec-mistral'
   ? Text2VecMistralConfig | undefined
-  : V extends 'text2vec-octoai'
-  ? Text2VecOctoAIConfig | undefined
   : V extends 'text2vec-ollama'
   ? Text2VecOllamaConfig | undefined
   : V extends 'text2vec-openai'

src/collections/configure/generative.ts

@@ -8,7 +8,6 @@ import {
   GenerativeFriendliAIConfig,
   GenerativeGoogleConfig,
   GenerativeMistralConfig,
-  GenerativeOctoAIConfig,
   GenerativeOllamaConfig,
   GenerativeOpenAIConfig,
   GenerativePaLMConfig,
@@ -23,7 +22,6 @@ import {
   GenerativeDatabricksConfigCreate,
   GenerativeFriendliAIConfigCreate,
   GenerativeMistralConfigCreate,
-  GenerativeOctoAIConfigCreate,
   GenerativeOllamaConfigCreate,
   GenerativeOpenAIConfigCreate,
   GenerativePaLMConfigCreate,
@@ -171,22 +169,6 @@ export default {
       config,
     };
   },
-  /**
-   * Create a `ModuleConfig<'generative-octoai', GenerativeOpenAIConfig | undefined>` object for use when performing AI generation using the `generative-octoai` module.
-   *
-   * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/octoai/generative) for detailed usage.
-   *
-   * @param {GenerativeOctoAIConfigCreate} [config] The configuration for the `generative-octoai` module.
-   * @returns {ModuleConfig<'generative-octoai', GenerativeOctoAIConfig | undefined>} The configuration object.
-   */
-  octoai(
-    config?: GenerativeOctoAIConfigCreate
-  ): ModuleConfig<'generative-octoai', GenerativeOctoAIConfig | undefined> {
-    return {
-      name: 'generative-octoai',
-      config,
-    };
-  },
   /**
    * Create a `ModuleConfig<'generative-ollama', GenerativeOllamaConfig | undefined>` object for use when performing AI generation using the `generative-ollama` module.
    *

src/collections/configure/types/generative.ts

@@ -5,7 +5,6 @@ import {
   GenerativeDatabricksConfig,
   GenerativeFriendliAIConfig,
   GenerativeMistralConfig,
-  GenerativeOctoAIConfig,
   GenerativeOllamaConfig,
   GenerativePaLMConfig,
 } from '../../index.js';
@@ -45,8 +44,6 @@ export type GenerativeFriendliAIConfigCreate = GenerativeFriendliAIConfig;
 
 export type GenerativeMistralConfigCreate = GenerativeMistralConfig;
 
-export type GenerativeOctoAIConfigCreate = GenerativeOctoAIConfig;
-
 export type GenerativeOllamaConfigCreate = GenerativeOllamaConfig;
 
 export type GenerativeOpenAIConfigCreate = GenerativeOpenAIConfigBaseCreate & {
@@ -64,7 +61,6 @@ export type GenerativeConfigCreate =
   | GenerativeDatabricksConfigCreate
   | GenerativeFriendliAIConfigCreate
   | GenerativeMistralConfigCreate
-  | GenerativeOctoAIConfigCreate
   | GenerativeOllamaConfigCreate
   | GenerativeOpenAIConfigCreate
   | GenerativePaLMConfigCreate
@@ -85,8 +81,6 @@ export type GenerativeConfigCreateType<G> = G extends 'generative-anthropic'
   ? GenerativeFriendliAIConfigCreate
   : G extends 'generative-mistral'
   ? GenerativeMistralConfigCreate
-  : G extends 'generative-octoai'
-  ? GenerativeOctoAIConfigCreate
   : G extends 'generative-ollama'
   ? GenerativeOllamaConfigCreate
   : G extends 'generative-openai'

src/collections/configure/types/vectorizer.ts

@@ -13,7 +13,6 @@ import {
   Text2VecHuggingFaceConfig,
   Text2VecJinaConfig,
   Text2VecMistralConfig,
-  Text2VecOctoAIConfig,
   Text2VecOllamaConfig,
   Text2VecOpenAIConfig,
   Text2VecTransformersConfig,
@@ -111,6 +110,22 @@ export type Multi2VecBindConfigCreate = {
   vectorizeCollectionName?: boolean;
 };
 
+/** The configuration for the `multi2vec-cohere` vectorizer. */
+export type Multi2VecCohereConfigCreate = {
+  /** The base URL to use where API requests should go. */
+  baseURL?: string;
+  /** The image fields to use in vectorization. Can be string of `Multi2VecField` type. If string, weight 0 will be assumed. */
+  imageFields?: string[] | Multi2VecField[];
+  /** The specific model to use. */
+  model?: string;
+  /** The text fields to use in vectorization. Can be string of `Multi2VecField` type. If string, weight 0 will be assumed. */
+  textFields?: string[] | Multi2VecField[];
+  /** The truncation strategy to use. */
+  truncate?: string;
+  /** Whether to vectorize the collection name. */
+  vectorizeCollectionName?: boolean;
+};
+
 /** @deprecated Use `Multi2VecGoogleConfigCreate` instead.*/
 export type Multi2VecPalmConfigCreate = Multi2VecGoogleConfigCreate;
 
@@ -154,8 +169,6 @@ export type Text2VecJinaConfigCreate = Text2VecJinaConfig;
 
 export type Text2VecMistralConfigCreate = Text2VecMistralConfig;
 
-export type Text2VecOctoAIConfigCreate = Text2VecOctoAIConfig;
-
 export type Text2VecOllamaConfigCreate = Text2VecOllamaConfig;
 
 export type Text2VecOpenAIConfigCreate = Text2VecOpenAIConfig;
@@ -173,6 +186,8 @@ export type VectorizerConfigCreateType<V> = V extends 'img2vec-neural'
   ? Img2VecNeuralConfigCreate | undefined
   : V extends 'multi2vec-clip'
   ? Multi2VecClipConfigCreate | undefined
+  : V extends 'multi2vec-cohere'
+  ? Multi2VecCohereConfigCreate | undefined
   : V extends 'multi2vec-bind'
   ? Multi2VecBindConfigCreate | undefined
   : V extends 'multi2vec-palm'
@@ -197,8 +212,6 @@ export type VectorizerConfigCreateType<V> = V extends 'img2vec-neural'
   ? Text2VecJinaConfigCreate | undefined
   : V extends 'text2vec-mistral'
   ? Text2VecMistralConfigCreate | undefined
-  : V extends 'text2vec-octoai'
-  ? Text2VecOctoAIConfigCreate | undefined
   : V extends 'text2vec-ollama'
   ? Text2VecOllamaConfigCreate | undefined
   : V extends 'text2vec-openai'