Weaviate TypeScript Client

https://weaviate.github.io/typescript-client/
Admin
Official TypeScript/JavaScript client library for easy interaction with Weaviate vector database...
Tokens:83,691
Snippets:612
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### get

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.ICollections.html

Retrieves a collection instance.

```APIDOC
## get<TProperties, TName, TVectors>(name: TName)

### Description
Retrieves an instance of a collection by its name.

### Parameters
- **name** (TName) - Required - The name of the collection to retrieve.

### Returns
- **ICollection**
```

--------------------------------

### get

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.Config.html

Retrieves the current configuration for the collection.

```APIDOC
## get()

### Description
Get the configuration for this collection from Weaviate.

### Returns
- **Promise<CollectionConfig>** - A promise that resolves with the collection configuration.
```

--------------------------------

### Capture Stack Trace Example

Source: https://weaviate.github.io/typescript-client/classes/core_src.WeaviateBackupCanceled.html

Demonstrates how to manually capture a stack trace on an object using Error.captureStackTrace.

```typescript
const myObject = {};  
Error.captureStackTrace(myObject);  
myObject.stack;  // Similar to `new Error().stack`
```

--------------------------------

### get

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.Tenants.html

Returns all tenants currently associated with a collection in Weaviate.

```APIDOC
## get()

### Description
Return all tenants currently associated with a collection in Weaviate. The collection must have been created with multi-tenancy enabled.

### Returns
- **Promise<Record<string, Tenant>>** - A list of tenants as an object of Tenant types, where the key is the tenant name.
```

--------------------------------

### get(id: string, opts?: { includeHistory?: boolean })

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.Replications.html

Retrieves details for a specific replication task.

```APIDOC
## get(id: string, opts?: { includeHistory?: boolean })

### Description
Fetches the details of a replication task by its ID, with an optional flag to include history.

### Parameters
- **id** (string) - Required - The unique identifier of the replication task.
- **opts** (object) - Optional - Configuration options.
  - **includeHistory** (boolean) - Optional - Whether to include the status history of the task.
```

--------------------------------

### get(id: string, opts?: { includeHistory?: boolean })

Source: https://weaviate.github.io/typescript-client/interfaces/node_src.Replications.html

Retrieves details for a specific replication operation.

```APIDOC
## get(id: string, opts?: { includeHistory?: boolean })

### Description
Retrieves a specific replication operation by its ID, with an optional flag to include status history.

### Parameters
- **id** (string) - Required - The ID of the replication operation to get.
- **opts** (object) - Optional - Configuration options.
  - **includeHistory** (boolean) - Optional - Whether to include the status history in the response.

### Returns
- **Promise<object | null>** - The replication operation details or null if not found.
```

--------------------------------

### connectToCustom<C, TMedia>(clientMaker, context, options?)

Source: https://weaviate.github.io/typescript-client/functions/core_src.helpers.connectToCustom.html

Initializes a custom Weaviate client using a provided factory function.

```APIDOC
## connectToCustom

### Description
Initializes a custom Weaviate client instance. This function takes a factory function to create the client, a context object, and optional configuration parameters.

### Signature
`connectToCustom<C extends Context<TMedia>, TMedia>(clientMaker: (context: C, params: ClientParams) => Promise<IWeaviateClient<TMedia>>, context: C, options?: helpers.ConnectToCustomOptions): Promise<IWeaviateClient<TMedia>>`

### Parameters
- **clientMaker** (function) - Required - A function that receives context and ClientParams to return a Promise resolving to an IWeaviateClient.
- **context** (C) - Required - The context object extending Context<TMedia>.
- **options** (helpers.ConnectToCustomOptions) - Optional - Configuration options for the connection.

### Returns
- **Promise<IWeaviateClient<TMedia>>** - A promise that resolves to the initialized Weaviate client.
```

--------------------------------

### create(args: BackupArgs<BackupConfigCreate>): Promise<BackupReturn>

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.Backup.html

Initiates the creation of a database backup.

```APIDOC
## create(args: BackupArgs<BackupConfigCreate>)

### Description
Create a backup of the database.

### Parameters
- **args** (BackupArgs<BackupConfigCreate>) - Required - The arguments for the request.

### Returns
- **Promise<BackupReturn>** - The response from Weaviate.

### Throws
- If the input is invalid.
- If the backup creation fails.
- If the backup creation is canceled.
```

--------------------------------

### default<TMedia>(context, params, isGrpcWeb)

Source: https://weaviate.github.io/typescript-client/functions/core_src.default.html

Initializes a new Weaviate client instance with the provided context and configuration parameters.

```APIDOC
## default<TMedia>

### Description
Initializes a new Weaviate client instance. This function is the primary entry point for creating a client configured with specific context and parameters.

### Signature
`default<TMedia>(context: Context<TMedia>, params: ClientParams, isGrpcWeb?: boolean): Promise<IWeaviateClient<TMedia>>`

### Parameters
- **context** (Context<TMedia>) - Required - The context object for the client.
- **params** (ClientParams) - Required - Configuration parameters for the client.
- **isGrpcWeb** (boolean) - Optional - Flag to enable gRPC-Web, defaults to false.

### Returns
- **Promise<IWeaviateClient<TMedia>>** - A promise that resolves to the initialized Weaviate client instance.
```

--------------------------------

### create

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.ICollections.html

Creates a new collection with the specified configuration.

```APIDOC
## create<TProperties, TName, TVectors>(config: CollectionConfigCreate<TProperties, TName, TVectors>)

### Description
Creates a new collection in Weaviate using the provided configuration object.

### Parameters
- **config** (CollectionConfigCreate) - Required - The configuration object defining properties, name, and vectors for the collection.

### Returns
- **Promise<ICollection>** - A promise that resolves to the created collection instance.
```

--------------------------------

### client(params: ClientParams)

Source: https://weaviate.github.io/typescript-client/variables/node_src.default.html

Initializes and returns a new Weaviate client instance based on the provided configuration parameters.

