Method Submit

Namespace

LMKit.TextGeneration

Assembly

LM-Kit.NET.dll

Submit(string, CancellationToken)

Submits a request to the model for text generation.

public TextGenerationResult Submit(string prompt, CancellationToken cancellationToken = default)

Parameters

prompt string

The user's request in natural language.

cancellationToken CancellationToken

Optional. A CancellationToken to handle cancellation requests.

Returns

TextGenerationResult

A TextGenerationResult object containing the generated text result.

Examples

using LMKit.Model;
using LMKit.TextGeneration;
using System;

LM model = LM.LoadFromModelID("llama-3.2-1b");
SingleTurnConversation conversation = new SingleTurnConversation(model);

// Submit a simple text prompt
var result = conversation.Submit("Explain quantum computing in simple terms.");

Console.WriteLine(result.Completion);
Console.WriteLine($"Input tokens: {result.InputTokens}");
Console.WriteLine($"Output tokens: {result.CompletionTokens}");
Console.WriteLine($"Stop reason: {result.StopReason}");

Exceptions

OperationCanceledException

Thrown when the operation is cancelled based on the CancellationToken.

Submit(Message, CancellationToken)

Prompts the model with a structured request encapsulated in a ChatHistory.Message object.

public TextGenerationResult Submit(ChatHistory.Message prompt, CancellationToken cancellationToken = default)

Parameters

prompt ChatHistory.Message

An instance of ChatHistory.Message representing the user's request, potentially including text and attachments.

cancellationToken CancellationToken

Optional. A CancellationToken for handling cancellation requests.

Returns

TextGenerationResult

A TextGenerationResult object holding the result of the text generation operation.

Exceptions

ArgumentNullException

Thrown when the provided prompt argument is null.

OperationCanceledException

Thrown when the operation is cancelled based on the CancellationToken.