Class PineconeStore

constructor

• new PineconeStore(embeddings, args): PineconeStore

• Parameters

  • embeddings: EmbeddingsInterface
  • args: PineconeLibArgs

  Returns PineconeStore

FilterType

caller

Optionalfilter

Optionalnamespace

pineconeIndex

textKey

addDocuments

• addDocuments(documents, options?): Promise<string[]>

• Method that adds documents to the Pinecone database.

  Parameters

  • documents: Document<Record<string, any>>[]

    Array of documents to add to the Pinecone database.
  • Optionaloptions: string[] | {
        ids?: string[];
    }

    Optional ids for the documents.

  Returns Promise<string[]>

  Promise that resolves with the ids of the added documents.

addVectors

• addVectors(vectors, documents, options?): Promise<string[]>

• Method that adds vectors to the Pinecone database.

  Parameters

  • vectors: number[][]

    Array of vectors to add to the Pinecone database.
  • documents: Document<Record<string, any>>[]

    Array of documents associated with the vectors.
  • Optionaloptions: string[] | {
        ids?: string[];
    }

    Optional ids for the vectors.

  Returns Promise<string[]>

  Promise that resolves with the ids of the added vectors.

delete

• delete(params): Promise<void>

• Method that deletes vectors from the Pinecone database.

  Parameters

  • params: PineconeDeleteParams

    Parameters for the delete operation.

  Returns Promise<void>

  Promise that resolves when the delete operation is complete.

maxMarginalRelevanceSearch

• maxMarginalRelevanceSearch(query, options): Promise<Document<Record<string, any>>[]>

• Return documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.

  Parameters

  • query: string

    Text to look up documents similar to.
  • options: MaxMarginalRelevanceSearchOptions<PineconeMetadata>

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

  • List of documents selected by maximal marginal relevance.

similaritySearchVectorWithScore

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

• Method that performs a similarity search in the Pinecone database and returns the results along with their scores.

  Parameters

  • query: number[]

    Query vector for the similarity search.
  • k: number

    Number of top results to return.
  • Optionalfilter: PineconeMetadata

    Optional filter to apply to the search.

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

  Promise that resolves with an array of documents and their scores.

StaticfromDocuments

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

• Static method that creates a new instance of the PineconeStore class from documents.

  Parameters

  • docs: Document<Record<string, any>>[]

    Array of documents to add to the Pinecone database.
  • embeddings: EmbeddingsInterface

    Embeddings to use for the documents.
  • dbConfig: PineconeLibArgs

    Configuration for the Pinecone database.

  Returns Promise<PineconeStore>

  Promise that resolves with a new instance of the PineconeStore class.

StaticfromExistingIndex

• fromExistingIndex(embeddings, dbConfig): Promise<PineconeStore>

• Static method that creates a new instance of the PineconeStore class from an existing index.

  Parameters

  • embeddings: EmbeddingsInterface

    Embeddings to use for the documents.
  • dbConfig: PineconeLibArgs

    Configuration for the Pinecone database.

  Returns Promise<PineconeStore>

  Promise that resolves with a new instance of the PineconeStore class.

StaticfromTexts

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

• Static method that creates a new instance of the PineconeStore class from texts.

  Parameters

  • texts: string[]

    Array of texts to add to the Pinecone database.
  • metadatas: object | object[]

    Metadata associated with the texts.
  • embeddings: EmbeddingsInterface

    Embeddings to use for the texts.
  • dbConfig: PineconeLibArgs | {
        namespace?: string;
        pineconeIndex: Index<RecordMetadata>;
        textKey?: string;
    }

    Configuration for the Pinecone database.

  Returns Promise<PineconeStore>

  Promise that resolves with a new instance of the PineconeStore class.