Interface: PineconeVectorStoreOptions
Defined in: src/batteries/vector/pinecone/index.ts:32
Shared base options every adapter extends with its own connection block.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
apiKey | string | Pinecone 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? | VectorConsistency | Store-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.consistency | src/batteries/vector/types.ts:129 |
defaultCollection? | string | Collection name used when a call omits an explicit one. | BaseVectorStoreOptions.defaultCollection | src/batteries/vector/types.ts:122 |
dimensions? | number | Embedding dimensionality. Required by backends that must declare it at collection-creation time. | BaseVectorStoreOptions.dimensions | src/batteries/vector/types.ts:120 |
encoder? | VectorEncoderFn | Function that turns text into vectors. Required unless the backend has built-in encoding. | BaseVectorStoreOptions.encoder | src/batteries/vector/types.ts:118 |
index | string | Name of the Pinecone index this store operates against. | - | src/batteries/vector/pinecone/index.ts:36 |
metric? | DistanceMetric | Distance metric used for similarity (e.g. cosine, euclidean, dot). Defaults to the adapter's preferred metric. | BaseVectorStoreOptions.metric | src/batteries/vector/types.ts:116 |
namespacePrefix? | string | When 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 |