---
url: >-
  https://adk.nht.io/api/@nhtio/adk/batteries/vector/weaviate/interfaces/WeaviateVectorStoreOptions.md
description: 'Connection options for [`WeaviateVectorStore`](https://adk.nht.io/api/@nhtio/adk/batteries/vector/weaviate/classes/WeaviateVectorStore).'
---

# Interface: WeaviateVectorStoreOptions

Defined in: [batteries/vector/weaviate/index.ts:38](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/weaviate/index.ts#L38)

Connection options for [WeaviateVectorStore](../classes/WeaviateVectorStore.md).

## Extends

* [`BaseVectorStoreOptions`](../../types/interfaces/BaseVectorStoreOptions.md)

## Properties

| Property                                                     | Type                                                                                                                                                                             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                              | Inherited from                                                                                                                                                                  | Defined in                                                                                                                          |
| ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
|  `connection?`               | { `apiKey?`: `string`; `grpcHost?`: `string`; `grpcPort?`: `number`; `grpcSecure?`: `boolean`; `host?`: `string`; `port?`: `number`; `secure?`: `boolean`; `url?`: `string`; } | -                                                                                                                                                                                                                                                                                                                                                                                                                                                        | -                                                                                                                                                                               | [batteries/vector/weaviate/index.ts:39](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/weaviate/index.ts#L39) |
| `connection.apiKey?`                                         | `string`                                                                                                                                                                         | -                                                                                                                                                                                                                                                                                                                                                                                                                                                        | -                                                                                                                                                                               | [batteries/vector/weaviate/index.ts:45](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/weaviate/index.ts#L45) |
| `connection.grpcHost?`                                       | `string`                                                                                                                                                                         | -                                                                                                                                                                                                                                                                                                                                                                                                                                                        | -                                                                                                                                                                               | [batteries/vector/weaviate/index.ts:43](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/weaviate/index.ts#L43) |
| `connection.grpcPort?`                                       | `number`                                                                                                                                                                         | -                                                                                                                                                                                                                                                                                                                                                                                                                                                        | -                                                                                                                                                                               | [batteries/vector/weaviate/index.ts:44](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/weaviate/index.ts#L44) |
| `connection.grpcSecure?`                                     | `boolean`                                                                                                                                                                        | -                                                                                                                                                                                                                                                                                                                                                                                                                                                        | -                                                                                                                                                                               | [batteries/vector/weaviate/index.ts:47](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/weaviate/index.ts#L47) |
| `connection.host?`                                           | `string`                                                                                                                                                                         | -                                                                                                                                                                                                                                                                                                                                                                                                                                                        | -                                                                                                                                                                               | [batteries/vector/weaviate/index.ts:41](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/weaviate/index.ts#L41) |
| `connection.port?`                                           | `number`                                                                                                                                                                         | -                                                                                                                                                                                                                                                                                                                                                                                                                                                        | -                                                                                                                                                                               | [batteries/vector/weaviate/index.ts:42](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/weaviate/index.ts#L42) |
| `connection.secure?`                                         | `boolean`                                                                                                                                                                        | -                                                                                                                                                                                                                                                                                                                                                                                                                                                        | -                                                                                                                                                                               | [batteries/vector/weaviate/index.ts:46](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/weaviate/index.ts#L46) |
| `connection.url?`                                            | `string`                                                                                                                                                                         | -                                                                                                                                                                                                                                                                                                                                                                                                                                                        | -                                                                                                                                                                               | [batteries/vector/weaviate/index.ts:40](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/weaviate/index.ts#L40) |
|  `consistency?`             | [`VectorConsistency`](../../types/type-aliases/VectorConsistency.md)                                                                                                             | Store-wide read-after-write guarantee for writes. Overrides the adapter's declared [VectorStoreCapabilities.consistency](../../types/interfaces/VectorStoreCapabilities.md#property-consistency) default; a per-operation `.consistency()` on the builder overrides this in turn (precedence: per-op > store option > adapter default). Ignored by strongly-consistent adapters. See [VectorConsistency](../../types/type-aliases/VectorConsistency.md). | [`BaseVectorStoreOptions`](../../types/interfaces/BaseVectorStoreOptions.md).[`consistency`](../../types/interfaces/BaseVectorStoreOptions.md#property-consistency)             | [batteries/vector/types.ts:106](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/types.ts#L106)                 |
|  `defaultCollection?` | `string`                                                                                                                                                                         | -                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [`BaseVectorStoreOptions`](../../types/interfaces/BaseVectorStoreOptions.md).[`defaultCollection`](../../types/interfaces/BaseVectorStoreOptions.md#property-defaultcollection) | [batteries/vector/types.ts:99](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/types.ts#L99)                   |
|  `dimensions?`               | `number`                                                                                                                                                                         | -                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [`BaseVectorStoreOptions`](../../types/interfaces/BaseVectorStoreOptions.md).[`dimensions`](../../types/interfaces/BaseVectorStoreOptions.md#property-dimensions)               | [batteries/vector/types.ts:98](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/types.ts#L98)                   |
|  `encoder?`                     | [`VectorEncoderFn`](../../types/type-aliases/VectorEncoderFn.md)                                                                                                                 | -                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [`BaseVectorStoreOptions`](../../types/interfaces/BaseVectorStoreOptions.md).[`encoder`](../../types/interfaces/BaseVectorStoreOptions.md#property-encoder)                     | [batteries/vector/types.ts:97](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/types.ts#L97)                   |
|  `metric?`                       | [`DistanceMetric`](../../types/type-aliases/DistanceMetric.md)                                                                                                                   | -                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [`BaseVectorStoreOptions`](../../types/interfaces/BaseVectorStoreOptions.md).[`metric`](../../types/interfaces/BaseVectorStoreOptions.md#property-metric)                       | [batteries/vector/types.ts:96](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/types.ts#L96)                   |
