Table of Contents

Method ImportTextAsync

Namespace
LMKit.Retrieval
Assembly
LM-Kit.NET.dll

ImportTextAsync(string, string, string, CancellationToken)

Asynchronously imports a text string into a DataSource, creating a new section.

public Task<DataSource> ImportTextAsync(string data, string dataSourceIdentifier, string sectionIdentifier, CancellationToken cancellationToken = default)

Parameters

data string

The text to import.

dataSourceIdentifier string

The unique identifier for the target DataSource. If the identifier exists, the text is added as a new section; otherwise, a new data source is created.

sectionIdentifier string

The identifier for the new section.

cancellationToken CancellationToken

Optional cancellation token.

Returns

Task<DataSource>

A task that resolves to the DataSource containing the imported text.

Examples

// Example: Asynchronously import a string into a data source.
LM embeddingModel = LM.LoadFromModelID("nomic-embed-text");
RagEngine ragEngine = new RagEngine(embeddingModel);
string textData = "Lorem ipsum dolor sit amet, consectetur adipiscing elit.";
DataSource dataSource = await ragEngine.ImportTextAsync(
    data: textData,
    dataSourceIdentifier: "latinData",
    sectionIdentifier: "introduction"
);
Console.WriteLine($"Data imported into source: {dataSource.Identifier}");

Exceptions

ArgumentNullException

Thrown if data or dataSourceIdentifier is null or empty.

OperationCanceledException

Thrown if the operation is canceled.

ImportTextAsync(string, TextChunking, string, string, CancellationToken)

Asynchronously imports a text string into a DataSource, creating a new section.

public Task<DataSource> ImportTextAsync(string data, TextChunking textChunking, string dataSourceIdentifier, string sectionIdentifier, CancellationToken cancellationToken = default)

Parameters

data string

The text to import.

textChunking TextChunking

Specifies how to split the text into chunks.

dataSourceIdentifier string

The unique identifier for the target DataSource. If the identifier exists, the text is added as a new section; otherwise, a new data source is created.

sectionIdentifier string

The identifier for the new section.

cancellationToken CancellationToken

Optional cancellation token.

Returns

Task<DataSource>

A task that resolves to the DataSource containing the imported text.

Examples

// Example: Asynchronously import a string into a data source.
LM embeddingModel = LM.LoadFromModelID("nomic-embed-text");
RagEngine ragEngine = new RagEngine(embeddingModel);
string textData = "Lorem ipsum dolor sit amet, consectetur adipiscing elit.";
DataSource dataSource = await ragEngine.ImportTextAsync(
    data: textData,
    textChunking: new TextChunking() { MaxChunkSize = 200 },
    dataSourceIdentifier: "latinData",
    sectionIdentifier: "introduction"
);
Console.WriteLine($"Data imported into source: {dataSource.Identifier}");

Exceptions

ArgumentNullException

Thrown if data or dataSourceIdentifier is null or empty.

OperationCanceledException

Thrown if the operation is canceled.

ImportTextAsync(string, string, string, MetadataCollection, CancellationToken)

Asynchronously imports a text string into a DataSource, creating a new section, and attaches additional metadata information.

public Task<DataSource> ImportTextAsync(string data, string dataSourceIdentifier, string sectionIdentifier, MetadataCollection additionalMetadata, CancellationToken cancellationToken = default)

Parameters

data string

The text to import.

dataSourceIdentifier string

The unique identifier for the target DataSource. If the identifier exists, the text is added as a new section; otherwise, a new data source is created.

sectionIdentifier string

The identifier for the new section.

additionalMetadata MetadataCollection

Metadata to associate with the imported section.

cancellationToken CancellationToken

Optional cancellation token.

Returns

Task<DataSource>

A task that resolves to the DataSource containing the imported text.

ImportTextAsync(string, TextChunking, string, string, MetadataCollection, CancellationToken)

Asynchronously imports a text string into a DataSource, creating a new section, and attaches additional metadata information.

