MemoryRecord Class

Reference

Definition

Namespace:: Microsoft.SemanticKernel.Memory

Assembly:: Microsoft.SemanticKernel.Abstractions.dll

Package:: Microsoft.SemanticKernel.Abstractions v1.20.0

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.

IMPORTANT: this is a storage schema. Changing the fields will invalidate existing metadata stored in persistent vector DBs.

public class MemoryRecord : Microsoft.SemanticKernel.Memory.DataEntryBase

type MemoryRecord = class
    inherit DataEntryBase

Public Class MemoryRecord
Inherits DataEntryBase

Inheritance: Object

DataEntryBase
MemoryRecord

Constructors

MemoryRecord(MemoryRecordMetadata, ReadOnlyMemory<Single>, String, Nullable<DateTimeOffset>)

Constructor, use ReferenceRecord(String, String, String, ReadOnlyMemory<Single>, String, String, Nullable<DateTimeOffset>) or LocalRecord(String, String, String, ReadOnlyMemory<Single>, String, String, Nullable<DateTimeOffset>)

Properties

Embedding	Source content embeddings.
HasTimestamp	`true` if the data has a timestamp. (Inherited from DataEntryBase)
Key	Gets the key of the data. (Inherited from DataEntryBase)
Metadata	Metadata associated with a Semantic Kernel memory.
Timestamp	Gets the timestamp of the data. (Inherited from DataEntryBase)

Methods

FromJsonMetadata(String, ReadOnlyMemory<Single>, String, Nullable<DateTimeOffset>)	Create a memory record from a serialized metadata string.
FromMetadata(MemoryRecordMetadata, ReadOnlyMemory<Single>, String, Nullable<DateTimeOffset>)	Create a memory record from a memory record's metadata.
GetSerializedMetadata()	Serialize the metadata of a memory record.
LocalRecord(String, String, String, ReadOnlyMemory<Single>, String, String, Nullable<DateTimeOffset>)	Prepare an instance for a memory stored in the internal storage provider.
ReferenceRecord(String, String, String, ReadOnlyMemory<Single>, String, String, Nullable<DateTimeOffset>)	Prepare an instance about a memory which source is stored externally. The universal resource identifies points to the URL (or equivalent) to find the original source.

Extension Methods

ToPineconeDocument(MemoryRecord)

Maps MemoryRecord instance to PineconeDocument.

Applies to

Share via