Skip to main content

Class: PineconeVectorStore

Defined in: packages/agentos/src/cognition/rag/vector_stores/PineconeVectorStore.ts:74

Interface

IVectorStore

Description

Defines the contract for interacting with a specific vector database or storage backend. Implementations will wrap specific clients (e.g., Pinecone client, Weaviate client, in-memory store logic).

Implements

Constructors

Constructor

new PineconeVectorStore(config): PineconeVectorStore

Defined in: packages/agentos/src/cognition/rag/vector_stores/PineconeVectorStore.ts:78

Parameters

config

PineconeVectorStoreConfig

Returns

PineconeVectorStore

Methods

checkHealth()

checkHealth(): Promise<{ details?: any; isHealthy: boolean; }>

Defined in: packages/agentos/src/cognition/rag/vector_stores/PineconeVectorStore.ts:121

IVectorStore-compliant health check.

Returns

Promise<{ details?: any; isHealthy: boolean; }>

Implementation of

IVectorStore.checkHealth


close()

close(): Promise<void>

Defined in: packages/agentos/src/cognition/rag/vector_stores/PineconeVectorStore.ts:101

No-op — Pinecone is cloud-managed.

Returns

Promise<void>


createCollection()

createCollection(_name, _dimension, _options?): Promise<void>

Defined in: packages/agentos/src/cognition/rag/vector_stores/PineconeVectorStore.ts:134

Create a "collection" — in Pinecone this maps to a namespace. Namespaces are created implicitly on first upsert, so this is a no-op.

Parameters

_name

string

_dimension

number

_options?

CreateCollectionOptions

Returns

Promise<void>

Implementation of

IVectorStore.createCollection


delete()

delete(collectionName, ids?, options?): Promise<DeleteResult>

Defined in: packages/agentos/src/cognition/rag/vector_stores/PineconeVectorStore.ts:445

Delete vectors by ID or delete all in namespace.

Parameters

collectionName

string

ids?

string[]

options?

DeleteOptions

Returns

Promise<DeleteResult>

Implementation of

IVectorStore.delete


dropCollection()

dropCollection(name): Promise<void>

Defined in: packages/agentos/src/cognition/rag/vector_stores/PineconeVectorStore.ts:146

Drop a "collection" — deletes all vectors in the namespace.

Parameters

name

string

Returns

Promise<void>


healthCheck()

healthCheck(): Promise<boolean>

Defined in: packages/agentos/src/cognition/rag/vector_stores/PineconeVectorStore.ts:111

Health check — verify index is reachable (legacy).

Returns

Promise<boolean>


hybridSearch()

hybridSearch(collectionName, queryEmbedding, _queryText, options?): Promise<QueryResult>

Defined in: packages/agentos/src/cognition/rag/vector_stores/PineconeVectorStore.ts:361

Hybrid search is not natively supported by Pinecone in a single call. Falls back to dense-only query. For true hybrid search, use Postgres or Qdrant backends which support server-side RRF fusion.

Parameters

collectionName

string

queryEmbedding

number[]

_queryText

string

options?

QueryOptions & object

Returns

Promise<QueryResult>

Implementation of

IVectorStore.hybridSearch


initialize()

initialize(): Promise<void>

Defined in: packages/agentos/src/cognition/rag/vector_stores/PineconeVectorStore.ts:87

Verify connectivity by calling the describe index stats endpoint.

Returns

Promise<void>

Implementation of

IVectorStore.initialize


query()

query(collectionName, queryEmbedding, options?): Promise<QueryResult>

Defined in: packages/agentos/src/cognition/rag/vector_stores/PineconeVectorStore.ts:219

Query for top-K nearest neighbors via Pinecone's query endpoint. Supports metadata filtering via Pinecone's native filter syntax.

Parameters

collectionName

string

queryEmbedding

number[]

options?

QueryOptions

Returns

Promise<QueryResult>

Implementation of

IVectorStore.query


scanByMetadata()

scanByMetadata(collectionName, options?): Promise<MetadataScanResult>

Defined in: packages/agentos/src/cognition/rag/vector_stores/PineconeVectorStore.ts:286

Enumerate vectors by metadata filter using Pinecone's fetch_by_metadata endpoint.

Parameters

collectionName

string

options?

MetadataScanOptions

Returns

Promise<MetadataScanResult>

Implementation of

IVectorStore.scanByMetadata


shutdown()

shutdown(): Promise<void>

Defined in: packages/agentos/src/cognition/rag/vector_stores/PineconeVectorStore.ts:106

Gracefully shut down the store (alias for close).

Returns

Promise<void>

Implementation of

IVectorStore.shutdown


upsert()

upsert(collectionName, documents, options?): Promise<UpsertResult>

Defined in: packages/agentos/src/cognition/rag/vector_stores/PineconeVectorStore.ts:159

Upsert vectors into Pinecone. Batches automatically in chunks of 100 (Pinecone's max batch size).

Parameters

collectionName

string

documents

VectorDocument[]

options?

UpsertOptions

Returns

Promise<UpsertResult>

Implementation of

IVectorStore.upsert