### get

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

Retrieves data from the Weaviate instance.

```APIDOC
## GET [PATH]

### Description
Retrieves data from the Weaviate instance.

### Method
GET

### Endpoint
[PATH]

### Parameters
#### Path Parameters
- **path** (string) - Required - The path to the resource to retrieve.

#### Query Parameters
- **expectReturnContent** (boolean) - Optional - Whether to expect a return content. Defaults to true.
```

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

### get()

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

Sends a GET request to the specified path.

```APIDOC
## get<T>(path: string, expectReturnContent?: boolean): Promise<T>

### Type Parameters
- **T**: The expected type of the response data.

### Parameters
- **path**: string - The path to send the GET request to.
- **expectReturnContent**: boolean - Optional. If true, the response content is expected. Defaults to true.

### Returns
- Promise<T> - A promise that resolves with the response data of type T.
```

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

### Constructor

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

Initializes a new instance of the ConnectionGQL class.

```APIDOC
## new ConnectionGQL(params: InternalConnectionParams): ConnectionGQL

### Parameters
- **params**: InternalConnectionParams - The parameters for the connection.

### Returns
- ConnectionGQL - The new instance of ConnectionGQL.
```

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

### nodes

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

Get the status of all nodes in the cluster.

```APIDOC
## nodes

### Description
Get the status of all nodes in the cluster.

### Method
(Implicitly a method call on the Cluster interface)

### Parameters
- `opts` (NodesOptions) - Optional - The options for the request.

### Returns
Promise<Node<O>[]>
- The status of all nodes in the cluster.
```

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

### Client Initialization

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

Function to initialize and configure the Weaviate client.

```APIDOC
## client client

### Description
Initializes and returns a new Weaviate client instance with the provided parameters.

### Method
`client(params: ClientParams) => Promise<WeaviateClient>`

### Parameters
* **params** (ClientParams) - Required - Configuration parameters for the client.
```

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

### connectToCustom

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

Establishes a connection to a custom Weaviate instance.

```APIDOC
## connectToCustom

### Description
Establishes a connection to a custom Weaviate instance.

### Method
```typescript
connectToCustom(options: ConnectToCustomOptions) => Promise<WeaviateClient>
```
```

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

### Get Collection Configuration

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

Retrieves the current configuration of the collection from Weaviate.

```APIDOC
## get

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

### Method
`get`

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

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

### login()

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

Logs in to the Weaviate instance.

```APIDOC
## login(): Promise<string>

### Returns
- Promise<string> - A promise that resolves with the authentication token.
```

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

### google

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

Create a ModuleConfig for using Google for generative tasks.

```APIDOC
## google

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

### Method
```typescript
google(config?: GenerativeGoogleConfig): ModuleConfig<'generative-google', GenerativeGoogleConfig | undefined>
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **config** (GenerativeGoogleConfig | undefined) - The configuration object for Google.

### Response Example
```json
{
  "example": "response body"
}
```
```

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

### get

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

Retrieves a collection by its name. Supports generic type parameters for properties and name.

```APIDOC
## get

### Description
Retrieves a collection by its name.

### Method
get

### Parameters
#### Parameters
- **name**: TName - The name of the collection to retrieve.

### Returns
Collection<TProperties, TName> - The Collection object for the specified collection.
```

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

### create

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

Creates a new collection with the specified configuration. Supports generic type parameters for properties, name, and vectors.

```APIDOC
## create

### Description
Creates a new collection with the specified configuration.

### Method
create

### Parameters
#### Parameters
- **config**: CollectionConfigCreate<TProperties, TName, TVectors> - The configuration object for the collection to be created.

### Returns
Promise<Collection<TProperties, TName, TVectors>> - A promise that resolves to the newly created Collection object.
```

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

### Get All Tenants

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

Retrieves all tenants currently associated with a collection. The collection must have been created with multi-tenancy enabled.

```APIDOC
## get tenants

### Description
Return all tenants currently associated with a collection in Weaviate. The collection must have been created with multi-tenancy enabled.
For details on the new activity statuses, see the docstring for the `Tenants` interface type.

### Method
get

### Response
#### Success Response (200)
- **Record<string, Tenant>** - A list of tenants as an object of Tenant types, where the key is the tenant name.
```

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

### Get a Collection

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

Retrieves a specific collection by its name. This method is generic and allows specifying the properties and name of the collection.

```APIDOC
## get

### Description
Retrieves a specific collection by its name.

### Method
get<TProperties extends Properties | undefined = undefined, TName extends string = string>(
  name: TName,
): Collection<TProperties, TName>

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

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

### listAll

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

Retrieves a list of all available collection configurations.

```APIDOC
## listAll

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

### Method
listAll

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

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

### Get Tenant by Name

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

