Class: PineconeVectorStore
Provides support for writing and querying vector data in Postgres.
Implements
Constructors
constructor
• new PineconeVectorStore(params?
): PineconeVectorStore
Parameters
Name | Type |
---|---|
params? | PineconeParams |
Returns
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
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
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
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.