```APIDOC
## client(params: ClientParams)

### Description
Initializes a new Weaviate client instance. This is the primary entry point for interacting with a Weaviate database.

### Parameters
- **params** (ClientParams) - Required - Configuration object for the client, including connection details and authentication.

### Returns
- **Promise<IWeaviateClient>** - A promise that resolves to the initialized Weaviate client instance.
```

--------------------------------

### get(id: string, opts?: { includeHistory?: boolean })

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.Replications.html

Retrieves a specific replication operation by its ID.

```APIDOC
## get(id: string, opts?: { includeHistory?: boolean })

### Description
Retrieves details for a specific replication operation.

### Parameters
- **id** (string) - Required - The ID of the replication operation to get.
- **opts** (object) - Optional - Configuration options.
  - **includeHistory** (boolean) - Optional - Whether to include the status history in the response.

### Returns
- **Promise<object|null>** - The replication operation object or null if not found.
```

--------------------------------

### restore(args: BackupArgs<BackupConfigRestore>): Promise<BackupReturn>

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.Backup.html

Initiates the restoration of a database backup.

```APIDOC
## restore(args: BackupArgs<BackupConfigRestore>)

### Description
Restore a backup of the database.

### Parameters
- **args** (BackupArgs<BackupConfigRestore>) - Required - The arguments for the request.

### Returns
- **Promise<BackupReturn>** - The response from Weaviate.

### Throws
- If the input is invalid.
- If the backup restoration fails.
- If the backup restoration is canceled.
```

--------------------------------

### constructor

Source: https://weaviate.github.io/typescript-client/classes/node_src.ApiKey.html

Creates a new instance of the ApiKey class.

```APIDOC
## constructor

### Description
Initializes a new ApiKey instance with the provided API key string.

### Signature
`new ApiKey(apiKey: string): ApiKey`

### Parameters
- **apiKey** (string) - The API key string used for authentication.
```

--------------------------------

### Define Multi-Vector Configuration

Source: https://weaviate.github.io/typescript-client/variables/core_src.configure.html

Configuration options for multi-vector setups including JinaAI, Weaviate, and self-provided vectors.

```typescript
multiVectors: {  
multi2VecJinaAI: <  
N extends string  
| undefined = undefined,  
I extends string = "hnsw",  
>(  
opts?: Multi2MultivecJinaAIConfig & {  
name?: N;  
quantizer?: QuantizerConfigCreate;  
vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;  
} & {  
encoding?: {  
dprojections?: number;  
ksim?: number;  
repetitions?: number;  
type?: "muvera";  
};  
},  
) => VectorConfigCreate<never, N, I, "multi2multivec-jinaai">;  
multi2VecWeaviate: <  
N extends string  
| undefined = undefined,  
I extends string = "hnsw",  
>(  
opts?: Omit<Multi2MultivecWeaviateConfig, Multi2VecOmissions> & {  
imageField: string;  
} & {  
name?: N;  
quantizer?: QuantizerConfigCreate;  
vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;  
} & {  
encoding?: {  
dprojections?: number;  
ksim?: number;  
repetitions?: number;  
type?: "muvera";  
};  
},  
) => VectorConfigCreate<never, N, I, "multi2multivec-weaviate">;  
selfProvided: <  
T,  
N extends string | undefined = undefined,  
I extends string = "hnsw",  
>(  
opts?: ConfigureNonTextMultiVectorizerOptions<N, I, "none">,  
) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "none">;  
text2VecJinaAI: <  
T,  
N extends string | undefined = undefined,  
I extends string = "hnsw",  
>(  
opts?: ConfigureTextMultiVectorizerOptions<  
T,  
N,  
I,  
"text2multivec-jinaai",  
>,  
) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2multivec-jinaai">;  
}
```

--------------------------------

### create(args: BackupCollectionArgs): Promise<BackupReturn>

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.BackupCollection.html

Initiates the creation of a backup for the specified collection.

```APIDOC
## create(args: BackupCollectionArgs): Promise<BackupReturn>

### Description
Create a backup of this collection.

### Parameters
- **args** (BackupCollectionArgs) - Required - The arguments for the request.

### Returns
- **Promise<BackupReturn>** - The response from Weaviate.

### Throws
- If the input is invalid.
- If the backup creation fails.
- If the backup creation is canceled.
```

--------------------------------

### weaviateV2.client

Source: https://weaviate.github.io/typescript-client/variables/core_src.weaviateV2.html

Initializes a new Weaviate client instance using the provided connection parameters.

```APIDOC
## client(params: InternalConnectionParams)

### Description
Creates and returns a new instance of the WeaviateClient.

### Parameters
- **params** (InternalConnectionParams) - Required - Configuration object for the connection.
```

--------------------------------

### nearText(query, opts?, callOpts?)

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.Query.html

Performs a vector-based similarity search using a text query. Requires a text-capable vectorization module (e.g., text2vec or multi2vec) to be installed.

```APIDOC
## nearText(query, opts?, callOpts?)

### Description
Search for objects in a collection by text using a text-capable vectorization module. This method supports standard searches, searches with grouping, and programmatically defined options.

### Parameters
- **query** (string | string[]) - Required - The text query to search for.
- **opts** (BaseNearTextOptions | GroupByNearTextOptions | NearTextOptions) - Optional - Configuration options for the search, including optional grouping parameters.
- **callOpts** (CallOptions) - Optional - Configuration options for the API call.

### Returns
- **Promise<WeaviateReturn<T, RV>> | Promise<GroupByReturn<T, RV>> | QueryReturn<T, RV>** - The search results from the collection.
```

--------------------------------

### quantizer.rq

Source: https://weaviate.github.io/typescript-client/variables/node_src.vectorIndex.html

Creates an RQ quantizer configuration.

```APIDOC
## quantizer.rq(options?: { bits?: number; rescoreLimit?: number })

### Description
Creates an object of type `RQConfigCreate` to be used when defining the quantizer configuration of a vector index.
```

--------------------------------

### quantizer.pq

Source: https://weaviate.github.io/typescript-client/variables/node_src.vectorIndex.html

