Method SaveInformationAsync

Namespace

LMKit.Agents

Assembly

LM-Kit.NET.dll

SaveInformationAsync(string, string, string, MetadataCollection, CancellationToken)

Asynchronously saves text information into a designated memory data source.

The method stores the given text and assigns it a unique section identifier. Optionally, additional metadata can be associated with the stored section.

public Task<DataSource> SaveInformationAsync(string dataSourceIdentifier, string text, string sectionIdentifier, MetadataCollection additionalMetadata = null, CancellationToken cancellationToken = default)

Parameters

dataSourceIdentifier string

The unique identifier for the data source where the information will be stored.

text string

The text content to be saved.

sectionIdentifier string

A unique identifier for this particular piece of information.

additionalMetadata MetadataCollection

Optional metadata to associate with the stored information.

cancellationToken CancellationToken

An optional token that can be used to cancel the operation.

Returns

Task<DataSource>

A task that represents the asynchronous operation. The task result is a DataSource that encapsulates the stored data.

Exceptions

ArgumentException

Thrown if dataSourceIdentifier, text, or sectionIdentifier is null or empty.

SaveInformationAsync(string, string, string, MemoryType, MetadataCollection, CancellationToken)

Asynchronously saves text information into a designated memory data source, allowing you to specify the memory type.

The method stores the given text and assigns it a unique section identifier. Optionally, additional metadata can be associated with the stored section.

public Task<DataSource> SaveInformationAsync(string dataSourceIdentifier, string text, string sectionIdentifier, MemoryType memoryType, MetadataCollection additionalMetadata = null, CancellationToken cancellationToken = default)

Parameters

dataSourceIdentifier string

The unique identifier for the data source where the information will be stored.

text string

The text content to be saved.

sectionIdentifier string

A unique identifier for this particular piece of information.

memoryType MemoryType

Specifies the type of memory to use when saving the information. This parameter influences how the text is processed and stored, and may determine the underlying memory model (e.g., Semantic).

additionalMetadata MetadataCollection

Optional metadata to associate with the stored information.

cancellationToken CancellationToken

An optional token that can be used to cancel the operation.

Returns

Task<DataSource>

A task that represents the asynchronous operation. The task result is a DataSource that encapsulates the stored data.

Exceptions

ArgumentException

Thrown if dataSourceIdentifier, text, or sectionIdentifier is null or empty, or if the provided memory type is incompatible with the existing memory type in the data source.