Retrieves a specific tenant from a collection by its name. The collection must have been created with multi-tenancy enabled.

```APIDOC
## getByName tenant

### Description
Return the specified tenant from a collection in Weaviate. The collection must have been created with multi-tenancy enabled.
For details on the new activity statuses, see the docstring for the `Tenants` interface type.

### Method
getByName

### Parameters
#### Path Parameters
- **name** (string | T) - Required - The name of the tenant to retrieve.

### Type Parameters
- **T** extends TenantBase

### Response
#### Success Response (200)
- **Tenant | null** - The tenant as a Tenant type, or null if the tenant does not exist.
```

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

### Configure Quantizer - RQ

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

Create an RQConfigUpdate object for updating the quantizer configuration.

```APIDOC
## quantizer.rq

### Description
Create an object of type `RQConfigUpdate` to be used when updating the quantizer configuration of a vector index. NOTE: If the vector index already has a quantizer configured, you cannot change its quantizer type; only its values. So if you want to change the quantizer type, you must recreate the collection.

### Method
`rq(options?: { rescoreLimit?: number })`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **rqConfigUpdate** (RQConfigUpdate) - The RQ quantizer configuration update object.

### Response Example
None
```

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

### metrics<T>()

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

Initializes the metrics manager for a given data type T. It provides an aggregate method to start data aggregation.

```APIDOC
## metrics<T>()

### Description
Initializes the metrics manager for a given data type T. It provides an aggregate method to start data aggregation.

### Type Parameters
* T - The type of the data to be managed.

### Returns
An object with an `aggregate` method.

#### aggregate<P extends string>(property: P)

##### Description
Aggregates metrics based on the specified property.

##### Parameters
* **property** (P) - Required - The property to aggregate metrics on.

##### Returns
A MetricsManager instance for the specified property.
```

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

### PQ Quantizer Configuration

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

Create a `PQConfigCreate` object for vector index quantizer configuration.

```APIDOC
## quantizer.pq

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

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

### Parameters
#### Optional Parameters
- **options** (`{ bitCompression?: boolean; centroids?: number; encoder?: { distribution?: PQEncoderDistribution; type?: PQEncoderType }; segments?: number; trainingLimit?: number }`)
  - **bitCompression** (`boolean`)
  - **centroids** (`number`)
  - **encoder** (`{ distribution?: PQEncoderDistribution; type?: PQEncoderType }`)
    - **distribution** (`PQEncoderDistribution`)
    - **type** (`PQEncoderType`)
  - **segments** (`number`)
  - **trainingLimit** (`number`)
```

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

### Configure Quantizer - PQ

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

Create a PQConfigUpdate object for updating the quantizer configuration.

```APIDOC
## quantizer.pq

### Description
Create an object of type `PQConfigUpdate` to be used when updating the quantizer configuration of a vector index. NOTE: If the vector index already has a quantizer configured, you cannot change its quantizer type; only its values. So if you want to change the quantizer type, you must recreate the collection.

### Method
`pq(options?: { centroids?: number; pqEncoderDistribution?: PQEncoderDistribution; pqEncoderType?: PQEncoderType; segments?: number; trainingLimit?: number })`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **pqConfigUpdate** (PQConfigUpdate) - The PQ quantizer configuration update object.

### Response Example
None
```

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

### Get Replication Operation by ID

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

Retrieves a specific replication operation by its unique ID. Optionally includes historical status information.

```APIDOC
## Get Replication Operation by ID

### Description
Retrieves a specific replication operation by its unique ID. Optionally includes historical status information.

### Method
GET (assumed, based on function signature)

### Endpoint
`/v1/replication/{id}` (assumed, based on function signature)

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the replication operation to get.

#### Query Parameters
- **includeHistory** (boolean) - Optional - Whether to include the status history in the response.

### Response
#### Success Response (200)
- **collection** (string) - The name of the collection being replicated.
- **id** (string) - The unique identifier of the replication operation.
- **scheduledForCancel** (boolean) - Indicates if the operation is scheduled for cancellation.
- **scheduledForDelete** (boolean) - Indicates if the operation is scheduled for deletion.
- **shard** (string) - The name of the shard involved in the replication.
- **sourceNode** (string) - The identifier of the source node for the replication.
- **status** (object) - The current status of the replication operation.
  - **errors** (array) - A list of errors encountered during the operation.
    - **message** (string) - The error message.
    - **whenErroredUnixMs** (number) - The Unix timestamp in milliseconds when the error occurred.
  - **state** (string) - The current state of the operation (e.g., REGISTERED, HYDRATING, READY, CANCELLED).
  - **whenStartedUnixMs** (number) - The Unix timestamp in milliseconds when the operation started.
- **statusHistory** (array) - An array of historical status objects for the operation.
  - **errors** (array) - A list of errors encountered during this historical status period.
    - **message** (string) - The error message.
    - **whenErroredUnixMs** (number) - The Unix timestamp in milliseconds when the error occurred.
  - **state** (string) - The state of the operation during this historical period.
  - **whenStartedUnixMs** (number) - The Unix timestamp in milliseconds when this historical status began.
- **targetNode** (string) - The identifier of the target node for the replication.
- **type** (string) - The type of replication operation (COPY or MOVE).
- **uncancelable** (boolean) - Indicates if the operation cannot be canceled.
- **whenStartedUnixMs** (number) - The Unix timestamp in milliseconds when the operation was initiated.

#### Response Example
{
  "collection": "MyCollection",
  "id": "replication-123",
  "scheduledForCancel": false,
  "scheduledForDelete": false,
  "shard": "shard1",
  "sourceNode": "node1",
  "status": {
    "errors": [],
    "state": "READY",
    "whenStartedUnixMs": 1678886400000
  },
  "statusHistory": [
    {
      "errors": [],
      "state": "HYDRATING",
      "whenStartedUnixMs": 1678886300000
    }
  ],
  "targetNode": "node2",
  "type": "COPY",
  "uncancelable": false,
  "whenStartedUnixMs": 1678886300000
}

#### Null Response Example
null
```

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

