Method Summarize

Namespace

LMKit.TextGeneration

Assembly

LM-Kit.NET.dll

Summarize(string, CancellationToken)

Generates a summary from the provided content synchronously.

public Summarizer.SummarizerResult Summarize(string content, CancellationToken cancellationToken = default)

Parameters

content string

The input text to be summarized.

cancellationToken CancellationToken

An optional cancellation token for asynchronous operations.

Returns

Summarizer.SummarizerResult

An instance of Summarizer.SummarizerResult containing the title and/or content summary.

Examples

// Summarizing user input from the console.
var model = new LMKit.Model.LM("user-input-model.gguf");
var summarizer = new LMKit.TextGeneration.Summarizer(model)
{
    GenerateTitle = true,
    GenerateContent = true
};

Console.WriteLine("Please enter text to summarize:");
string userInput = Console.ReadLine();

var summaryResult = summarizer.Summarize(userInput);
Console.WriteLine("Title: " + summaryResult.Title);
Console.WriteLine("Summary: " + summaryResult.Content);

Exceptions

ArgumentException

Thrown if the provided content is null or empty.

Exception

Passes through any exceptions that occur during summarization.

Summarize(Attachment, CancellationToken)

Generates a summary from an image provided as an Attachment synchronously.

public Summarizer.SummarizerResult Summarize(Attachment content, CancellationToken cancellationToken = default)

Parameters

content Attachment

The image attachment to be summarized.

cancellationToken CancellationToken

An optional cancellation token for asynchronous operations.

Returns

Summarizer.SummarizerResult

An instance of Summarizer.SummarizerResult containing the generated title and/or summary content derived from the image.

Examples

// Synchronously summarize an image.
var model = new LMKit.Model.LM("vision-model.gguf");
var summarizer = new LMKit.TextGeneration.Summarizer(model);
var imageAttachment = new Attachment("path/to/image.jpg");
var summaryResult = summarizer.Summarize(imageAttachment);
Console.WriteLine("Image Summary: " + summaryResult.Content);

Exceptions

ArgumentException

Thrown if the provided image attachment is null.

InvalidModelException

Thrown when the underlying language model does not support vision input, which is required for analyzing image attachments.