public Task<DataSource> ImportTextAsync(string data, TextChunking textChunking, string dataSourceIdentifier, string sectionIdentifier, MetadataCollection additionalMetadata, CancellationToken cancellationToken = default)

Parameters

data string

The text to import.

textChunking TextChunking

Specifies how to split the text into chunks.

dataSourceIdentifier string

The unique identifier for the target DataSource. If the identifier exists, the text is added as a new section; otherwise, a new data source is created.

sectionIdentifier string

The identifier for the new section.

additionalMetadata MetadataCollection

Metadata to associate with the imported section.

cancellationToken CancellationToken

Optional cancellation token.

Returns

Task<DataSource>

A task that resolves to the DataSource containing the imported text.

ImportTextAsync(IList<string>, string, IList<string>, IList<MetadataCollection>, CancellationToken)

Asynchronously imports an array of text strings into a DataSource, creating a new section for each text string.

public Task<DataSource> ImportTextAsync(IList<string> data, string dataSourceIdentifier, IList<string> sectionIdentifiers, IList<MetadataCollection> metadataCollections = null, CancellationToken cancellationToken = default)

Parameters

data IList<string>

A list of text strings to import, each representing a page.

dataSourceIdentifier string

The unique identifier for the target DataSource. If the data source exists, new sections are added; otherwise, a new one is created.

sectionIdentifiers IList<string>

A list of unique identifiers for the new sections. The number of identifiers must match the number of text strings.

metadataCollections IList<MetadataCollection>

An optional list of metadata collections to associate with each imported section.

cancellationToken CancellationToken

Optional cancellation token.

Returns

Task<DataSource>

A task that resolves to the updated or newly created DataSource with the imported text pages.

Exceptions

ArgumentNullException

Thrown if data, dataSourceIdentifier, or sectionIdentifiers is null or empty.

ArgumentOutOfRangeException

Thrown if the count of sectionIdentifiers does not match the number of text strings.

ImportTextAsync(IList<string>, TextChunking, string, IList<string>, IList<MetadataCollection>, CancellationToken)

Asynchronously imports an array of text strings into a DataSource, creating a new section for each text string.

public Task<DataSource> ImportTextAsync(IList<string> data, TextChunking textChunking, string dataSourceIdentifier, IList<string> sectionIdentifiers, IList<MetadataCollection> metadataCollections = null, CancellationToken cancellationToken = default)

Parameters

data IList<string>

A list of text strings to import, each representing a page.

textChunking TextChunking

Specifies how to split each text into chunks.

dataSourceIdentifier string

The unique identifier for the target DataSource. If the data source exists, new sections are added; otherwise, a new one is created.

sectionIdentifiers IList<string>

A list of unique identifiers for the new sections. The number of identifiers must match the number of text strings.

metadataCollections IList<MetadataCollection>

An optional list of metadata collections to associate with each imported section.

cancellationToken CancellationToken

Optional cancellation token.

Returns

Task<DataSource>

A task that resolves to the updated or newly created DataSource with the imported text pages.

Examples

// Example: Asynchronously import an array of text pages.
LM embeddingModel = LM.LoadFromModelID("nomic-embed-text");
RagEngine ragEngine = new RagEngine(embeddingModel);
var pages = new List<string>
{
    "Page 1: Introduction to RAG systems.",
    "Page 2: Advanced RAG techniques."
};
var sectionIds = new List<string> { "chapter1", "chapter2" };
DataSource ds = await ragEngine.ImportTextAsync(
    data: pages,
    textChunking: new TextChunking() { MaxChunkSize = 300 },
    dataSourceIdentifier: "ragBook",
    sectionIdentifiers: sectionIds
);
Console.WriteLine($"Imported {pages.Count} pages into DataSource: {ds.Identifier}");

Exceptions

ArgumentNullException

Thrown if data, dataSourceIdentifier, or sectionIdentifiers is null or empty.

ArgumentOutOfRangeException

Thrown if the count of sectionIdentifiers does not match the number of text strings.