### connectToLocal

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

Establishes a connection to a local Weaviate instance.

```APIDOC
## connectToLocal

### Description
Establishes a connection to a local Weaviate instance.

### Method
```typescript
connectToLocal(options?: ConnectToLocalOptions) => Promise<WeaviateClient>
```
```

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

### Get Replication Status

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

Retrieve the status and details of a specific replication operation by its ID. Optionally include historical status information.

```APIDOC
## get

### Description
Get a specific replication operation by ID.

### Method
```typescript
get: (
  id: string,
  opts?: { includeHistory?: boolean },
) => Promise<
  | {
      collection: string;
      id: string;
      scheduledForCancel: NonNullable<boolean | undefined>;
      scheduledForDelete: NonNullable<boolean | undefined>;
      shard: string;
      sourceNode: string;
      status: {
        errors: { message: string; whenErroredUnixMs: number }[];
        state: NonNullable<
          |
          "REGISTERED"
          |"HYDRATING"
          |"FINALIZING"
          |"DEHYDRATING"
          |"READY"
          |"CANCELLED"
          | undefined,
        >;
        whenStartedUnixMs: number;
      };
      statusHistory: {
        errors: { message: string; whenErroredUnixMs: number }[];
        state: NonNullable<
          |
          "REGISTERED"
          |"HYDRATING"
          |"FINALIZING"
          |"DEHYDRATING"
          |"READY"
          |"CANCELLED"
          | undefined,
        >;
        whenStartedUnixMs: number;
      }[];
      targetNode: string;
      type: NonNullable<"COPY" | "MOVE">;
      uncancelable: NonNullable<boolean | undefined>;
      whenStartedUnixMs: number;
    }
  | null,
>;
```

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the replication operation to retrieve.
#### Query Parameters
- **includeHistory** (boolean) - Optional - Whether to include the history of the replication status.
```

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

### BackupConfigCreate

Source: https://weaviate.github.io/typescript-client/types/BackupConfigCreate.html

Configuration options available when creating a backup.

```APIDOC
## Type Alias BackupConfigCreate

Configuration options available when creating a backup.

type BackupConfigCreate = {
  chunkSize?: number;
  compressionLevel?: BackupCompressionLevel;
  cpuPercentage?: number;
}

### Properties

*   **chunkSize** (`number`): Optional. Deprecated: This parameter no longer has any effect. (The size of the chunks to use for the backup.)
*   **compressionLevel** (`BackupCompressionLevel`): Optional. The standard of compression to use for the backup.
*   **cpuPercentage** (`number`): Optional. The percentage of CPU to use for the backup creation job.
```

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

### Get Shard Statuses

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

Retrieves the status of all shards for the collection. If the collection is multi-tenancy, this will return statuses for all tenants unless a specific tenant is specified.

```APIDOC
## getShards

### Description
Get the statuses of the shards of this collection. If the collection is multi-tenancy and you did not call `.with_tenant` then you will receive the statuses of all the tenants within the collection. Otherwise, call `.with_tenant` on the collection first and you will receive only that single shard.

### Method
`getShards`

### Returns
Promise<Required<{ name?: string; status?: string; vectorQueueSize?: number }>[]>
A promise that resolves with the shard statuses.
```

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

### connectToLocal

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

Connects to a locally-deployed Weaviate instance, for example, as a Docker compose stack. It returns a Promise that resolves to a client connected to your local Weaviate instance.

