Class: PineconeVectorStore

Provides support for writing and querying vector data in Postgres.

Implements

• VectorStore

Constructors

constructor

• new PineconeVectorStore(params?): PineconeVectorStore

Parameters

Name	Type
params?	PineconeParams

Returns

PineconeVectorStore

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:46

Properties

chunkSize

• chunkSize: number

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:43

---

db

• Optional db: Pinecone

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:40

---

indexName

• indexName: string

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:41

---

namespace

• namespace: string

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:42

---

storesText

• storesText: boolean = true

Implementation of

VectorStore.storesText

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:30

---

textKey

• textKey: string

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:44

Methods

add

▸ add(embeddingResults): Promise<string[]>

Adds vector record(s) to the table.

Parameters

Name	Type	Description
embeddingResults	BaseNode<Metadata>[]	The Nodes to be inserted, optionally including metadata tuples.

Returns

Promise<string[]>

Due to limitations in the Pinecone client, does not return the upserted ID list, only a Promise resolve/reject.

TODO

Does not create or insert sparse vectors.

Implementation of

VectorStore.add

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:95

---

clearIndex

▸ clearIndex(): Promise<void>

Delete all records for the current index. NOTE: This operation is not supported by Pinecone for "Starter" (free) indexes.

Returns

Promise<void>

The result of the delete query.

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:84

---

client

▸ client(): Promise<Pinecone>

Connects to the Pinecone account specified in environment vars. This method also checks and creates the named index if not found.

Returns

Promise<Pinecone>

Pinecone client, or the error encountered while connecting/setting up.

Implementation of

VectorStore.client

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:70

---

delete

▸ delete(refDocId, deleteKwargs?): Promise<void>

Deletes a single record from the database by id. NOTE: Uses the collection property controlled by setCollection/getCollection.

Parameters

Name	Type	Description
refDocId	string	Unique identifier for the record to delete.
deleteKwargs?	any	Required by VectorStore interface. Currently ignored.

Returns

Promise<void>

Promise that resolves if the delete query did not throw an error.

Implementation of

VectorStore.delete

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:131

---

getDb

▸ getDb(): Promise<Pinecone>

Returns

Promise<Pinecone>

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:56

---

index

▸ index(): Promise<Index<RecordMetadata>>

Returns

Promise<Index<RecordMetadata>>

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:74

---

metaWithoutText

▸ metaWithoutText(meta): any

Parameters

Name	Type
meta	Metadata

Returns

any

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:211

---

nodeToRecord

▸ nodeToRecord(node): Object

Parameters

Name	Type
node	BaseNode<Metadata>

Returns

Object

Name	Type
id	any
metadata	Metadata
values	number[]

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:220

---

persist

▸ persist(persistPath, fs?): Promise<void>

Required by VectorStore interface. Currently ignored.

Parameters

Name	Type
persistPath	string
fs?	GenericFileSystem

Returns

Promise<void>

Resolved Promise.

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:193

---

query

▸ query(query, options?): Promise<VectorStoreQueryResult>

Query the vector store for the closest matching data to the query embeddings

Parameters

Name	Type	Description
query	VectorStoreQuery	The VectorStoreQuery to be used
options?	any	Required by VectorStore interface. Currently ignored.

Returns

Promise<VectorStoreQueryResult>

Zero or more Document instances with data from the vector store.

TODO

QUERY TYPES

Implementation of

VectorStore.query

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:143

---

saveChunk

▸ saveChunk(idx, chunk): Promise<boolean>

Parameters

Name	Type
idx	Index<RecordMetadata>
chunk	any

Returns

Promise<boolean>

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:113

---

textFromResultRow

▸ textFromResultRow(row): string

Parameters

Name	Type
row	ScoredPineconeRecord<Metadata>

Returns

string

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:207

---

toPineconeFilter

▸ toPineconeFilter(stdFilters?): any

Parameters

Name	Type
stdFilters?	MetadataFilters

Returns

any

Defined in

packages/core/src/storage/vectorStore/PineconeVectorStore.ts:200