PineconeVectorStore
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:38
Provides support for writing and querying vector data in Pinecone.
Extends
Section titled “Extends”BaseVectorStore
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PineconeVectorStore(
params?):PineconeVectorStore
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:57
Parameters
Section titled “Parameters”params?
Section titled “params?”PineconeParams
Returns
Section titled “Returns”PineconeVectorStore
Overrides
Section titled “Overrides”BaseVectorStore.constructor
Properties
Section titled “Properties”storesText
Section titled “storesText”storesText:
boolean=true
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:39
Overrides
Section titled “Overrides”BaseVectorStore.storesText
optionaldb:Pinecone
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:49
indexName
Section titled “indexName”indexName:
string
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:50
namespace
Section titled “namespace”namespace:
string
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:51
chunkSize
Section titled “chunkSize”chunkSize:
number
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:52
textKey
Section titled “textKey”textKey:
string
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:53
apiKey
Section titled “apiKey”apiKey:
string
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:55
Methods
Section titled “Methods”client()
Section titled “client()”client():
Promise<Pinecone>
Defined in: .build/typescript/packages/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
Section titled “Returns”Promise<Pinecone>
Pinecone client, or the error encountered while connecting/setting up.
Overrides
Section titled “Overrides”BaseVectorStore.client
index()
Section titled “index()”index():
Promise<Index<RecordMetadata>>
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:93
Returns
Section titled “Returns”Promise<Index<RecordMetadata>>
clearIndex()
Section titled “clearIndex()”clearIndex():
Promise<void>
Defined in: .build/typescript/packages/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
Section titled “Returns”Promise<void>
The result of the delete query.
add(
embeddingResults):Promise<string[]>
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:114
Adds vector record(s) to the table.
Parameters
Section titled “Parameters”embeddingResults
Section titled “embeddingResults”BaseNode<Metadata>[]
The Nodes to be inserted, optionally including metadata tuples.
Returns
Section titled “Returns”Promise<string[]>
Due to limitations in the Pinecone client, does not return the upserted ID list, only a Promise resolve/reject.
Does not create or insert sparse vectors.
Overrides
Section titled “Overrides”BaseVectorStore.add
saveChunk()
Section titled “saveChunk()”
protectedsaveChunk(idx,chunk):Promise<boolean>
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:140
Parameters
Section titled “Parameters”Index
PineconeRecord[]
Returns
Section titled “Returns”Promise<boolean>
delete()
Section titled “delete()”delete(
refDocId,deleteKwargs?):Promise<void>
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:158
Deletes a single record from the database by id. NOTE: Uses the collection property controlled by setCollection/getCollection.
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
Unique identifier for the record to delete.
deleteKwargs?
Section titled “deleteKwargs?”object
Required by VectorStore interface. Currently ignored.
Returns
Section titled “Returns”Promise<void>
Promise that resolves if the delete query did not throw an error.
Overrides
Section titled “Overrides”BaseVectorStore.delete
query()
Section titled “query()”query(
query,_options?):Promise<VectorStoreQueryResult>
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:205
Query the vector store for the closest matching data to the query embeddings
Parameters
Section titled “Parameters”VectorStoreQuery
The VectorStoreQuery to be used
_options?
Section titled “_options?”object
Required by VectorStore interface. Currently ignored.
Returns
Section titled “Returns”Promise<VectorStoreQueryResult>
Zero or more Document instances with data from the vector store.
QUERY TYPES
Overrides
Section titled “Overrides”BaseVectorStore.query
persist()
Section titled “persist()”persist(
persistPath):Promise<void>
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:256
Required by VectorStore interface. Currently ignored.
Parameters
Section titled “Parameters”persistPath
Section titled “persistPath”string
Returns
Section titled “Returns”Promise<void>
Resolved Promise.
toPineconeFilter()
Section titled “toPineconeFilter()”toPineconeFilter(
stdFilters?):undefined|object
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:260
Parameters
Section titled “Parameters”stdFilters?
Section titled “stdFilters?”MetadataFilters
Returns
Section titled “Returns”undefined | object
textFromResultRow()
Section titled “textFromResultRow()”textFromResultRow(
row):string
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:317
Parameters
Section titled “Parameters”ScoredPineconeRecord<Metadata>
Returns
Section titled “Returns”string
metaWithoutText()
Section titled “metaWithoutText()”metaWithoutText(
meta):Record<string,unknown>
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:321
Parameters
Section titled “Parameters”Metadata
Returns
Section titled “Returns”Record<string, unknown>
nodeToRecord()
Section titled “nodeToRecord()”nodeToRecord(
node):object
Defined in: .build/typescript/packages/providers/storage/pinecone/src/PineconeVectorStore.ts:330
Parameters
Section titled “Parameters”BaseNode<Metadata>
Returns
Section titled “Returns”object
id:
string
values
Section titled “values”values:
number[]
metadata
Section titled “metadata”metadata:
Metadata