```APIDOC
## connectToLocal

### Description
Connect to a locally-deployed Weaviate instance, e.g. as a Docker compose stack.

### Signature
`connectToLocal(options?: ConnectToLocalOptions): Promise<WeaviateClient>`

### Parameters
#### options (ConnectToLocalOptions) - Optional
Options for the connection.

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

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

### RQ Quantizer Configuration

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

Create an `RQConfigCreate` object for vector index quantizer configuration.

```APIDOC
## quantizer.rq

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

### Method
`rq(options?: { bits?: number; rescoreLimit?: number })`

### Parameters
#### Optional Parameters
- **options** (`{ bits?: number; rescoreLimit?: number }`)
  - **bits** (`number`)
  - **rescoreLimit** (`number`)
```

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

### nearText

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

Search for objects in a collection by text using text-capable vectorization modules. This method supports searches with and without the `groupBy` parameter, and with programmatically defined options. A text-capable vectorization module must be installed.

```APIDOC
## nearText

### Description
Search for objects in this collection by text using text-capable vectorization module and vector-based similarity search. You must have a text-capable vectorization module installed in order to use this method, e.g. any of the `text2vec-` and `multi2vec-` modules.
See the docs for a more detailed explanation.
This overload is for performing a search without the `groupBy` param.

### Type Parameters
* I extends IncludeVector<V>
* RV

### Parameters
* query: string | string[]
The text query to search for.
* `Optional`opts: BaseNearTextOptions<T, V, I>
The available options for the search excluding the `groupBy` param.
* `Optional`callOpts: CallOptions
The available options for the API call.

### Returns Promise<WeaviateReturn<T, RV>>
* The result of the search within the fetched collection.
```

```APIDOC
## nearText (with groupBy)

### Description
Search for objects in this collection by text using text-capable vectorization module and vector-based similarity search. You must have a text-capable vectorization module installed in order to use this method, e.g. any of the `text2vec-` and `multi2vec-` modules.
See the docs for a more detailed explanation.
This overload is for performing a search with the `groupBy` param.

### Type Parameters
* I extends IncludeVector<V>
* RV

### Parameters
* query: string | string[]
The text query to search for.
* opts: GroupByNearTextOptions<T, V, I>
The available options for the search including the `groupBy` param.
* `Optional`callOpts: CallOptions
The available options for the API call.

### Returns Promise<GroupByReturn<T, RV>>
* The group by result of the search within the fetched collection.
```

```APIDOC
## nearText (programmatic options)

### Description
Search for objects in this collection by text using text-capable vectorization module and vector-based similarity search. You must have a text-capable vectorization module installed in order to use this method, e.g. any of the `text2vec-` and `multi2vec-` modules.
See the docs for a more detailed explanation.
This overload is for performing a search with a programmatically defined `opts` param.

### Type Parameters
* I extends IncludeVector<V>
* RV

### Parameters
* query: string | string[]
The text query to search for.
* `Optional`opts: NearTextOptions<T, V, I>
The available options for the search.
* `Optional`callOpts: CallOptions
The available options for the API call.

### Returns QueryReturn<T, RV>
* The result of the search within the fetched collection.
```

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

### login

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

Logs in to the Weaviate instance.

```APIDOC
## POST /api/v1/connection/login

### Description
Logs in to the Weaviate instance.

### Method
POST

### Endpoint
/api/v1/connection/login

### Returns
#### Success Response (200)
- **string** - A token representing the authenticated session.
```

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

### connectToCustom

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

Connect to a custom Weaviate deployment, such as your own self-hosted Kubernetes cluster.

```APIDOC
## connectToCustom

