Class RecalledMemory

Namespace: LMKit.Agents.Memory

Assembly: LM-Kit.NET.dll

One memory returned by RecallAsync(string, int, CancellationToken): the stored text with its similarity to the query and the descriptive attributes it was stored with.

public sealed class RecalledMemory

Inheritance: object

RecalledMemory

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Examples

var recalled = await memory.RecallAsync("what does the user prefer?", topK: 5);

foreach (var entry in recalled)
{
    Console.WriteLine($"[{entry.MemoryType}/{entry.Importance}] {entry.Similarity:F2} {entry.Text}");
}

Properties

Category: Gets the free-form category label recorded when the memory was stored, or an empty string when none was.

CreatedAt: Gets the UTC creation timestamp, or null when the memory carries none.

DataSourceIdentifier: Gets the identifier of the data source holding this memory.

Importance: Gets the importance recorded when the memory was stored. Memories stored without one report Medium.

MemoryType: Gets the memory category of the data source this memory lives in.

Metadata: Gets the metadata stored with this memory's section.

SectionIdentifier: Gets the identifier of the section holding this memory.

Similarity: Gets the similarity between the query and this memory, on the scale recall ranks with (time decay included when enabled).

Text: Gets the stored memory text.