---
url: >-
  https://adk.nht.io/api/@nhtio/adk/batteries/vector/builder/classes/VectorQueryBuilder.md
description: >-
  The where-clause surface of the query builder, factored out so a grouping
  callback can be handed a builder that only exposes filter methods (not
  `near*`/`select`/`limit` or the terminals).
---

# Class: VectorQueryBuilder

Defined in: [batteries/vector/builder.ts:246](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L246)

The where-clause surface of the query builder, factored out so a grouping callback can be handed
a builder that only exposes filter methods (not `near*`/`select`/`limit` or the terminals).

Chained `.where()` ANDs; the first `.orWhere()` snapshots the accumulated AND-list into the first
branch of an OR (knex semantics). Any of the where-methods also accepts a [FilterCallback](../type-aliases/FilterCallback.md)
to open a nested group, letting AND and OR mix to any depth.

## Extends

* [`FilterBuilder`](FilterBuilder.md)

## Implements

* `PromiseLike`<[`VectorMatch`](../../types/interfaces/VectorMatch.md)\[]>

## Constructors

### Constructor

```ts
new VectorQueryBuilder(
   sink: PlanSink,
   collection: string,
   defaultTopK: number): VectorQueryBuilder;
```

Defined in: [batteries/vector/builder.ts:256](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L256)

#### Parameters

| Parameter     | Type                                    |
| ------------- | --------------------------------------- |
| `sink`        | [`PlanSink`](../interfaces/PlanSink.md) |
| `collection`  | `string`                                |
| `defaultTopK` | `number`                                |

#### Returns

`VectorQueryBuilder`

#### Overrides

