IPineconeMemoryStore Interface
Definition
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.
Interface for Pinecone memory store that extends the memory store interface to add support for namespaces
public interface IPineconeMemoryStore : Microsoft.SemanticKernel.Memory.IMemoryStoretype IPineconeMemoryStore = interface
interface IMemoryStorePublic Interface IPineconeMemoryStore
Implements IMemoryStore- Derived
- Implements
Methods
| ClearNamespaceAsync(String, String, CancellationToken) |
Clears all vectors in the given namespace. |
| CreateCollectionAsync(String, CancellationToken) |
Creates a new collection in the data store. (Inherited from IMemoryStore) |
| DeleteCollectionAsync(String, CancellationToken) |
Deletes a collection from the data store. (Inherited from IMemoryStore) |
| DoesCollectionExistAsync(String, CancellationToken) |
Determines if a collection exists in the data store. (Inherited from IMemoryStore) |
| GetAsync(String, String, Boolean, CancellationToken) |
Gets a memory record from the data store. Does not guarantee that the collection exists. (Inherited from IMemoryStore) |
| GetBatchAsync(String, IEnumerable<String>, Boolean, CancellationToken) |
Gets a batch of memory records from the data store. Does not guarantee that the collection exists. (Inherited from IMemoryStore) |
| 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. (Inherited from IMemoryStore) |
| 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. (Inherited from IMemoryStore) |
| 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. (Inherited from IMemoryStore) |
| 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) |
Gets the memory records associated with the given document id. |
| GetWithDocumentIdBatchAsync(String, IEnumerable<String>, Int32, String, Boolean, CancellationToken) |
Gets the memory records associated with the given document ids. |
| ListNamespacesAsync(String, CancellationToken) |
List Namespaces |
| RemoveAsync(String, String, CancellationToken) |
Removes a memory record from the data store. Does not guarantee that the collection exists. (Inherited from IMemoryStore) |
| RemoveBatchAsync(String, IEnumerable<String>, CancellationToken) |
Removes a batch of memory records from the data store. Does not guarantee that the collection exists. (Inherited from IMemoryStore) |
| 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) |
Removes memory records from the data store associated with the document id. |
| RemoveWithDocumentIdBatchAsync(String, IEnumerable<String>, String, CancellationToken) |
Removes memory records from the data store that match the document ids. |
| 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. (Inherited from IMemoryStore) |
| 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. (Inherited from IMemoryStore) |
| 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. |