TextMemoryPlugin Class

Definition

TextMemoryPlugin provides a plugin to save or recall information from the long or short term memory.

public sealed class TextMemoryPlugin
type TextMemoryPlugin = class
Public NotInheritable Class TextMemoryPlugin
Inheritance
TextMemoryPlugin

Constructors

TextMemoryPlugin(ISemanticTextMemory, ILoggerFactory, JsonSerializerOptions)

Initializes a new instance of the TextMemoryPlugin class.

Fields

CollectionParam

Name used to specify which memory collection to use.

InputParam

Name used to specify the input text.

KeyParam

Name used to specify a unique key associated with stored information.

LimitParam

Name used to specify the number of memories to recall

RelevanceParam

Name used to specify memory search relevance score.

Methods

RecallAsync(String, String, Nullable<Double>, Nullable<Int32>, CancellationToken)

Semantic search and return up to N memories related to the input text

RemoveAsync(String, String, CancellationToken)

Remove specific memory

RetrieveAsync(String, String, CancellationToken)

Key-based lookup for a specific memory

SaveAsync(String, String, String, CancellationToken)

Save information to semantic memory

Applies to