Class that extends the VectorStore class and provides methods to interact with the Pinecone vector database.

Hierarchy

Constructors

Properties

FilterType: PineconeMetadata
caller: AsyncCaller
embeddings: Embeddings
lc_kwargs: SerializedFields
lc_namespace: string[] = ...

A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

lc_serializable: boolean = false
pineconeIndex: Index<RecordMetadata>
textKey: string
filter?: PineconeMetadata
namespace?: string

Accessors

  • get lc_aliases(): undefined | {
        [key: string]: string;
    }
  • A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

    Returns undefined | {
        [key: string]: string;
    }

  • get lc_attributes(): undefined | SerializedFields
  • A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

    Returns undefined | SerializedFields

  • get lc_secrets(): undefined | {
        [key: string]: string;
    }
  • A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

    Returns undefined | {
        [key: string]: 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[];
      }

      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[];
      }

      Optional ids for the vectors.

    Returns Promise<string[]>

    Promise that resolves with the ids of the added vectors.

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

    Parameters

    • texts: string[]

      Array of texts to add to the Pinecone database.

    • metadatas: object | object[]

      Metadata associated with the texts.

    • embeddings: Embeddings

      Embeddings to use for the texts.

    • dbConfig: PineconeLibArgs | {
          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.

  • The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

    Implemented as a static method to support loading logic.

    Returns string

  • Parameters

    • query: number[]
    • k: number
    • Optional filter: PineconeMetadata
    • Optional options: {
          includeValues: boolean;
      }
      • includeValues: boolean

    Returns Promise<QueryResponse<RecordMetadata>>

Generated using TypeDoc