MongoDBMemoryStore.GetAsync Method

Reference

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.MongoDB

Assembly:: Microsoft.SemanticKernel.Connectors.MongoDB.dll

Package:: Microsoft.SemanticKernel.Connectors.MongoDB 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.

Gets a memory record from the data store. Does not guarantee that the collection exists.

public System.Threading.Tasks.Task<Microsoft.SemanticKernel.Memory.MemoryRecord?> GetAsync (string collectionName, string key, bool withEmbedding = false, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAsync : string * string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.SemanticKernel.Memory.MemoryRecord>
override this.GetAsync : string * string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.SemanticKernel.Memory.MemoryRecord>

Public Function GetAsync (collectionName As String, key As String, Optional withEmbedding As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of MemoryRecord)

Parameters

collectionName: String

The name associated with a collection of embeddings.

key: String

The unique id associated with the memory record to get.

withEmbedding: Boolean

If true, the embedding will be returned in the memory record.

cancellationToken: CancellationToken

The CancellationToken to monitor for cancellation requests. The default is None.

Returns

Task<MemoryRecord>

The memory record if found, otherwise null.

Implements

GetAsync(String, String, Boolean, CancellationToken)

Applies to

Share via