[`FilterBuilder`](FilterBuilder.md).[`constructor`](FilterBuilder.md#constructor)

## Methods

### andWhere()

#### Call Signature

```ts
andWhere(cb: FilterCallback): this;
```

Defined in: [batteries/vector/builder.ts:113](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L113)

##### Parameters

| Parameter | Type                                                  |
| --------- | ----------------------------------------------------- |
| `cb`      | [`FilterCallback`](../type-aliases/FilterCallback.md) |

##### Returns

`this`

##### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`andWhere`](FilterBuilder.md#andwhere)

#### Call Signature

```ts
andWhere(
   a: string,
   b?: unknown,
   c?: unknown): this;
```

Defined in: [batteries/vector/builder.ts:114](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L114)

##### Parameters

| Parameter | Type      |
| --------- | --------- |
| `a`       | `string`  |
| `b?`      | `unknown` |
| `c?`      | `unknown` |

##### Returns

`this`

##### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`andWhere`](FilterBuilder.md#andwhere)

#### Call Signature

```ts
andWhere(obj: Record<string, unknown>): this;
```

Defined in: [batteries/vector/builder.ts:115](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L115)

##### Parameters

| Parameter | Type                                                                                                               |
| --------- | ------------------------------------------------------------------------------------------------------------------ |
| `obj`     | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> |

##### Returns

`this`

##### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`andWhere`](FilterBuilder.md#andwhere)

***

### consistency()

```ts
consistency(mode: VectorConsistency): this;
```

Defined in: [batteries/vector/builder.ts:349](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L349)

Per-operation read-after-write override for the terminal `.upsert()` / `.delete()`.
Universal across adapters: strongly-consistent backends ignore it (no-op), so a chain
written for an eventually-consistent backend keeps working verbatim when the adapter is
swapped. Precedence: this > the store's `consistency` option > the adapter's declared
`capabilities.consistency.default`. See [VectorConsistency](../../types/type-aliases/VectorConsistency.md).

#### Parameters

| Parameter | Type                                                                 |
| --------- | -------------------------------------------------------------------- |
| `mode`    | [`VectorConsistency`](../../types/type-aliases/VectorConsistency.md) |

#### Returns

`this`

***

### delete()

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

Defined in: [batteries/vector/builder.ts:391](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L391)

#### Returns

`Promise`<`void`>

***

### limit()

```ts
limit(n: number): this;
```

Defined in: [batteries/vector/builder.ts:332](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L332)

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `n`       | `number` |

#### Returns

`this`

***

### nearId()

```ts
nearId(id: string): this;
```

Defined in: [batteries/vector/builder.ts:279](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L279)

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `id`      | `string` |

#### Returns

`this`

***

### nearText()

```ts
nearText(text: string): this;
```

Defined in: [batteries/vector/builder.ts:271](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L271)

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `text`    | `string` |

#### Returns

`this`

***

### nearVector()

```ts
nearVector(vector: number[]): this;
```

Defined in: [batteries/vector/builder.ts:263](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L263)

#### Parameters

| Parameter | Type       |
| --------- | ---------- |
| `vector`  | `number`\[] |

#### Returns

`this`

***

### offset()

```ts
offset(n: number): this;
```

Defined in: [batteries/vector/builder.ts:337](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L337)

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `n`       | `number` |

#### Returns

`this`

***

### orWhere()

#### Call Signature

```ts
orWhere(cb: FilterCallback): this;
```

Defined in: [batteries/vector/builder.ts:129](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L129)

##### Parameters

| Parameter | Type                                                  |
| --------- | ----------------------------------------------------- |
| `cb`      | [`FilterCallback`](../type-aliases/FilterCallback.md) |

##### Returns

`this`

##### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`orWhere`](FilterBuilder.md#orwhere)

#### Call Signature

```ts
orWhere(field: string, value: unknown): this;
```

Defined in: [batteries/vector/builder.ts:130](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L130)

##### Parameters

| Parameter | Type      |
| --------- | --------- |
| `field`   | `string`  |
| `value`   | `unknown` |

##### Returns

`this`

##### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`orWhere`](FilterBuilder.md#orwhere)

#### Call Signature

```ts
orWhere(
   field: string,
   op: FilterOperator,
   value: unknown): this;
```

Defined in: [batteries/vector/builder.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L131)

##### Parameters

| Parameter | Type                                                             |
| --------- | ---------------------------------------------------------------- |
| `field`   | `string`                                                         |
| `op`      | [`FilterOperator`](../../filters/type-aliases/FilterOperator.md) |
| `value`   | `unknown`                                                        |

##### Returns

`this`

##### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`orWhere`](FilterBuilder.md#orwhere)

***

### orWhereNot()

#### Call Signature

```ts
orWhereNot(cb: FilterCallback): this;
```

Defined in: [batteries/vector/builder.ts:159](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L159)

##### Parameters

| Parameter | Type                                                  |
| --------- | ----------------------------------------------------- |
| `cb`      | [`FilterCallback`](../type-aliases/FilterCallback.md) |

##### Returns

`this`

##### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`orWhereNot`](FilterBuilder.md#orwherenot)

#### Call Signature

```ts
orWhereNot(field: string, value: unknown): this;
```

Defined in: [batteries/vector/builder.ts:160](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L160)

##### Parameters

| Parameter | Type      |
| --------- | --------- |
| `field`   | `string`  |
| `value`   | `unknown` |

##### Returns

`this`

##### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`orWhereNot`](FilterBuilder.md#orwherenot)

***

### select()

```ts
select(...args: SelectArg[]): this;
```

Defined in: [batteries/vector/builder.ts:287](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L287)

#### Parameters

| Parameter | Type                                          |
| --------- | --------------------------------------------- |
| ...`args` | [`SelectArg`](../type-aliases/SelectArg.md)\[] |

#### Returns

`this`

***

### then()

```ts
then<TR1, TR2>(onfulfilled?:
  | ((value: VectorMatch[]) => TR1 | PromiseLike<TR1>)
| null, onrejected?: ((reason: unknown) => TR2 | PromiseLike<TR2>) | null): PromiseLike<TR1 | TR2>;
```

Defined in: [batteries/vector/builder.ts:354](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L354)

Attaches callbacks for the resolution and/or rejection of the Promise.

#### Type Parameters

| Type Parameter | Default type                                             |
| -------------- | -------------------------------------------------------- |
| `TR1`          | [`VectorMatch`](../../types/interfaces/VectorMatch.md)\[] |
| `TR2`          | `never`                                                  |

#### Parameters

| Parameter      | Type                                                                                                                  | Description                                           |
| -------------- | --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| `onfulfilled?` | | ((`value`: [`VectorMatch`](../../types/interfaces/VectorMatch.md)\[]) => `TR1` | `PromiseLike`<`TR1`>) | `null` | The callback to execute when the Promise is resolved. |
| `onrejected?`  | ((`reason`: `unknown`) => `TR2` | `PromiseLike`<`TR2`>) | `null`                                                  | The callback to execute when the Promise is rejected. |

#### Returns

`PromiseLike`<`TR1` | `TR2`>

A Promise for the completion of which ever callback is executed.

#### Implementation of

```ts
PromiseLike.then;
```

***

### upsert()

```ts
upsert(records: VectorRecord[]): Promise<void>;
```

Defined in: [batteries/vector/builder.ts:382](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L382)

#### Parameters

| Parameter | Type                                                       |
| --------- | ---------------------------------------------------------- |
| `records` | [`VectorRecord`](../../types/interfaces/VectorRecord.md)\[] |

#### Returns

`Promise`<`void`>

***

### where()

#### Call Signature

```ts
where(cb: FilterCallback): this;
```

Defined in: [batteries/vector/builder.ts:85](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L85)

##### Parameters

| Parameter | Type                                                  |
| --------- | ----------------------------------------------------- |
| `cb`      | [`FilterCallback`](../type-aliases/FilterCallback.md) |

##### Returns

`this`

##### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`where`](FilterBuilder.md#where)

#### Call Signature

```ts
where(
   a: string,
   b?: unknown,
   c?: unknown): this;
```

Defined in: [batteries/vector/builder.ts:86](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L86)

##### Parameters

| Parameter | Type      |
| --------- | --------- |
| `a`       | `string`  |
| `b?`      | `unknown` |
| `c?`      | `unknown` |

##### Returns

`this`

##### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`where`](FilterBuilder.md#where)

#### Call Signature

```ts
where(obj: Record<string, unknown>): this;
```

Defined in: [batteries/vector/builder.ts:87](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L87)

##### Parameters

| Parameter | Type                                                                                                               |
| --------- | ------------------------------------------------------------------------------------------------------------------ |
| `obj`     | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> |

##### Returns

`this`

##### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`where`](FilterBuilder.md#where)

***

### whereExists()

```ts
whereExists(field: string): this;
```

Defined in: [batteries/vector/builder.ts:184](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L184)

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `field`   | `string` |

#### Returns

`this`

#### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`whereExists`](FilterBuilder.md#whereexists)

***

### whereIn()

```ts
whereIn(field: string, values: unknown[]): this;
```

Defined in: [batteries/vector/builder.ts:172](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L172)

#### Parameters

| Parameter | Type        |
| --------- | ----------- |
| `field`   | `string`    |
| `values`  | `unknown`\[] |

#### Returns

`this`

#### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`whereIn`](FilterBuilder.md#wherein)

***

### whereNot()

#### Call Signature

```ts
whereNot(cb: FilterCallback): this;
```

Defined in: [batteries/vector/builder.ts:146](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L146)

##### Parameters

| Parameter | Type                                                  |
| --------- | ----------------------------------------------------- |
| `cb`      | [`FilterCallback`](../type-aliases/FilterCallback.md) |

##### Returns

`this`

##### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`whereNot`](FilterBuilder.md#wherenot)

#### Call Signature

```ts
whereNot(field: string, value: unknown): this;
```

Defined in: [batteries/vector/builder.ts:147](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L147)

##### Parameters

| Parameter | Type      |
| --------- | --------- |
| `field`   | `string`  |
| `value`   | `unknown` |

##### Returns

`this`

##### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`whereNot`](FilterBuilder.md#wherenot)

***

### whereNotIn()

```ts
whereNotIn(field: string, values: unknown[]): this;
```

Defined in: [batteries/vector/builder.ts:176](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L176)

#### Parameters

| Parameter | Type        |
| --------- | ----------- |
| `field`   | `string`    |
| `values`  | `unknown`\[] |

#### Returns

`this`

#### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`whereNotIn`](FilterBuilder.md#wherenotin)

***

### whereNull()

```ts
whereNull(field: string): this;
```

Defined in: [batteries/vector/builder.ts:180](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L180)

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `field`   | `string` |

#### Returns

`this`

#### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`whereNull`](FilterBuilder.md#wherenull)

***

### whereRaw()

#### Call Signature

```ts
whereRaw(sql: string, bindings?: unknown[]): this;
```

Defined in: [batteries/vector/builder.ts:188](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L188)

##### Parameters

| Parameter   | Type        |
| ----------- | ----------- |
| `sql`       | `string`    |
| `bindings?` | `unknown`\[] |

##### Returns

`this`

##### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`whereRaw`](FilterBuilder.md#whereraw)

#### Call Signature

```ts
whereRaw(rawObj: {
  $bindings?: unknown[];
  $dialect: string;
  $raw: unknown;
}): this;
```

Defined in: [batteries/vector/builder.ts:189](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/builder.ts#L189)

##### Parameters

| Parameter           | Type                                                                      |
| ------------------- | ------------------------------------------------------------------------- |
| `rawObj`            | { `$bindings?`: `unknown`\[]; `$dialect`: `string`; `$raw`: `unknown`; } |
| `rawObj.$bindings?` | `unknown`\[]                                                               |
| `rawObj.$dialect`   | `string`                                                                  |
| `rawObj.$raw`       | `unknown`                                                                 |

##### Returns

`this`

##### Inherited from

[`FilterBuilder`](FilterBuilder.md).[`whereRaw`](FilterBuilder.md#whereraw)