Creates a PQ quantizer configuration.

```APIDOC
## quantizer.pq(options?: { bitCompression?: boolean; centroids?: number; encoder?: { distribution?: PQEncoderDistribution; type?: PQEncoderType }; segments?: number; trainingLimit?: number })

### Description
Creates an object of type `PQConfigCreate` to be used when defining the quantizer configuration of a vector index.
```

--------------------------------

### connectToLocal<C, TMedia>

Source: https://weaviate.github.io/typescript-client/functions/core_src.helpers.connectToLocal.html

Initializes a Weaviate client for local connections using a client factory function and context.

```APIDOC
## connectToLocal

### Description
Initializes a Weaviate client instance for local environments. It accepts a factory function to create the client, a context object, and optional configuration parameters.

### Signature
`connectToLocal<C extends Context<TMedia>, TMedia>(clientMaker: (context: C, params: ClientParams) => Promise<IWeaviateClient<TMedia>>, context: C, options?: helpers.ConnectToLocalOptions): Promise<IWeaviateClient<TMedia>>`

### Parameters
- **clientMaker** (function) - Required - A factory function that takes a context and client parameters to return a promise resolving to an IWeaviateClient.
- **context** (C) - Required - The context object used for client initialization.
- **options** (helpers.ConnectToLocalOptions) - Optional - Configuration options for the local connection.

### Returns
- **Promise<IWeaviateClient<TMedia>>** - A promise that resolves to the initialized Weaviate client.
```

--------------------------------

### connectToCustom(options: ConnectToCustomOptions)

Source: https://weaviate.github.io/typescript-client/functions/web_src.connectToCustom.html

Connects to a custom Weaviate deployment using the provided configuration options.

```APIDOC
## connectToCustom

### Description
Connect to a custom Weaviate deployment, such as a self-hosted Kubernetes cluster.

### Signature
`connectToCustom(options: ConnectToCustomOptions): Promise<WeaviateClient>`

### Parameters
- **options** (ConnectToCustomOptions) - Required - Options for the connection.

### Returns
- **Promise<WeaviateClient>** - A Promise that resolves to a client connected to your custom Weaviate deployment.
```

--------------------------------

### create

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.Tenants.html

Creates the specified tenants for a collection in Weaviate.

```APIDOC
## create(tenants: TenantCreate | TenantBC | (TenantCreate | TenantBC)[])

### Description
Create the specified tenants for a collection in Weaviate. The collection must have been created with multi-tenancy enabled.

### Parameters
- **tenants** (TenantCreate | TenantBC | (TenantCreate | TenantBC)[]) - Required - The tenant or tenants to create.

### Returns
- **Promise<Tenant[]>** - The created tenant(s) as a list of Tenant.
```

--------------------------------

### configure.vectors.quantizer.bq

Source: https://weaviate.github.io/typescript-client/variables/core_src.configure.html

Creates a BQ quantizer configuration.

```APIDOC
## bq(options?: { cache?: boolean; rescoreLimit?: number })

### Description
Create an object of type `BQConfigCreate` to be used when defining the quantizer configuration of a vector index.
```

--------------------------------

### Quantizer Configuration Methods

Source: https://weaviate.github.io/typescript-client/variables/core_src.configure.html

Methods to create configuration objects for vector index quantization, including disabling quantization or setting specific algorithms like PQ, RQ, or SQ.

```APIDOC
## Quantizer Configuration Methods

### none()
Creates an `UncompressedConfig` object to disable default quantization in Weaviate >= 1.33.0.

### pq(options)
Creates a `PQConfigCreate` object for Product Quantization configuration.
- **options** (object, optional): Configuration for bitCompression, centroids, encoder, segments, and trainingLimit.

### rq(options)
Creates an `RQConfigCreate` object for Residual Quantization configuration.
- **options** (object, optional): Configuration for bits and rescoreLimit.

### sq(options)
Creates an `SQConfigCreate` object for Scalar Quantization configuration.
- **options** (object, optional): Configuration for rescoreLimit and trainingLimit.
```

--------------------------------

### quantizer.sq

Source: https://weaviate.github.io/typescript-client/variables/node_src.vectorIndex.html

Creates an SQ quantizer configuration.

```APIDOC
## quantizer.sq(options?: { rescoreLimit?: number; trainingLimit?: number })

### Description
Creates an object of type `SQConfigCreate` to be used when defining the quantizer configuration of a vector index.
```

--------------------------------

### create

Source: https://weaviate.github.io/typescript-client/interfaces/web_src.Collections.html

Creates a new collection in Weaviate based on the provided configuration.

```APIDOC
## create<TProperties, TName, TVectors>(config: CollectionConfigCreate<TProperties, TName, TVectors>)

### Description
Creates a new collection with the specified configuration, including properties and vector settings.

### Parameters
- **config** (CollectionConfigCreate) - Required - The configuration object for the new collection.

### Returns
- **Promise<ICollection>** - A promise that resolves to the created collection instance.
```

--------------------------------

### constructor

Source: https://weaviate.github.io/typescript-client/classes/core_src.AuthClientCredentials.html

Creates a new instance of AuthClientCredentials using the provided client credentials input.

```APIDOC
## constructor

### Description
Initializes a new AuthClientCredentials object.

### Signature
`new AuthClientCredentials(creds: ClientCredentialsInput): AuthClientCredentials`

### Parameters
- **creds** (ClientCredentialsInput) - Required - The credentials input object.
```

--------------------------------

### constructor

Source: https://weaviate.github.io/typescript-client/classes/core_src.AuthAccessTokenCredentials.html

Creates a new instance of AuthAccessTokenCredentials using the provided access token credentials input.

```APIDOC
## constructor

### Description
Initializes a new AuthAccessTokenCredentials object with the required access token information.

### Signature
`new AuthAccessTokenCredentials(creds: AccessTokenCredentialsInput): AuthAccessTokenCredentials`

### Parameters
- **creds** (AccessTokenCredentialsInput) - Required - The input object containing access token details.
```

