Table of Contents

Method SubmitAsync

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

SubmitAsync(string, CancellationToken)

Submits a request to the model for text generation.

public Task<TextGenerationResult> SubmitAsync(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

Task<TextGenerationResult>

A TextGenerationResult object containing the generated text result.

Exceptions

OperationCanceledException

Thrown when the operation is cancelled based on the CancellationToken.

SubmitAsync(Prompt, CancellationToken)

Prompts the model with a structured request encapsulated in a Prompt object (asynchronously).

public Task<TextGenerationResult> SubmitAsync(Prompt prompt, CancellationToken cancellationToken = default)

Parameters

prompt Prompt

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

cancellationToken CancellationToken

Optional. A CancellationToken to handle cancellation requests.

Returns

Task<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.