Skip to content
1 min read · 259 words

Interface: S3VectorsVectorStoreOptions

Defined in: batteries/vector/s3vectors/index.ts:75

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

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
connection{ bucket: string; credentials?: { accessKeyId: string; secretAccessKey: string; sessionToken?: string; }; indexPrefix?: string; region?: string; }--batteries/vector/s3vectors/index.ts:76
connection.bucketstring--batteries/vector/s3vectors/index.ts:77
connection.credentials?{ accessKeyId: string; secretAccessKey: string; sessionToken?: string; }--batteries/vector/s3vectors/index.ts:79
connection.credentials.accessKeyIdstring--batteries/vector/s3vectors/index.ts:79
connection.credentials.secretAccessKeystring--batteries/vector/s3vectors/index.ts:79
connection.credentials.sessionToken?string--batteries/vector/s3vectors/index.ts:79
connection.indexPrefix?string--batteries/vector/s3vectors/index.ts:80
connection.region?string--batteries/vector/s3vectors/index.ts:78
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