--------------------------------

### quantizer.bq

Source: https://weaviate.github.io/typescript-client/variables/node_src.vectorIndex.html

Creates a BQ quantizer configuration.

```APIDOC
## quantizer.bq(options?: { cache?: boolean; rescoreLimit?: number })

### Description
Creates an object of type `BQConfigCreate` to be used when defining the quantizer configuration of a vector index.
```

--------------------------------

### listAll

Source: https://weaviate.github.io/typescript-client/interfaces/web_src.Collections.html

Lists all collections available in the Weaviate instance.

```APIDOC
## listAll()

### Description
Retrieves a list of all collection configurations currently defined.

### Returns
- **Promise<CollectionConfig[]>** - A promise that resolves to an array of collection configurations.
```

--------------------------------

### list(backend: Backend, opts?: ListBackupOptions): Promise<BackupReturn[]>

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.Backup.html

Lists existing backups for a specified backend.

```APIDOC
## list(backend: Backend, opts?: ListBackupOptions)

### Description
List existing backups (completed and in-progress) created in a given backend.

### Parameters
- **backend** (Backend) - Required - Backend whence to list backups.
- **opts** (ListBackupOptions) - Optional - The options available when listing backups.

### Returns
- **Promise<BackupReturn[]>** - The response from Weaviate.
```

--------------------------------

### use

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.ICollections.html

Selects a collection for use.

```APIDOC
## use<TName, TProperties, TVectors>(name: TName)

### Description
Selects a collection by name to perform operations on it.

### Parameters
- **name** (TName) - Required - The name of the collection.

### Returns
- **ICollection**
```

--------------------------------

### dynamic

Source: https://weaviate.github.io/typescript-client/variables/node_src.vectorIndex.html

Creates a configuration object for a dynamic vector index.

```APIDOC
## dynamic(opts?: VectorIndexConfigDynamicCreateOptions)

### Description
Creates a `ModuleConfig` object for a dynamic vector index. Use this when defining the `options.vectorIndexConfig` argument of the `configure.vectors` method.
```

--------------------------------

### configure.multiTenancy

Source: https://weaviate.github.io/typescript-client/variables/node_src.configure.html

Configures multi-tenancy settings for a class.

```APIDOC
## configure.multiTenancy(options)

### Description
Enables and configures multi-tenancy for a class.

### Parameters
- **options** (object) - Optional settings: `autoTenantActivation`, `autoTenantCreation`, and `enabled`.
```

--------------------------------

### configure.quantizer

Source: https://weaviate.github.io/typescript-client/variables/node_src.configure.html

Provides methods to configure different quantization strategies for vector compression.

```APIDOC
## configure.quantizer.bq(options?: { cache?: boolean; rescoreLimit?: number })
## configure.quantizer.none()
## configure.quantizer.pq(options?: { bitCompression?: boolean; centroids?: number; encoder?: { distribution?: PQEncoderDistribution; type?: PQEncoderType; }; segments?: number; trainingLimit?: number; })
## configure.quantizer.rq(options?: { bits?: number; rescoreLimit?: number })
## configure.quantizer.sq(options?: { rescoreLimit?: number; trainingLimit?: number })

### Description
Defines the quantization method to be used for vector storage, such as Product Quantization (PQ), Scalar Quantization (SQ), or Binary Quantization (BQ).
```

--------------------------------

### connectToWeaviateCloud<C, TMedia>(clusterURL, clientMaker, context, options)

Source: https://weaviate.github.io/typescript-client/functions/core_src.helpers.connectToWeaviateCloud.html

Establishes a connection to a Weaviate Cloud cluster using a custom client maker function and context.

```APIDOC
## connectToWeaviateCloud<C, TMedia>(clusterURL, clientMaker, context, options)

### Description
Connects to a Weaviate Cloud instance by utilizing a provided client factory function and context.

### Signature
`connectToWeaviateCloud<C extends Context<TMedia>, TMedia>(clusterURL: string, clientMaker: (context: C, params: ClientParams) => Promise<IWeaviateClient<TMedia>>, context: C, options?: helpers.ConnectToWeaviateCloudOptions): Promise<IWeaviateClient<TMedia>>`

### Parameters
- **clusterURL** (string) - The URL of the Weaviate Cloud cluster.
- **clientMaker** (function) - A factory function that creates the IWeaviateClient instance.
- **context** (C) - The context object required for the client maker.
- **options** (helpers.ConnectToWeaviateCloudOptions) - Optional configuration settings for the connection.

### Returns
- **Promise<IWeaviateClient<TMedia>>** - A promise that resolves to the initialized Weaviate client.
```

--------------------------------

### constructor

Source: https://weaviate.github.io/typescript-client/classes/core_src.Iterator.html

Initializes a new instance of the Iterator class with a query function that fetches pages of Weaviate objects.

```APIDOC
## constructor

### Description
Creates a new Iterator instance. The query function provided must accept a limit and an optional after cursor string, returning a promise that resolves to an array of Weaviate objects.

### Signature
`new Iterator<T, V>(query: (limit: number, after?: string) => Promise<WeaviateObject<T, V>[]>)`

### Parameters
- **query** (function) - Required - A function that performs the data fetch: `(limit: number, after?: string) => Promise<WeaviateObject<T, V>[]>`
```

--------------------------------

### Vectorizer Configuration Methods

Source: https://weaviate.github.io/typescript-client/variables/node_src.configure.html

The configure object exposes various methods to create vectorizer configurations for different models such as text2Vec, multi2Vec, and ref2Vec.

