MemoryRecordMetadata Class

Definition

Class representing the metadata associated with a Semantic Kernel memory.

public class MemoryRecordMetadata : ICloneable
type MemoryRecordMetadata = class
    interface ICloneable
Public Class MemoryRecordMetadata
Implements ICloneable
Inheritance
MemoryRecordMetadata
Implements

Constructors

MemoryRecordMetadata(Boolean, String, String, String, String, String)

Constructor.

Properties

AdditionalMetadata

Field for saving custom metadata with a memory.

Description

Optional title describing the content. Note: the title is not indexed.

ExternalSourceName

A value used to understand which external service owns the data, to avoid storing the information inside the URI. E.g. this could be "MSTeams", "WebSite", "GitHub", etc.

Id

Unique identifier. The format of the value is domain specific, so it can be a URL, a GUID, etc.

IsReference

Whether the source data used to calculate embeddings are stored in the local storage provider or is available through and external service, such as web site, MS Graph, etc.

Text

Source text, available only when the memory is not an external source.

Methods

Clone()

Creates a shallow copy of MemoryRecordMetadata.

Applies to