Class: PineconeVectorStore
Provides support for writing and querying vector data in Pinecone.
Extends
Implements
Constructors
new PineconeVectorStore()
new PineconeVectorStore(
params
?):PineconeVectorStore
Parameters
• params?: PineconeParams
Returns
Overrides
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:51
Properties
chunkSize
chunkSize:
number
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:48
db?
optional
db:Pinecone
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:45
embedModel
embedModel:
BaseEmbedding
Inherited from
Source
packages/core/src/storage/vectorStore/types.ts:86
indexName
indexName:
string
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:46
namespace
namespace:
string
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:47
storesText
storesText:
boolean
=true
Implementation of
VectorStoreNoEmbedModel
. storesText
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:35
textKey
textKey:
string
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:49
Methods
add()
add(
embeddingResults
):Promise
<string
[]>
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.
Implementation of
TODO
Does not create or insert sparse vectors.
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:101
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.
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:90
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
VectorStoreNoEmbedModel
. client
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:76
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
• 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
VectorStoreNoEmbedModel
. delete
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:137
getDb()
private
getDb():Promise
<Pinecone
>
Returns
Promise
<Pinecone
>
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:62
index()
index():
Promise
<Index
<RecordMetadata
>>
Returns
Promise
<Index
<RecordMetadata
>>
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:80
metaWithoutText()
metaWithoutText(
meta
):any
Parameters
• meta: Metadata
Returns
any
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:212
nodeToRecord()
nodeToRecord(
node
):object
Parameters
Returns
object
id
id:
any
metadata
metadata:
Metadata
values
values:
number
[]
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:221
persist()
persist(
persistPath
):Promise
<void
>
Required by VectorStore interface. Currently ignored.
Parameters
• persistPath: string
Returns
Promise
<void
>
Resolved Promise.
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:197
query()
query(
query
,_options
?):Promise
<VectorStoreQueryResult
>
Query the vector store for the closest matching data to the query embeddings
Parameters
• query: VectorStoreQuery
The VectorStoreQuery to be used
• _options?: any
Returns
Promise
<VectorStoreQueryResult
>
Zero or more Document instances with data from the vector store.
Implementation of
VectorStoreNoEmbedModel
. query
TODO
QUERY TYPES
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:149
saveChunk()
protected
saveChunk(idx
,chunk
):Promise
<boolean
>
Parameters
• idx: Index
<RecordMetadata
>
• chunk: any
Returns
Promise
<boolean
>
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:119
textFromResultRow()
textFromResultRow(
row
):string
Parameters
• row: ScoredPineconeRecord
<Metadata
>
Returns
string
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:208
toPineconeFilter()
toPineconeFilter(
stdFilters
?):any
Parameters
• stdFilters?: MetadataFilters
Returns
any
Source
packages/core/src/storage/vectorStore/PineconeVectorStore.ts:201