```APIDOC
## Vectorizer Configuration

### Description
The `configure` object provides methods to define how data is vectorized within a Weaviate collection. These methods return a `VectorConfigCreate` object used during collection creation.

### Available Methods
- **text2VecModel2Vec(opts)**
- **text2VecNvidia(opts)**
- **text2VecOllama(opts)**
- **text2VecOpenAI(opts)**
- **text2VecPalm(opts)**
- **text2VecTransformers(opts)**
- **text2VecVoyageAI(opts)**
- **text2VecWeaviate(opts)**
- **img2VecNeural(opts)**
- **multi2VecBind(opts)**
- **multi2VecClip(opts)**
- **multi2VecCohere(opts)**
- **multi2VecGoogle(opts)**
- **multi2VecGoogleGemini(opts)**
- **multi2VecJinaAI(opts)**
- **multi2VecNvidia(opts)**
- **multi2VecTwelveLabs(opts)**
- **multi2VecVoyageAI(opts)**
- **none(opts)**
- **ref2VecCentroid(opts)**
- **selfProvided(opts)**
- **text2VecAWS(opts)**
- **text2VecAzureOpenAI(opts)**
- **text2VecCohere(opts)**
- **text2VecContextionary(opts)**

### Parameters
- **opts** (ConfigureTextVectorizerOptions | ConfigureNonTextVectorizerOptions) - Optional configuration object specific to the chosen vectorizer model.
```

--------------------------------

### Vectorization Configuration Methods

Source: https://weaviate.github.io/typescript-client/variables/core_src.configure.html

The configure object provides methods to define vectorization settings for specific providers. Each method accepts an options object to customize the model, quantizer, and index configuration.

```APIDOC
## configure.text2Vec[Provider]

### Description
Creates a vectorization configuration for a specific provider. These methods are used to define how data is vectorized within a Weaviate collection.

### Supported Providers
- text2VecGPT4All
- text2VecHuggingFace
- text2VecJinaAI
- text2VecMistral
- text2VecModel2Vec
- text2VecMorph
- text2VecNvidia
- text2VecOllama
- text2VecOpenAI
- text2VecTransformers
- text2VecVoyageAI
- text2VecWeaviate

### Parameters
- **opts** (Object) - Optional - Configuration options including:
  - **name** (string) - Optional - The name of the vectorizer.
  - **quantizer** (QuantizerConfigCreate) - Optional - Quantization settings.
  - **vectorIndexConfig** (ModuleConfig) - Optional - Vector index configuration.
  - **sourceProperties** (Array) - Optional - List of properties to vectorize.
```

--------------------------------

### connectToWCD / connectToWCS / connectToWeaviateCloud

Source: https://weaviate.github.io/typescript-client/variables/node_src.default.html

Establishes a connection to a Weaviate Cloud instance.

```APIDOC
## connectToWCD / connectToWCS / connectToWeaviateCloud

### Description
Connects to a Weaviate Cloud instance using the cluster URL and optional configuration.

### Signature
`connectToWCD(clusterURL: string, options?: ConnectToWeaviateCloudOptions): Promise<WeaviateClient>`
`connectToWCS(clusterURL: string, options?: ConnectToWeaviateCloudOptions): Promise<WeaviateClient>`
`connectToWeaviateCloud(clusterURL: string, options?: ConnectToWeaviateCloudOptions): Promise<WeaviateClient>`
```

--------------------------------

### flat

Source: https://weaviate.github.io/typescript-client/variables/node_src.vectorIndex.html

Creates a configuration object for a FLAT vector index.

```APIDOC
## flat(opts?: VectorIndexConfigFlatCreateOptions)

### Description
Creates a `ModuleConfig` object for a FLAT vector index. Use this when defining the `options.vectorIndexConfig` argument of the `configure.vectors` method.
```

--------------------------------

### Boost.timeDecay

Source: https://weaviate.github.io/typescript-client/classes/core_src.Boost.html

Creates a time decay boost configuration.

```APIDOC
## Boost.timeDecay

### Description
Creates a boost configuration based on time decay parameters.

### Signature
`static timeDecay(args: Omit<TimeDecay, "type"> & Pick<BoostOptions, "weight" | "depth">): BoostOptions`

### Parameters
- **args** (Omit<TimeDecay, "type"> & Pick<BoostOptions, "weight" | "depth">) - Required - Time decay parameters combined with weight and depth.
```

--------------------------------

### Vector Configuration Methods

Source: https://weaviate.github.io/typescript-client/variables/core_src.configure.html

Methods to create VectorConfigCreate objects for specific vectorizer modules.

```APIDOC
## SDK Methods: Vector Configuration

### Description
These methods are used to generate a `VectorConfigCreate` object, which defines the vectorizer module and its associated configuration for a Weaviate class.

### Methods
- `text2VecGoogle(opts)`: Configures 'text2vec-google'.
- `text2VecGPT4All(opts)`: Configures 'text2vec-gpt4all'.
- `text2VecHuggingFace(opts)`: Configures 'text2vec-huggingface'.
- `text2VecJinaAI(opts)`: Configures 'text2vec-jinaai'.
- `text2VecMistral(opts)`: Configures 'text2vec-mistral'.
- `text2VecModel2Vec(opts)`: Configures 'text2vec-model2vec'.
- `text2VecNvidia(opts)`: Configures 'text2vec-nvidia'.
- `text2VecOllama(opts)`: Configures 'text2vec-ollama'.
- `text2VecOpenAI(opts)`: Configures 'text2vec-openai'.
- `text2VecPalm(opts)`: Configures 'text2vec-palm'.

### Parameters
- **opts** (Object) - Optional - Configuration options including:
  - **name** (string) - Optional - Name of the vectorizer.
  - **quantizer** (QuantizerConfigCreate) - Optional - Quantization configuration.
  - **vectorIndexConfig** (ModuleConfig) - Optional - Vector index configuration.
  - **sourceProperties** (Array) - Optional - List of properties to use for vectorization.
```

--------------------------------

### Vectorization Configuration Methods

Source: https://weaviate.github.io/typescript-client/variables/core_src.configure.html

Methods for configuring text-to-vector modules including Ollama, OpenAI, PaLM, Transformers, VoyageAI, and Weaviate.