### Description
Connect to a custom Weaviate deployment, e.g. your own 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.
```

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

### Configure Generative AI Modules

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

Set up various generative AI modules like OpenAI, Azure OpenAI, Cohere, and more. Each module requires specific configuration objects to function.

```typescript
generative: {
  azureOpenAI: (
    config: GenerativeAzureOpenAIConfigCreate,
  ) => ModuleConfig<"generative-openai", GenerativeAzureOpenAIConfig>;
  cohere: (
    config?: GenerativeCohereConfigCreate,
  ) => ModuleConfig<
    "generative-cohere",
    GenerativeCohereConfig
    | undefined,
  >;
  contextualai: (
    config?: GenerativeContextualAIConfigCreate,
  ) => ModuleConfig<
    "generative-contextualai",
    GenerativeContextualAIConfig
    | undefined,
  >;
  databricks: (
    config: GenerativeDatabricksConfig,
  ) => ModuleConfig<"generative-databricks", GenerativeDatabricksConfig>;
  google: (
    config?: GenerativeGoogleConfig,
  ) => ModuleConfig<
    "generative-google",
    GenerativeGoogleConfig
    | undefined,
  >;
  openAI: (
    config?: GenerativeOpenAIConfigCreate,
  ) => ModuleConfig<
    "generative-openai",
    GenerativeOpenAIConfig
    | undefined,
  >;
  palm: (
    config?: GenerativeGoogleConfig,
  ) => ModuleConfig<"generative-palm", GenerativeGoogleConfig | undefined>;
  xai: (
    config?: GenerativeXAIConfig,
  ) => ModuleConfig<"generative-xai", GenerativeXAIConfig | undefined>;
  anthropic(
    config?: GenerativeAnthropicConfig,
  ): ModuleConfig<
    "generative-anthropic",
    GenerativeAnthropicConfig
    | undefined,
  >;
  anyscale(
    config?: GenerativeAnyscaleConfig,
  ): ModuleConfig<
    "generative-anyscale",
    GenerativeAnyscaleConfig
    | undefined,
  >;
  aws(
    config: GenerativeAWSConfig,
  ): ModuleConfig<"generative-aws", GenerativeAWSConfig>;
  friendliai(
    config?: GenerativeFriendliAIConfig,
  ): ModuleConfig<
    "generative-friendliai",
    GenerativeFriendliAIConfig
    | undefined,
  >;
  mistral(
    config?: GenerativeMistralConfig,
  ): ModuleConfig<
    "generative-mistral",
    GenerativeMistralConfig
    | undefined,
  >;
  nvidia(
    config?: GenerativeNvidiaConfig,
  ): ModuleConfig<"generative-nvidia", GenerativeNvidiaConfig | undefined>;
  ollama(
    config?: GenerativeOllamaConfig,
  ): ModuleConfig<"generative-ollama", GenerativeOllamaConfig | undefined>;
};
```

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

### text2VecAzureOpenAI

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

Create a `VectorConfigCreate` object with the text2VecAzureOpenAI vectorizer.

```APIDOC
## text2VecAzureOpenAI

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

### Method Signature
```typescript
text2VecAzureOpenAI<T, N extends string | undefined = undefined, I extends string = "hnsw">( 
  opts: ConfigureTextVectorizerOptions<T, N, I, "text2vec-azure-openai">
) => VectorConfigCreate<PrimitiveKeys<T>, N, I, "text2vec-azure-openai">
```

### Parameters
- `opts` (ConfigureTextVectorizerOptions): Required configuration options for the text2VecAzureOpenAI vectorizer.
```

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

### isPQ Static Method

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

Checks if the provided configuration is a Product Quantization (PQ) configuration.

```APIDOC
## `Static`isPQ
  * isPQ(config?: QuantizerConfig): config is PQConfig

### Parameters
    * `Optional`config: QuantizerConfig

### Returns config is PQConfig
```

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

### List All Collections

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

Fetches a list of all collection configurations available in the Weaviate instance.

```APIDOC
## listAll

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

### Method
listAll(): Promise<CollectionConfig[]>

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

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

### ReferenceConfigBaseCreate<T>

Source: https://weaviate.github.io/typescript-client/types/ReferenceConfigBaseCreate.html

The base class for creating a reference configuration. It includes an optional description and a required name, which can be a string or a union of keys depending on the generic type T.

```APIDOC
## Type Alias ReferenceConfigBaseCreate<T>

The base class for creating a reference configuration.

type ReferenceConfigBaseCreate<T> = {
  description?: string;
  name: T extends undefined ? string : RefKeys<T>;
}

### Type Parameters

* T

### Properties

#### `Optional` description

description?: string

The description of the reference.

#### name

name: T extends undefined ? string : RefKeys<T>

The name of the reference. If no generic passed, the type is string. If a generic is passed, the type is a union of the keys labelled as CrossReference.
```

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

### use

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

Selects an existing collection to interact with. Supports generic type parameters for properties, name, and vectors.

```APIDOC
## use

### Description
Selects an existing collection to interact with.

### Method
use

### Parameters
#### Parameters
- **name**: TName - The name of the collection to use.

### Returns
Collection<TProperties, TName, TVectors> - The Collection object for the specified collection.
```

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

### Configure Quantizer - SQ

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

Create an SQConfigUpdate object for updating the quantizer configuration.

```APIDOC
## quantizer.sq

### Description
Create an object of type `SQConfigUpdate` to be used when updating the quantizer configuration of a vector index. NOTE: If the vector index already has a quantizer configured, you cannot change its quantizer type; only its values. So if you want to change the quantizer type, you must recreate the collection.

### Method
`sq(options?: { rescoreLimit?: number; trainingLimit?: number })`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **sqConfigUpdate** (SQConfigUpdate) - The SQ quantizer configuration update object.

### Response Example
None
```

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

