Method DetectLanguage

Namespace

LMKit.Translation

Assembly

LM-Kit.NET.dll

DetectLanguage(string, IEnumerable<Language>, CancellationToken)

Detects the language of the specified text synchronously.

public Language DetectLanguage(string text, IEnumerable<Language> languages = null, CancellationToken cancellationToken = default)

Parameters

text string

The text to analyze. It must contain at least one letter; otherwise, Undefined is returned.

languages IEnumerable<Language>

An optional collection of languages to consider during detection. If omitted, all languages defined in the Language enumeration are considered.

cancellationToken CancellationToken

An optional token to monitor for cancellation requests.

Returns

Language

A member of the Language enumeration representing the detected language, or Undefined if no valid language can be determined.

Examples

// Initialize the language model.
LM languageModel = new LM("path/to/your/model");

// Create an instance of TextTranslation.
TextTranslation translator = new TextTranslation(languageModel);

// Sample text for language detection.
string text = "Bonjour, comment allez-vous?";

// Detect the language.
Language detectedLanguage = translator.DetectLanguage(text);

Console.WriteLine($"Detected Language: {detectedLanguage}");

Remarks

This method internally wraps the asynchronous detection operation. It tokenizes the input text, filters out irrelevant parts, and uses a categorization engine to identify the most likely language.

DetectLanguage(Attachment, IEnumerable<Language>, CancellationToken)

Synchronously detects the language of the content provided via an Attachment.

public Language DetectLanguage(Attachment attachment, IEnumerable<Language> languages = null, CancellationToken cancellationToken = default)

Parameters

attachment Attachment

An Attachment that may contain text or image data to be analyzed.

languages IEnumerable<Language>

An optional collection of languages to consider during detection. If not provided, the full range of languages in the Language enumeration is used.

cancellationToken CancellationToken

An optional token for cancellation requests.

Returns

Language

A member of the Language enumeration indicating the detected language, or Undefined if detection fails.

Remarks

This method wraps the asynchronous language detection operation, blocking until it completes. Any exceptions thrown during the asynchronous execution are propagated as their underlying inner exception.

Exceptions

InvalidModelException

Thrown if the language model does not support vision input, which is required to analyze image attachments.

ArgumentNullException

Thrown if the provided attachment is null.