Share via


MemoryItem Class

Definition

A single memory item stored in the memory store, containing content and metadata. Please note MemoryItem is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include UserProfileMemoryItem.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.AgentServer.Contracts.Generated.MemoryStore.UnknownMemoryItem))]
public abstract class MemoryItem : Azure.AI.AgentServer.Contracts.Generated.Common.IUtf8JsonSerializable, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.MemoryStore.MemoryItem>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.MemoryStore.MemoryItem>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.AgentServer.Contracts.Generated.MemoryStore.UnknownMemoryItem))>]
type MemoryItem = class
    interface IUtf8JsonSerializable
    interface IJsonModel<MemoryItem>
    interface IPersistableModel<MemoryItem>
Public MustInherit Class MemoryItem
Implements IJsonModel(Of MemoryItem), IPersistableModel(Of MemoryItem), IUtf8JsonSerializable
Inheritance
MemoryItem
Derived
Attributes
Implements

Constructors

Name Description
MemoryItem()

Initializes a new instance of MemoryItem for deserialization.

MemoryItem(String, DateTimeOffset, String, String, MemoryItemKind, IDictionary<String,BinaryData>)

Initializes a new instance of MemoryItem.

MemoryItem(String, DateTimeOffset, String, String)

Initializes a new instance of MemoryItem.

Properties

Name Description
Content

The content of the memory.

Kind

The kind of the memory item.

MemoryId

The unique ID of the memory item.

Scope

The namespace that logically groups and isolates memories, such as a user ID.

UpdatedAt

The last update time of the memory item.

Methods

Name Description
DeserializeMemoryItem(JsonElement, ModelReaderWriterOptions)
FromResponse(Response)

Deserializes the model from a raw response.

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
ToRequestContent()

Convert into a RequestContent.

Explicit Interface Implementations

Name Description
IJsonModel<MemoryItem>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<MemoryItem>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<MemoryItem>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<MemoryItem>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<MemoryItem>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to