PineconeVectorStore

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:38

Provides support for writing and querying vector data in Pinecone.

Extends

BaseVectorStore

Constructors

new PineconeVectorStore()

new PineconeVectorStore(params?): PineconeVectorStore

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:57

Parameters

params?

PineconeParams

Returns

PineconeVectorStore

Overrides

BaseVectorStore.constructor

Properties

storesText

storesText: boolean = true

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:39

Overrides

BaseVectorStore.storesText

db?

optional db: Pinecone

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:49

indexName

indexName: string

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:50

namespace

namespace: string

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:51

chunkSize

chunkSize: number

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:52

textKey

textKey: string

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:53

apiKey

apiKey: string

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:55

Methods

client()

client(): Promise<Pinecone>

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:89

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.

Overrides

BaseVectorStore.client

index()

index(): Promise<Index<RecordMetadata>>

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:93

Returns

Promise<Index<RecordMetadata>>

clearIndex()

clearIndex(): Promise<void>

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:103

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.

add()

add(embeddingResults): Promise<string[]>

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:114

Adds vector record(s) to the table.

Parameters

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.

Overrides

BaseVectorStore.add

saveChunk()

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

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:132

Parameters

idx

Index<RecordMetadata>

chunk

PineconeRecord[]

Returns

Promise<boolean>

delete()

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

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:150

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

Parameters

refDocId

string

Unique identifier for the record to delete.

deleteKwargs?

object

Required by VectorStore interface. Currently ignored.

Returns

Promise<void>

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

Overrides

BaseVectorStore.delete

query()

query(query, _options?): Promise<VectorStoreQueryResult>

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:162

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

Parameters

query

VectorStoreQuery

The VectorStoreQuery to be used

_options?

object

Required by VectorStore interface. Currently ignored.

Returns

Promise<VectorStoreQueryResult>

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

TODO

QUERY TYPES

Overrides

BaseVectorStore.query

persist()

persist(persistPath): Promise<void>

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:213

Required by VectorStore interface. Currently ignored.

Parameters

persistPath

string

Returns

Promise<void>

Resolved Promise.

toPineconeFilter()

toPineconeFilter(stdFilters?): undefined | object

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:217

Parameters

stdFilters?

MetadataFilters

Returns

undefined | object

textFromResultRow()

textFromResultRow(row): string

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:274

Parameters

row

ScoredPineconeRecord<Metadata>

Returns

string

metaWithoutText()

metaWithoutText(meta): Record<string, unknown>

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:278

Parameters

Returns

Record<string, unknown>

nodeToRecord()

nodeToRecord(node): object

Defined in: providers/storage/pinecone/src/PineconeVectorStore.ts:287

Parameters

node

BaseNode<Metadata>

Returns

object

id

id: string

values

values: number[]

metadata

metadata: Metadata

PineconeVectorStore

On this page