### Multi-Tenancy Configuration

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

Create a `MultiTenancyConfigUpdate` object for updating the multi-tenancy configuration.

```APIDOC
## multiTenancy
### Description
Create a `MultiTenancyConfigUpdate` object to be used when updating the multi-tenancy configuration of Weaviate. Note: You cannot update a single-tenant collection to become a multi-tenant collection. You must instead create a new multi-tenant collection and migrate the data over manually.
### Parameters
- `options` (object) - Required - Configuration options for multi-tenancy.
  - `autoTenantActivation` (boolean) - Optional
  - `autoTenantCreation` (boolean) - Optional
### Returns
MultiTenancyConfigUpdate
```

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

### Quantizer Constructor

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

Initializes a new instance of the Quantizer class.

```APIDOC
## constructor
  * new Quantizer(): Quantizer

### Returns Quantizer
```

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

### Configure Quantizer - BQ

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

Create a BQConfigUpdate object for updating the quantizer configuration.

```APIDOC
## quantizer.bq

### Description
Create an object of type `BQConfigUpdate` to be used when updating the quantizer configuration of a vector index. NOTE: If the vector index already has a quantizer configured, you cannot change its quantizer type; only its values. So if you want to change the quantizer type, you must recreate the collection.

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

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **bqConfigUpdate** (BQConfigUpdate) - The BQ quantizer configuration update object.

### Response Example
None
```

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

### Properties

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

Exposes properties of the ConnectionGQL instance.

```APIDOC
## Properties

### `Protected` authEnabled
- **authEnabled**: boolean - Indicates if authentication is enabled.

### `Readonly` host
- **host**: string - The host address of the Weaviate instance.

### `Readonly` http
- **http**: HttpClient - The HTTP client instance used for communication.

### `Optional` oidcAuth
- **oidcAuth?**: OidcAuthenticator - Optional OIDC authenticator instance.
```

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

### ApiKey Constructor

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

Initializes a new instance of the ApiKey class.

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

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

### Parameters
#### Path Parameters
- **apiKey** (string) - Required - The API key string.
```

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

### Create Collection

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

Creates a new collection with specified properties and configurations.

```APIDOC
## POST /collections

### Description
Creates a new collection with the specified name, properties, and configurations.

### Method
POST

### Endpoint
/collections

### Request Body
- **collection** (string) - Required - The name of the collection to create.
- **properties** (object) - Required - The schema defining the properties of the collection.
  - **dataType** (string[]) - Optional - The data types of the properties.
  - **description** (string) - Optional - A description of the property.
  - **indexFilterable** (boolean) - Optional - Whether the property is indexable for filtering.
  - **indexSearchable** (boolean) - Optional - Whether the property is indexable for searching.
  - **indexRangeFilters** (boolean) - Optional - Whether the property supports range filters.
  - **tokenization** (string) - Optional - The tokenization method for text properties.
  - **nestedProperties** (array) - Optional - Defines nested properties within a property.
  - **textAnalyzer** (object) - Optional - Configuration for text analysis.
    - **asciiFold** (boolean) - Optional - Enables ASCII folding.
    - **asciiFoldIgnore** (string[]) - Optional - List of characters to ignore during ASCII folding.
    - **stopwordPreset** (string) - Optional - Specifies a stopword preset.
- **replicationConfig** (object) - Optional - Configuration for data replication.
  - **asyncConfig** (object) - Optional - Asynchronous replication configuration.
  - **asyncEnabled** (boolean) - Optional - Enables asynchronous replication.
  - **deletionStrategy** (string) - Optional - Strategy for handling deletions during replication.
  - **factor** (number) - Optional - Replication factor.
- **shardingConfig** (object) - Optional - Configuration for data sharding.
- **vectorConfig** (object) - Optional - Configuration for vector indexing.
  - **vectorIndexType** (string) - Optional - The type of vector index.
  - **vectorIndexConfig** (object) - Optional - Configuration for the vector index.
  - **vectorizer** (string) - Optional - The vectorizer to use.
```

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

### Multi-Tenancy Configuration

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

Configure multi-tenancy settings for automatic tenant activation and creation.

```APIDOC
## Multi-Tenancy Configuration

- **Method**: `multiTenancy`
- **Description**: Configure multi-tenancy settings.
- **Parameters**:
  - `options` (object) - Required - Options for multi-tenancy.
    - `autoTenantActivation` (boolean) - Optional - Enable automatic tenant activation.
    - `autoTenantCreation` (boolean) - Optional - Enable automatic tenant creation.
```

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

### none

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

Create a `VectorConfigCreate` object with the vectorizer set to `'none'`, meaning no vectorization will be performed by Weaviate.

```APIDOC
## none

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