```APIDOC
## text2VecOllama

### Description
Configures the Ollama text-to-vector module for a collection.

### Parameters
- **opts** (Text2VecOllamaConfig) - Optional - Configuration options including name, quantizer, vectorIndexConfig, and sourceProperties.

## text2VecOpenAI

### Description
Configures the OpenAI text-to-vector module for a collection.

### Parameters
- **opts** (Text2VecOpenAIConfig) - Optional - Configuration options including name, quantizer, vectorIndexConfig, and sourceProperties.

## text2VecPalm

### Description
Configures the Google PaLM text-to-vector module for a collection.

### Parameters
- **opts** (Text2VecGoogleConfig) - Optional - Configuration options including name, quantizer, vectorIndexConfig, and sourceProperties.

## text2VecTransformers

### Description
Configures the Transformers text-to-vector module for a collection.

### Parameters
- **opts** (Text2VecTransformersConfig) - Optional - Configuration options including name, quantizer, vectorIndexConfig, and sourceProperties.

## text2VecVoyageAI

### Description
Configures the VoyageAI text-to-vector module for a collection.

### Parameters
- **opts** (Text2VecVoyageAIConfig) - Optional - Configuration options including name, quantizer, vectorIndexConfig, and sourceProperties.

## text2VecWeaviate

### Description
Configures the Weaviate native text-to-vector module for a collection.

### Parameters
- **opts** (Text2VecWeaviateConfig) - Optional - Configuration options including name, quantizer, vectorIndexConfig, and sourceProperties.
```

--------------------------------

### batch(collection: string, consistencyLevel?: ConsistencyLevel, tenant?: string)

Source: https://weaviate.github.io/typescript-client/classes/core_src.ConnectionGRPC.html

Initiates a batch operation for a specific collection.

```APIDOC
## batch

### Description
Initiates a batch operation for a specific collection.

### Parameters
- **collection** (string) - Required - The name of the collection.
- **consistencyLevel** (ConsistencyLevel) - Optional - The consistency level for the operation.
- **tenant** (string) - Optional - The tenant identifier.

### Returns
- **Promise<Batch>** - A promise that resolves to the batch handler.
```

--------------------------------

### backup(args)

Source: https://weaviate.github.io/typescript-client/variables/core_src.permissions.html

Creates a set of permissions specific to Weaviate's backup functionality.

```APIDOC
## backup(args)

### Description
Create a set of permissions specific to Weaviate's backup functionality. For all collections, provide the `collection` argument as `'*'`.

### Parameters
- **args** (object) - Required
  - **collection** (string | string[]) - Required
  - **manage** (boolean) - Optional
```

--------------------------------

### none

Source: https://weaviate.github.io/typescript-client/variables/node_src.vectors.html

Creates a VectorConfigCreate object with the vectorizer set to 'none'.

```APIDOC
## none

### Description
Creates a `VectorConfigCreate` object with the vectorizer set to 'none'.

### Signature
`none<N, I>(opts?: ConfigureNonTextVectorizerOptions<N, I, "none">) => VectorConfigCreate<never, N, I, "none">`
```

--------------------------------

### new ApiKey(apiKey: string)

Source: https://weaviate.github.io/typescript-client/classes/core_src.ApiKey.html

Creates a new instance of the ApiKey class to be used for authentication.

```APIDOC
## Constructor

### new ApiKey(apiKey: string)

Creates a new instance of the ApiKey class.

### Parameters
- **apiKey** (string) - The API key string used for authentication.

### Returns
- **ApiKey** - An instance of the ApiKey class.
```

--------------------------------

### generative.contextualai

Source: https://weaviate.github.io/typescript-client/variables/node_src.generative.html

Creates a configuration object for the ContextualAI generative module.

```APIDOC
## generative.contextualai(config?: GenerativeContextualAIConfigCreate)

### Description
Creates a `ModuleConfig` object for use when performing AI generation using the `generative-contextualai` module.

### Parameters
- **config** (GenerativeContextualAIConfigCreate) - Optional - The configuration settings for the ContextualAI generative module.
```

--------------------------------

### text2VecGoogleAiStudio

Source: https://weaviate.github.io/typescript-client/variables/core_src.configure.html

Creates a VectorConfigCreate object with the vectorizer set to 'text2vec-google' for AI Studio.

```APIDOC
## text2VecGoogleAiStudio

### Description
Creates a `VectorConfigCreate` object with the vectorizer set to `text2vec-google` with specific options for AI studio deployments.
```

--------------------------------

### connectToWCD(clusterURL, options)

Source: https://weaviate.github.io/typescript-client/functions/node_src.connectToWCD.html

Connects to a Weaviate Cloud (WCD) instance using the provided cluster URL and optional configuration.

```APIDOC
## connectToWCD

### Description
Connect to your own Weaviate Cloud (WCD) instance. This method is deprecated; please use `connectToWeaviateCloud` instead.

### Signature
`connectToWCD(clusterURL: string, options?: ConnectToWeaviateCloudOptions): Promise<WeaviateClient>`

### Parameters
- **clusterURL** (string) - Required - The URL of your WCD instance (e.g., https://example.weaviate.network).
- **options** (ConnectToWeaviateCloudOptions) - Optional - Additional options for the connection.

### Returns
- **Promise<WeaviateClient>** - A Promise that resolves to a client connected to your WCD instance.
```

--------------------------------

### Vector Configuration Methods

Source: https://weaviate.github.io/typescript-client/variables/core_src.configure.html

A collection of configuration methods for different text vectorization modules (e.g., OpenAI, HuggingFace, Mistral) used to initialize vector settings for a collection.

```APIDOC
## Vectorizer Configuration Methods

### Description
These methods are used to configure specific text vectorization modules when creating or updating a collection in Weaviate. Each method accepts an options object containing module-specific configuration, optional index naming, quantizer settings, and vector index configuration.

### Methods
- `text2VecDatabricks(opts)`
- `text2VecDigitalOcean(opts)`
- `text2VecGoogle(opts)`
- `text2VecGPT4All(opts)`
- `text2VecHuggingFace(opts)`
- `text2VecJinaAI(opts)`
- `text2VecMistral(opts)`
- `text2VecModel2Vec(opts)`
- `text2VecNvidia(opts)`
- `text2VecOllama(opts)`
- `text2VecOpenAI(opts)`
- `text2VecPalm(opts)`
- `text2VecTransformers(opts)`

### Parameters
- **opts** (Object) - Required/Optional depending on the module - Configuration object containing:
  - **name** (string) - Optional - The name of the vectorizer.
  - **quantizer** (QuantizerConfigCreate) - Optional - Configuration for vector quantization.
  - **vectorIndexConfig** (ModuleConfig) - Optional - Configuration for the vector index (e.g., HNSW).
  - **sourceProperties** (Array) - Optional - List of properties to be used for vectorization.
```

