Skip to content
1 min read · 231 words

Interface: OpenSearchVectorStoreOptions

Defined in: batteries/vector/opensearch/index.ts:40

Shared base options every adapter extends with its own connection block.

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
connection?{ auth?: { password: string; username: string; }; client?: unknown; node?: string; }--batteries/vector/opensearch/index.ts:41
connection.auth?{ password: string; username: string; }--batteries/vector/opensearch/index.ts:43
connection.auth.passwordstring--batteries/vector/opensearch/index.ts:43
connection.auth.usernamestring--batteries/vector/opensearch/index.ts:43
connection.client?unknown--batteries/vector/opensearch/index.ts:45
connection.node?string--batteries/vector/opensearch/index.ts:42
consistency?VectorConsistencyStore-wide read-after-write guarantee for writes. Overrides the adapter's declared VectorStoreCapabilities.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.BaseVectorStoreOptions.consistencybatteries/vector/types.ts:106
defaultCollection?string-BaseVectorStoreOptions.defaultCollectionbatteries/vector/types.ts:99
dimensions?number-BaseVectorStoreOptions.dimensionsbatteries/vector/types.ts:98
encoder?VectorEncoderFn-BaseVectorStoreOptions.encoderbatteries/vector/types.ts:97
metric?DistanceMetric-BaseVectorStoreOptions.metricbatteries/vector/types.ts:96