---
url: 'https://adk.nht.io/api/batteries/vector/redis/classes/RedisVectorStore.md'
---

# Class: RedisVectorStore

Defined in: [batteries/vector/redis/index.ts:144](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/redis/index.ts#L144)

## Extends

* [`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md)

## Constructors

### Constructor

```ts
new RedisVectorStore(options: BaseVectorStoreOptions): RedisVectorStore;
```

Defined in: [batteries/vector/contract.ts:35](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/contract.ts#L35)

#### Parameters

| Parameter | Type                                                                                                           |
| --------- | -------------------------------------------------------------------------------------------------------------- |
| `options` | [`BaseVectorStoreOptions`](../../../../@nhtio/adk/batteries/vector/types/interfaces/BaseVectorStoreOptions.md) |

#### Returns

`RedisVectorStore`

#### Inherited from

[`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`constructor`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#constructor)

## Properties

| Property                                          | Modifier   | Type                                                                                                             | Overrides                                                                                                                                                                                                            | Defined in                                                                                                                      |
| ------------------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
|  `capabilities` | `readonly` | [`VectorStoreCapabilities`](../../../../@nhtio/adk/batteries/vector/types/interfaces/VectorStoreCapabilities.md) | [`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`capabilities`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#property-capabilities) | [batteries/vector/redis/index.ts:145](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/redis/index.ts#L145) |

## Accessors

### schema

#### Get Signature

```ts
get schema(): VectorSchemaBuilder;
```

Defined in: [batteries/vector/contract.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/contract.ts#L64)

##### Returns

[`VectorSchemaBuilder`](../../../../@nhtio/adk/batteries/vector/schema/classes/VectorSchemaBuilder.md)

#### Inherited from

[`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`schema`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#schema)

## Methods

### asCallable()

```ts
asCallable(): CallableVectorStore;
```

Defined in: [batteries/vector/contract.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/contract.ts#L73)

#### Returns

[`CallableVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/type-aliases/CallableVectorStore.md)

#### Inherited from

[`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`asCallable`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#ascallable)

***

### close()

```ts
close(): Promise<void>;
```

Defined in: [batteries/vector/redis/index.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/redis/index.ts#L185)

#### Returns

`Promise`<`void`>

#### Overrides

[`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`close`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#close)

***

### connect()

```ts
connect(): Promise<void>;
```

Defined in: [batteries/vector/redis/index.ts:169](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/redis/index.ts#L169)

#### Returns

`Promise`<`void`>

#### Overrides

[`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`connect`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#connect)

***

### createCollection()

```ts
createCollection(spec: CollectionSpec, ifNotExists: boolean): Promise<void>;
```

Defined in: [batteries/vector/redis/index.ts:201](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/redis/index.ts#L201)

#### Parameters

| Parameter     | Type                                                                                          |
| ------------- | --------------------------------------------------------------------------------------------- |
| `spec`        | [`CollectionSpec`](../../../../@nhtio/adk/batteries/vector/plan/interfaces/CollectionSpec.md) |
| `ifNotExists` | `boolean`                                                                                     |

#### Returns

`Promise`<`void`>

#### Overrides

[`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`createCollection`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#createcollection)

***

### dropCollection()

```ts
dropCollection(collection: string, ifExists: boolean): Promise<void>;
```

Defined in: [batteries/vector/redis/index.ts:245](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/redis/index.ts#L245)

#### Parameters

| Parameter    | Type      |
| ------------ | --------- |
| `collection` | `string`  |
| `ifExists`   | `boolean` |

#### Returns

`Promise`<`void`>

#### Overrides

[`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`dropCollection`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#dropcollection)

***

### executeDelete()

```ts
executeDelete(plan: DeletePlan): Promise<void>;
```

Defined in: [batteries/vector/redis/index.ts:460](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/redis/index.ts#L460)

#### Parameters

| Parameter | Type                                                                                  |
| --------- | ------------------------------------------------------------------------------------- |
| `plan`    | [`DeletePlan`](../../../../@nhtio/adk/batteries/vector/plan/interfaces/DeletePlan.md) |

#### Returns

`Promise`<`void`>

#### Overrides

[`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`executeDelete`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#executedelete)

***

### executeSearch()

```ts
executeSearch(plan: SearchPlan): Promise<VectorMatch[]>;
```

Defined in: [batteries/vector/redis/index.ts:320](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/redis/index.ts#L320)

#### Parameters

| Parameter | Type                                                                                  |
| --------- | ------------------------------------------------------------------------------------- |
| `plan`    | [`SearchPlan`](../../../../@nhtio/adk/batteries/vector/plan/interfaces/SearchPlan.md) |

#### Returns

`Promise`<[`VectorMatch`](../../../../@nhtio/adk/batteries/vector/types/interfaces/VectorMatch.md)\[]>

#### Overrides

[`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`executeSearch`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#executesearch)

***

### executeUpsert()

```ts
executeUpsert(plan: UpsertPlan): Promise<void>;
```

Defined in: [batteries/vector/redis/index.ts:272](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/redis/index.ts#L272)

#### Parameters

| Parameter | Type                                                                                  |
| --------- | ------------------------------------------------------------------------------------- |
| `plan`    | [`UpsertPlan`](../../../../@nhtio/adk/batteries/vector/plan/interfaces/UpsertPlan.md) |

#### Returns

`Promise`<`void`>

#### Overrides

[`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`executeUpsert`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#executeupsert)

***

### hasCollection()

```ts
hasCollection(collection: string): Promise<boolean>;
```

Defined in: [batteries/vector/redis/index.ts:258](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/redis/index.ts#L258)

#### Parameters

| Parameter    | Type     |
| ------------ | -------- |
| `collection` | `string` |

#### Returns

`Promise`<`boolean`>

#### Overrides

[`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`hasCollection`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#hascollection)

***

### isAvailable()

```ts
isAvailable(): boolean;
```

Defined in: [batteries/vector/redis/index.ts:165](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/redis/index.ts#L165)

#### Returns

`boolean`

#### Overrides

[`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`isAvailable`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#isavailable)

***

### query()

```ts
query(collection: string): VectorQueryBuilder;
```

Defined in: [batteries/vector/contract.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/contract.ts#L68)

#### Parameters

| Parameter    | Type     |
| ------------ | -------- |
| `collection` | `string` |

#### Returns

[`VectorQueryBuilder`](../../../../@nhtio/adk/batteries/vector/builder/classes/VectorQueryBuilder.md)

#### Inherited from

[`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`query`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#query)

***

### renameCollection()

```ts
renameCollection(_from: string, _to: string): Promise<void>;
```

Defined in: [batteries/vector/redis/index.ts:268](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/redis/index.ts#L268)

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `_from`   | `string` |
| `_to`     | `string` |

#### Returns

`Promise`<`void`>

#### Overrides

[`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`renameCollection`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#renamecollection)

***

### transaction()

```ts
transaction(_fn: (tx: CallableVectorStore) => Promise<void>): Promise<void>;
```

Defined in: [batteries/vector/contract.ts:60](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/contract.ts#L60)

#### Parameters

| Parameter | Type                                                                                                                                         |
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `_fn`     | (`tx`: [`CallableVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/type-aliases/CallableVectorStore.md)) => `Promise`<`void`> |

#### Returns

`Promise`<`void`>

#### Inherited from

[`BaseVectorStore`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md).[`transaction`](../../../../@nhtio/adk/batteries/vector/contract/classes/BaseVectorStore.md#transaction)

***

### isAvailable()

```ts
static isAvailable(): boolean;
```

Defined in: [batteries/vector/redis/index.ts:162](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/redis/index.ts#L162)

#### Returns

`boolean`