--------------------------------

### IWeaviateClient Methods

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.IWeaviateClient.html

Core methods available on the IWeaviateClient interface for interacting with the Weaviate instance.

```APIDOC
## close()

### Description
Closes the connection to the Weaviate instance.

### Signature
`close(): Promise<void>`

## getConnectionDetails()

### Description
Retrieves the current connection details.

### Signature
`getConnectionDetails(): Promise<ConnectionDetails>`

## getMeta()

### Description
Retrieves metadata about the Weaviate instance, including version and module information.

### Signature
`getMeta(): Promise<{ grpcMaxMessageSize?: number; hostname?: string; modules?: { [key: string]: unknown }; version?: string; }>`

## getWeaviateVersion()

### Description
Retrieves the version of the Weaviate database.

### Signature
`getWeaviateVersion(): Promise<DbVersion>`

## isLive()

### Description
Checks if the Weaviate instance is live.

### Signature
`isLive(): Promise<boolean>`

## isReady()

### Description
Checks if the Weaviate instance is ready to accept requests.

### Signature
`isReady(): Promise<boolean>`
```

--------------------------------

### createFromSchema

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.ICollections.html

Creates a collection from a schema configuration object.

```APIDOC
## createFromSchema(config: WeaviateClass)

### Description
Creates a collection using a provided Weaviate class configuration object.

### Parameters
- **config** (WeaviateClass) - Required - The configuration object for the class.

### Returns
- **Promise<ICollection>** - A promise that resolves to the created collection instance.
```

--------------------------------

### multiTenancy

Source: https://weaviate.github.io/typescript-client/variables/node_src.configure.html

Creates a MultiTenancyConfigCreate object to define multi-tenancy settings for a collection.

```APIDOC
## multiTenancy(options)

### Description
Create a `MultiTenancyConfigCreate` object to be used when defining the multi-tenancy configuration of your collection.

### Parameters
- **options** (object) - Optional
  - **autoTenantActivation** (boolean) - Optional
  - **autoTenantCreation** (boolean) - Optional
  - **enabled** (boolean) - Optional
```

--------------------------------

### anyscale(config?: GenerativeAnyscaleConfig)

Source: https://weaviate.github.io/typescript-client/variables/core_src.generative.html

Creates a configuration object for the generative-anyscale module.

```APIDOC
## anyscale(config?: GenerativeAnyscaleConfig)

### Description
Creates a `ModuleConfig<'generative-anyscale', GenerativeAnyscaleConfig | undefined>` object for use when performing AI generation using the `generative-anyscale` module.

### Parameters
- **config** (GenerativeAnyscaleConfig) - Optional - The configuration for the `generative-aws` module.

### Returns
- **ModuleConfig** - The configuration object for the generative-anyscale module.
```

--------------------------------

### permissions.backup

Source: https://weaviate.github.io/typescript-client/variables/node_src.default.html

Create a set of permissions specific to Weaviate's backup functionality.

```APIDOC
## permissions.backup

### Description
Create a set of permissions specific to Weaviate's backup functionality. For all collections, provide the collection argument as '*'.

### Parameters
- **args** (object) - Required
  - **collection** (string | string[]) - Required
  - **manage** (boolean) - Optional
```

--------------------------------

### connectToWeaviateCloud

Source: https://weaviate.github.io/typescript-client/variables/web_src.default.html

Establishes a connection to a Weaviate Cloud instance.

```APIDOC
## connectToWeaviateCloud

### Description
Connects to a Weaviate Cloud cluster using the cluster URL and optional configuration.

### Signature
`connectToWeaviateCloud(clusterURL: string, options?: ConnectToWeaviateCloudOptions) => Promise<WeaviateClient>`
```

--------------------------------

### reranker.contextualai

Source: https://weaviate.github.io/typescript-client/variables/core_src.reranker.html

Creates a configuration object for the reranker-contextualai module.

```APIDOC
## reranker.contextualai(config?: RerankerContextualAIConfig)

### Description
Creates a `ModuleConfig<'reranker-contextualai', RerankerContextualAIConfig>` object for use when reranking using the `reranker-contextualai` module.

### Parameters
- **config** (RerankerContextualAIConfig) - Optional - Configuration settings for the ContextualAI reranker.
```

--------------------------------

### replication

Source: https://weaviate.github.io/typescript-client/variables/web_src.default.html

Configures replication settings for the database.

```APIDOC
## replication

### Description
Sets the replication factor and asynchronous configuration for data nodes.

### Parameters
- **options** (Object) - Required - Replication settings including factor, deletionStrategy, and asyncConfig.
```

--------------------------------

### listAll

Source: https://weaviate.github.io/typescript-client/interfaces/core_src.ICollections.html

Lists all collections.

```APIDOC
## listAll()

### Description
Retrieves a list of all collection configurations.

### Returns
- **Promise<CollectionConfig[]>**
```

--------------------------------

### selfProvided

Source: https://weaviate.github.io/typescript-client/variables/node_src.vectors.html

Creates a VectorConfigCreate object with the vectorizer set to 'none'.

```APIDOC
## selfProvided

### Description
Create a `VectorConfigCreate` object with the vectorizer set to 'none'.

### Signature
`selfProvided<N extends string | undefined = undefined, I extends VectorIndexType = "hnsw">(opts?: ConfigureNonTextVectorizerOptions<N, I, "none">) => VectorConfigCreate<never, N, I, "none">`
```