### Method Signature
```typescript
none<N extends string | undefined = undefined, I extends string = "hnsw">( 
  opts?: {
    name?: N;
    quantizer?: QuantizerConfigCreate;
    vectorIndexConfig?: ModuleConfig<I, VectorIndexConfigCreateType<I>>;
  }
) => VectorConfigCreate<never, N, I, "none">
```

### Parameters
- `opts` (object, optional): Configuration options.
  - `name` (string | undefined, optional): The name of the vectorizer.
  - `quantizer` (QuantizerConfigCreate, optional): Configuration for the quantizer.
  - `vectorIndexConfig` (ModuleConfig<I, VectorIndexConfigCreateType<I>>, optional): Configuration for the vector index.
```

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

### create

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

Creates a backup of the specified collection. This operation can be canceled or fail.

```APIDOC
## create

### Description
Create a backup of this collection.

### Method
create

### Parameters
#### Path Parameters
None

#### Query Parameters
None

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

### Request Example
```typescript
// Example usage (assuming client and collectionName are defined)
await client.backup.create(collectionName, {
  // backup specific arguments if any
});
```

### Response
#### Success Response (200)
* **BackupReturn** - The response from Weaviate.

#### Response Example
```json
{
  "status": "SUCCESS"
}
```

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

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

### BQ Quantizer Configuration

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

Create a `BQConfigCreate` object for vector index quantizer configuration.

```APIDOC
## quantizer.bq

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

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

### Parameters
#### Optional Parameters
- **options** (`{ cache?: boolean; rescoreLimit?: number }`)
  - **cache** (`boolean`)
  - **rescoreLimit** (`number`)
```

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

### Configure Generative Models

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

Set up default configurations for various generative models like Azure OpenAI, Cohere, Google, and more. This allows for easy integration with different LLM providers.

```typescript
reconfigure: {
  generative: {
    azureOpenAI: (
      config: GenerativeAzureOpenAIConfigCreate,
    ) => ModuleConfig<"generative-openai", GenerativeAzureOpenAIConfig>;
    cohere: (
      config?: GenerativeCohereConfigCreate,
    ) => ModuleConfig<
      "generative-cohere",
      GenerativeCohereConfig
      | undefined,
    >;
    contextualai: (
      config?: GenerativeContextualAIConfigCreate,
    ) => ModuleConfig<
      "generative-contextualai",
      GenerativeContextualAIConfig
      | undefined,
    >;
    databricks: (
      config: GenerativeDatabricksConfig,
    ) => ModuleConfig<"generative-databricks", GenerativeDatabricksConfig>;
    google: (
      config?: GenerativeGoogleConfig,
    ) => ModuleConfig<
      "generative-google",
      GenerativeGoogleConfig
      | undefined,
    >;
    openAI: (
      config?: GenerativeOpenAIConfigCreate,
    ) => ModuleConfig<
      "generative-openai",
      GenerativeOpenAIConfig
      | undefined,
    >;
    palm: (
      config?: GenerativeGoogleConfig,
    ) => ModuleConfig<"generative-palm", GenerativeGoogleConfig | undefined>;
    xai: (
      config?: GenerativeXAIConfig,
    ) => ModuleConfig<"generative-xai", GenerativeXAIConfig | undefined>;
    anthropic(
      config?: GenerativeAnthropicConfig,
    ): ModuleConfig<
      "generative-anthropic",
      GenerativeAnthropicConfig
      | undefined,
    >;
    anyscale(
      config?: GenerativeAnyscaleConfig,
    ): ModuleConfig<
      "generative-anyscale",
      GenerativeAnyscaleConfig
      | undefined,
    >;
    aws(
      config: GenerativeAWSConfig,
    ): ModuleConfig<"generative-aws", GenerativeAWSConfig>;
    friendliai(
      config?: GenerativeFriendliAIConfig,
    ): ModuleConfig<
      "generative-friendliai",
      GenerativeFriendliAIConfig
      | undefined,
    >;
    mistral(
      config?: GenerativeMistralConfig,
    ): ModuleConfig<
      "generative-mistral",
      GenerativeMistralConfig
      | undefined,
    >;
    nvidia(
      config?: GenerativeNvidiaConfig,
    ): ModuleConfig<"generative-nvidia", GenerativeNvidiaConfig | undefined>;
    ollama(
      config?: GenerativeOllamaConfig,
    ): ModuleConfig<"generative-ollama", GenerativeOllamaConfig | undefined>;
  };
};
```

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

### openAI

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

Create a ModuleConfig for using OpenAI for generative tasks.

```APIDOC
## openAI

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

### Method
```typescript
openAI(config?: GenerativeOpenAIConfigCreate): ModuleConfig<'generative-openai', GenerativeOpenAIConfig | undefined>
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **config** (GenerativeOpenAIConfig | undefined) - The configuration object for OpenAI.

