Class for managing and operating vector search applications with Pinecone, the cloud-native high-scale vector database

Hierarchy

  • VectorStore
    • PineconeStore

Constructors

Properties

FilterType: PineconeMetadata
caller: AsyncCaller
pineconeIndex: Index<RecordMetadata>
textKey: string
filter?: PineconeMetadata
namespace?: string

Methods

  • Method that adds documents to the Pinecone database.

    Parameters

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

      Array of documents to add to the Pinecone database.

    • Optional options: string[] | {
          ids?: string[];
          namespace?: string;
      }

      Optional ids for the documents.

    Returns Promise<string[]>

    Promise that resolves with the ids of the added documents.

  • 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.

    • Optional options: string[] | {
          ids?: string[];
          namespace?: string;
      }

      Optional ids for the vectors.

    Returns Promise<string[]>

    Promise that resolves with the ids of the added vectors.

  • 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<DocumentInterface<Record<string, any>>[]>

    • List of documents selected by maximal marginal relevance.
  • 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.

    • Optional filter: 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.

  • 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: PineconeStoreParams

      Configuration for the Pinecone database.

    Returns Promise<PineconeStore>

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

  • 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: PineconeStoreParams

      Configuration for the Pinecone database.

    Returns Promise<PineconeStore>

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

  • 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: PineconeStoreParams | {
          pineconeIndex: Index<RecordMetadata>;
          namespace?: string;
          textKey?: string;
      }

      Configuration for the Pinecone database.

    Returns Promise<PineconeStore>

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

Generated using TypeDoc