--------------------------------

### configure.vectors.flat

Source: https://weaviate.github.io/typescript-client/variables/core_src.configure.html

Creates a configuration object for the FLAT vector index.

```APIDOC
## flat(opts?: VectorIndexConfigFlatCreateOptions)

### Description
Create a `ModuleConfig<'flat', VectorIndexConfigFlatCreate | undefined>` object when defining the configuration of the FLAT vector index. Use this method when defining the `options.vectorIndexConfig` argument of the `configure.vectors` method.
```

--------------------------------

### configure.generative

Source: https://weaviate.github.io/typescript-client/variables/node_src.configure.html

Methods for configuring generative AI modules such as OpenAI, Cohere, and others.

```APIDOC
## configure.generative

### Description
Provides methods to configure various generative AI modules for use with Weaviate.

### Methods
- **azureOpenAI(config: GenerativeAzureOpenAIConfigCreate)**
- **cohere(config?: GenerativeCohereConfigCreate)**
- **openAI(config?: GenerativeOpenAIConfigCreate)**
- **anthropic(config?: GenerativeAnthropicConfig)**
- **mistral(config?: GenerativeMistralConfig)**
- **ollama(config?: GenerativeOllamaConfig)**

### Usage
Use these methods to define the generative module configuration when creating or updating a class schema.
```

--------------------------------

### text2VecGPT4All

Source: https://weaviate.github.io/typescript-client/variables/core_src.configure.html

Creates a VectorConfigCreate object configured for the 'text2vec-gpt4all' module.

```APIDOC
## text2VecGPT4All

### Description
Creates a `VectorConfigCreate` object with the vectorizer set to 'text2vec-gpt4all'.

### Signature
`text2VecGPT4All<T, N, I>(opts?: Omit<Text2VecGPT4AllConfig & { name?: N; quantizer?: QuantizerConfigCreate; vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>; } & { sourceProperties?: PrimitiveKeys<T>[] }, "vectorizeCollectionName">) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-gpt4all">`
```

--------------------------------

### nvidia(config?: GenerativeNvidiaConfigRuntime)

Source: https://weaviate.github.io/typescript-client/variables/core_src.generativeParameters.html

Creates a configuration object for the generative-nvidia module.

```APIDOC
## nvidia(config)

### Description
Creates a `ModuleConfig` object for performing runtime-specific AI generation using the `generative-nvidia` module.

### Parameters
- **config** (GenerativeNvidiaConfigRuntime) - Optional - The configuration for the module.

### Returns
- **ModuleConfig** - The configuration object for the `generative-nvidia` module.
```

--------------------------------

### configure.objectTTL

Source: https://weaviate.github.io/typescript-client/variables/node_src.configure.html

Configures Time-To-Live (TTL) policies for objects.

```APIDOC
## configure.objectTTL

### Description
Defines how objects are automatically deleted based on time properties.

### Methods
- **deleteByCreationTime(options)**: Deletes objects based on creation time.
- **deleteByDateProperty(options)**: Deletes objects based on a specific date property.
- **deleteByUpdateTime(options)**: Deletes objects based on update time.
```

--------------------------------

### google(config?: GenerativeGoogleConfigRuntime)

Source: https://weaviate.github.io/typescript-client/variables/core_src.generativeParameters.html

Creates a ModuleConfig object for the generative-google module.

```APIDOC
## google(config?: GenerativeGoogleConfigRuntime)

### Description
Creates a `ModuleConfig` object for use when performing runtime-specific AI generation using the `generative-google` module.

### Parameters
- **config** (GenerativeGoogleConfigRuntime) - Optional - The configuration for the `generative-google` module.
```

--------------------------------

### friendliai(config?: GenerativeFriendliAIConfigRuntime)

Source: https://weaviate.github.io/typescript-client/variables/core_src.generativeParameters.html

Creates a configuration object for the generative-friendliai module.

```APIDOC
## friendliai(config)

### Description
Creates a `ModuleConfig` object for performing runtime-specific AI generation using the `generative-friendliai` module.

### Parameters
- **config** (GenerativeFriendliAIConfigRuntime) - Optional - The configuration for the module.

### Returns
- **ModuleConfig** - The configuration object for the `generative-friendliai` module.
```

--------------------------------

### selfProvided

Source: https://weaviate.github.io/typescript-client/variables/core_src.multiVectors.html

Creates a multi-vector VectorConfigCreate object with the vectorizer set to 'none'.

```APIDOC
## selfProvided

### Description
Create a multi-vector `VectorConfigCreate` object with the vectorizer set to 'none'.

### Signature
`selfProvided<T, N, I>(opts?: ConfigureNonTextMultiVectorizerOptions<N, I, "none">) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "none">`
```

--------------------------------

### vectorIndex.quantizer.pq

Source: https://weaviate.github.io/typescript-client/variables/core_src.vectorIndex.html

Configures Product Quantization (PQ) for the vector index.

```APIDOC
## vectorIndex.quantizer.pq(options?: { bitCompression?: boolean; centroids?: number; encoder?: { distribution?: PQEncoderDistribution; type?: PQEncoderType }; segments?: number; trainingLimit?: number; })

### Description
Creates a configuration object for Product Quantization (PQ) to optimize memory usage and search performance.

### Parameters
- **options** (Object) - Optional - Configuration settings for PQ, including bit compression, centroid count, encoder settings, segments, and training limits.
```

--------------------------------

### Boost.blend

Source: https://weaviate.github.io/typescript-client/classes/core_src.Boost.html

Combines multiple boost options into a single boost configuration.

```APIDOC
## Boost.blend

### Description
Combines an array of boost options with specified weight and depth settings.

### Signature
`static blend(boosts: BoostOptions[], options: Pick<BoostOptions, "weight" | "depth">): BoostOptions`

### Parameters
- **boosts** (BoostOptions[]) - Required - An array of boost configurations to blend.
- **options** (Pick<BoostOptions, "weight" | "depth">) - Required - The weight and depth settings for the blended result.
```
Tokens:
Raw