### Response Example
```json
{
  "example": "response body"
}
```
```

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

### Configure Multi-Tenancy

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

Create a MultiTenancyConfigCreate object to configure the multi-tenancy settings for your collection. This allows for automatic tenant activation and creation.

```typescript
options?: {
  autoTenantActivation?: boolean;
  autoTenantCreation?: boolean;
  enabled?: boolean;
},
) => {
  autoTenantActivation?: boolean;
  autoTenantCreation?: boolean;
  enabled?: boolean;
}
```

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

### getCreateStatus

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

Retrieves the status of a backup creation process.

```APIDOC
## getCreateStatus

### Description
Get the status of a backup.

### Method
getCreateStatus

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **args** (BackupStatusArgs) - Required - The arguments for the request.

### Request Example
```typescript
// Example usage (assuming client and backupId are defined)
await client.backup.getCreateStatus(backupId);
```

### Response
#### Success Response (200)
* **BackupStatusReturn** - The status of the backup.

#### Response Example
```json
{
  "status": "PROCESSING"
}
```

### Throws
* If the input is invalid.
```

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

### postReturn()

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

Sends a POST request and expects a response.

```APIDOC
## postReturn<B, T>(path: string, payload: B): Promise<T>

### Type Parameters
- **B**: The type of the payload.
- **T**: The expected type of the response data.

### Parameters
- **path**: string - The path to send the POST request to.
- **payload**: B - The payload for the request.

### Returns
- Promise<T> - A promise that resolves with the response data of type T.
```

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

### SQ Quantizer Configuration

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

Create an `SQConfigCreate` object for vector index quantizer configuration.

```APIDOC
## quantizer.sq

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

### Method
`sq(options?: { rescoreLimit?: number; trainingLimit?: number })`

### Parameters
#### Optional Parameters
- **options** (`{ rescoreLimit?: number; trainingLimit?: number }`)
  - **rescoreLimit** (`number`)
  - **trainingLimit** (`number`)
```

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

### permissions.backup

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

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

```APIDOC
## permissions.backup

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

### Method
```typescript
backup: (
  args: { collection: string | string[]; manage?: boolean },
) => BackupsPermission[]
```
```

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

### Replication Configuration

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

Configure replication settings for your Weaviate instance, including asynchronous replication.

```APIDOC
## Replication

### Description
Configure replication settings for your Weaviate instance.

### Method
`replication(options: ReplicationOptions)`: Configures replication with specified options.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- `asyncConfig` (object) - Optional - Configuration for asynchronous replication.
  - `diffBatchSize` (number) - Optional - Batch size for diffing.
  - `diffPerNodeTimeout` (number) - Optional - Timeout for diffing per node.
  - `frequency` (number) - Optional - Frequency of replication.
  - `frequencyWhilePropagating` (number) - Optional - Frequency while propagating.
  - `hashtreeHeight` (number) - Optional - Height of the hash tree.
  - `loggingFrequency` (number) - Optional - Frequency of logging.
  - `prePropagationTimeout` (number) - Optional - Timeout before propagation.
  - `propagationBatchSize` (number) - Optional - Batch size for propagation.
  - `propagationConcurrency` (number) - Optional - Concurrency for propagation.
  - `propagationDelay` (number) - Optional - Delay for propagation.
  - `propagationLimit` (number) - Optional - Limit for propagation.
  - `propagationTimeout` (number) - Optional - Timeout for propagation.
- `asyncEnabled` (boolean) - Optional - Whether asynchronous replication is enabled.
- `deletionStrategy` (string) - Optional - Strategy for replication deletion.
- `factor` (number) - Optional - Replication factor.

### Response
#### Success Response (200)
- `asyncConfig` (object) - Configuration for asynchronous replication.
  - `diffBatchSize` (number) - Batch size for diffing.
  - `diffPerNodeTimeout` (number) - Timeout for diffing per node.
  - `frequency` (number) - Frequency of replication.
  - `frequencyWhilePropagating` (number) - Frequency while propagating.
  - `hashtreeHeight` (number) - Height of the hash tree.
  - `loggingFrequency` (number) - Frequency of logging.
  - `prePropagationTimeout` (number) - Timeout before propagation.
  - `propagationBatchSize` (number) - Batch size for propagation.
  - `propagationConcurrency` (number) - Concurrency for propagation.
  - `propagationDelay` (number) - Delay for propagation.
  - `propagationLimit` (number) - Limit for propagation.
  - `propagationTimeout` (number) - Timeout for propagation.
- `asyncEnabled` (boolean) - Whether asynchronous replication is enabled.
- `deletionStrategy` (string) - Strategy for replication deletion.
- `factor` (number) - Replication factor.
```