PineconeMemoryStore Class

Reference

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.Pinecone

Assembly:: Microsoft.SemanticKernel.Connectors.Pinecone.dll

Package:: Microsoft.SemanticKernel.Connectors.Pinecone v1.20.0-alpha

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

An implementation of IMemoryStore for Pinecone Vector database.

public class PineconeMemoryStore : Microsoft.SemanticKernel.Connectors.Pinecone.IPineconeMemoryStore, Microsoft.SemanticKernel.Memory.IMemoryStore

type PineconeMemoryStore = class
    interface IPineconeMemoryStore
    interface IMemoryStore

Public Class PineconeMemoryStore
Implements IMemoryStore, IPineconeMemoryStore

Inheritance: Object
PineconeMemoryStore

Implements: IPineconeMemoryStore IMemoryStore

Remarks

The Embedding data is saved to a Pinecone Vector database instance that the client is connected to. The embedding data persists between subsequent instances and has similarity search capability. It should be noted that "Collection" in Pinecone's terminology is much different than what Collection means in IMemoryStore. For that reason, we use the term "Index" in Pinecone to refer to what is a "Collection" in IMemoryStore. So, in the case of Pinecone, "Collection" is synonymous with "Index" when referring to IMemoryStore.

Constructors

PineconeMemoryStore(IPineconeClient, ILoggerFactory)	Initializes a new instance of the PineconeMemoryStore class.
PineconeMemoryStore(String, String, ILoggerFactory)	Initializes a new instance of the PineconeMemoryStore class.

Methods

ClearNamespaceAsync(String, String, CancellationToken)	Clears all vectors in the given namespace.
CreateCollectionAsync(String, CancellationToken)	Creates a new collection in the data store.
DeleteCollectionAsync(String, CancellationToken)	Deletes a collection from the data store.
DoesCollectionExistAsync(String, CancellationToken)	Determines if a collection exists in the data store.
GetAsync(String, String, Boolean, CancellationToken)	Gets a memory record from the data store. Does not guarantee that the collection exists.
GetBatchAsync(String, IEnumerable<String>, Boolean, CancellationToken)	Gets a batch of memory records from the data store. Does not guarantee that the collection exists.
GetBatchFromNamespaceAsync(String, String, IEnumerable<String>, Boolean, CancellationToken)	Gets a batch of memory records from the data store in the given namespace.
GetBatchWithFilterAsync(String, Dictionary<String,Object>, Int32, String, Boolean, CancellationToken)	Gets a memory record from the data store that matches the filter.
GetCollectionsAsync(CancellationToken)	Gets all collection names in the data store.
GetFromNamespaceAsync(String, String, String, Boolean, CancellationToken)	Gets a memory record from the data store in the given namespace.
GetNearestMatchAsync(String, ReadOnlyMemory<Single>, Double, Boolean, CancellationToken)	Gets the nearest match to an embedding of type Single. Does not guarantee that the collection exists.
GetNearestMatchesAsync(String, ReadOnlyMemory<Single>, Int32, Double, Boolean, CancellationToken)	Gets the nearest matches to an embedding of type Single. Does not guarantee that the collection exists.
GetNearestMatchesFromNamespaceAsync(String, String, ReadOnlyMemory<Single>, Int32, Double, Boolean, CancellationToken)	Gets the nearest matches to an embedding of type Single from the given namespace.
GetNearestMatchesWithFilterAsync(String, ReadOnlyMemory<Single>, Int32, Dictionary<String,Object>, Double, String, Boolean, CancellationToken)	Gets the nearest filtered matches to an embedding of type Single
GetNearestMatchFromNamespaceAsync(String, String, ReadOnlyMemory<Single>, Double, Boolean, CancellationToken)	Gets the nearest match to an embedding of type Single from the given namespace.
GetWithDocumentIdAsync(String, String, Int32, String, Boolean, CancellationToken)	Get a MemoryRecord from the Pinecone Vector database by pointId.
GetWithDocumentIdBatchAsync(String, IEnumerable<String>, Int32, String, Boolean, CancellationToken)	Get a MemoryRecord from the Pinecone Vector database by a group of documentIds.
ListNamespacesAsync(String, CancellationToken)	List Namespaces
RemoveAsync(String, String, CancellationToken)	Removes a memory record from the data store. Does not guarantee that the collection exists.
RemoveBatchAsync(String, IEnumerable<String>, CancellationToken)	Removes a batch of memory records from the data store. Does not guarantee that the collection exists.
RemoveBatchFromNamespaceAsync(String, String, IEnumerable<String>, CancellationToken)	Removes a batch of memory records from the data store in the given namespace.
RemoveFromNamespaceAsync(String, String, String, CancellationToken)	Removes a memory record from the data store in the given namespace.
RemoveWithDocumentIdAsync(String, String, String, CancellationToken)	Remove a MemoryRecord from the Pinecone Vector database by pointId.
RemoveWithDocumentIdBatchAsync(String, IEnumerable<String>, String, CancellationToken)	Remove a MemoryRecord from the Pinecone Vector database by a group of pointIds.
RemoveWithFilterAsync(String, Dictionary<String,Object>, String, CancellationToken)	Removes memory records from the data store that match the filter.
UpsertAsync(String, MemoryRecord, CancellationToken)	Upserts a memory record into the data store. Does not guarantee that the collection exists. If the record already exists, it will be updated. If the record does not exist, it will be created.
UpsertBatchAsync(String, IEnumerable<MemoryRecord>, CancellationToken)	Upserts a group of memory records into the data store. Does not guarantee that the collection exists. If the record already exists, it will be updated. If the record does not exist, it will be created.
UpsertBatchToNamespaceAsync(String, String, IEnumerable<MemoryRecord>, CancellationToken)	Upserts a group of memory records into the data store in the given namespace. If the record already exists, it will be updated. If the record does not exist, it will be created.
UpsertToNamespaceAsync(String, String, MemoryRecord, CancellationToken)	Upserts a memory record into the data store in the given namespace. If the record already exists, it will be updated. If the record does not exist, it will be created.

Applies to

Share via