Class: PineconeStore

vectorstores/pinecone.PineconeStore

Hierarchy

• VectorStore

  ↳ PineconeStore

Constructors

constructor

• new PineconeStore(embeddings, args)

Parameters

Name	Type
embeddings	Embeddings
args	PineconeLibArgs

Overrides

VectorStore.constructor

Defined in

langchain/src/vectorstores/pinecone.ts:31

Properties

embeddings

• embeddings: Embeddings

Inherited from

VectorStore.embeddings

Defined in

langchain/src/vectorstores/base.ts:23

---

filter

• Optional filter: PineconeMetadata

Defined in

langchain/src/vectorstores/pinecone.ts:29

---

namespace

• Optional namespace: string

Defined in

langchain/src/vectorstores/pinecone.ts:25

---

pineconeIndex

• pineconeIndex: VectorOperationsApi

Defined in

langchain/src/vectorstores/pinecone.ts:27

---

textKey

• textKey: string

Defined in

langchain/src/vectorstores/pinecone.ts:23

Methods

addDocuments

▸ addDocuments(documents, ids?): Promise<void>

Parameters

Name	Type
documents	Document<Record<string, any>>[]
ids?	string[]

Returns

Promise<void>

Overrides

VectorStore.addDocuments

Defined in

langchain/src/vectorstores/pinecone.ts:41

---

addVectors

▸ addVectors(vectors, documents, ids?): Promise<void>

Parameters

Name	Type
vectors	number[][]
documents	Document<Record<string, any>>[]
ids?	string[]

Returns

Promise<void>

Overrides

VectorStore.addVectors

Defined in

langchain/src/vectorstores/pinecone.ts:50

---

asRetriever

▸ asRetriever(k?): BaseRetriever

Parameters

Name	Type
k?	number

Returns

BaseRetriever

Inherited from

VectorStore.asRetriever

Defined in

langchain/src/vectorstores/base.ts:92

---

similaritySearch

▸ similaritySearch(query, k?, filter?): Promise<Document<Record<string, any>>[]>

Parameters

Name	Type	Default value
query	string	undefined
k	number	4
filter	undefined | object	undefined

Returns

Promise<Document<Record<string, any>>[]>

Inherited from

VectorStore.similaritySearch

Defined in

langchain/src/vectorstores/base.ts:43

---

similaritySearchVectorWithScore

▸ similaritySearchVectorWithScore(query, k, filter?): Promise<[Document<Record<string, any>>, number][]>

Parameters

Name	Type
query	number[]
k	number
filter?	object

Returns

Promise<[Document<Record<string, any>>, number][]>

Overrides

VectorStore.similaritySearchVectorWithScore

Defined in

langchain/src/vectorstores/pinecone.ts:78

---

similaritySearchWithScore

▸ similaritySearchWithScore(query, k?, filter?): Promise<[object, number][]>

Parameters

Name	Type	Default value
query	string	undefined
k	number	4
filter	undefined | object	undefined

Returns

Promise<[object, number][]>

Inherited from

VectorStore.similaritySearchWithScore

Defined in

langchain/src/vectorstores/base.ts:57

---

fromDocuments

▸ Static fromDocuments(docs, embeddings, dbConfig): Promise<PineconeStore>

Parameters

Name	Type
docs	Document<Record<string, any>>[]
embeddings	Embeddings
dbConfig	PineconeLibArgs

Returns

Promise<PineconeStore>

Overrides

VectorStore.fromDocuments

Defined in

langchain/src/vectorstores/pinecone.ts:148

---

fromExistingIndex

▸ Static fromExistingIndex(embeddings, dbConfig): Promise<PineconeStore>

Parameters

Name	Type
embeddings	Embeddings
dbConfig	PineconeLibArgs

Returns

Promise<PineconeStore>

Defined in

langchain/src/vectorstores/pinecone.ts:161

---

fromTexts

▸ Static fromTexts(texts, metadatas, embeddings, dbConfig): Promise<PineconeStore>

Parameters

Name	Type
texts	string[]
metadatas	object | object[]
embeddings	Embeddings
dbConfig	PineconeLibArgs | { namespace?: string ; pineconeClient: VectorOperationsApi ; textKey?: string }

Returns

Promise<PineconeStore>

Overrides

VectorStore.fromTexts

Defined in

langchain/src/vectorstores/pinecone.ts:112