Skip to content
2 min read · 326 words

Interface: PineconeVectorStoreOptions

Defined in: src/batteries/vector/pinecone/index.ts:32

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

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
apiKeystringPinecone API key.-src/batteries/vector/pinecone/index.ts:34
connection?{ controllerHostUrl?: string; }Connection and authentication parameters for the backend.-src/batteries/vector/pinecone/index.ts:46
connection.controllerHostUrl?string--src/batteries/vector/pinecone/index.ts:46
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.consistencysrc/batteries/vector/types.ts:129
defaultCollection?stringCollection name used when a call omits an explicit one.BaseVectorStoreOptions.defaultCollectionsrc/batteries/vector/types.ts:122
dimensions?numberEmbedding dimensionality. Required by backends that must declare it at collection-creation time.BaseVectorStoreOptions.dimensionssrc/batteries/vector/types.ts:120
encoder?VectorEncoderFnFunction that turns text into vectors. Required unless the backend has built-in encoding.BaseVectorStoreOptions.encodersrc/batteries/vector/types.ts:118
indexstringName of the Pinecone index this store operates against.-src/batteries/vector/pinecone/index.ts:36
metric?DistanceMetricDistance metric used for similarity (e.g. cosine, euclidean, dot). Defaults to the adapter's preferred metric.BaseVectorStoreOptions.metricsrc/batteries/vector/types.ts:116
namespacePrefix?stringWhen set, the physical Pinecone namespace becomes ${namespacePrefix}__${collection}. The logical collection name the builder/base see is unchanged — only the physical namespace string is prefixed. Lets callers (and the test suite) isolate otherwise identically-named collections into distinct, uncontended namespaces. Pinecone namespaces are implicit (born on first upsert), so a fresh prefix costs nothing.-src/batteries/vector/pinecone/index.ts:44