Class Engine

Namespace

Uralstech.UAI.LiteRTLM

public sealed class Engine : LiteRTLMNativeHandle

Inheritance

object

LiteRTLMNativeHandle

Engine

Inherited Members

LiteRTLMNativeHandle.Dispose()

Constructors

Engine(EngineSettings)

Creates a managed wrapper around a LiteRT LM engine from the given settings. The caller is responsible for disposing the wrapper using Dispose().

public Engine(EngineSettings settings)

Parameters

settings EngineSettings

The engine settings.

Exceptions

InvalidOperationException

Thrown if the native object could not be created.

Methods

CreateSession(SessionConfig?)

Creates a managed wrapper around a LiteRT LM session. The caller is responsible for disposing the wrapper using Dispose().

public Session? CreateSession(SessionConfig? config = null)

Parameters

config SessionConfig

The session configuration to use. If null, the default session configuration is used.

Returns

Session

The created session wrapper, or null on failure.

Detokenize(int[])

Detokenizes token ids using the engine's tokenizer.

public DetokenizeResult? Detokenize(int[] tokens)

Parameters

tokens int[]

An array of token ids to detokenize.

Returns

DetokenizeResult

The detokenize result wrapper, or null on failure. The caller is responsible for disposing the returned wrapper.

GetStartToken()

Returns the configured start token (BOS), if any.

public TokenUnion? GetStartToken()

Returns

TokenUnion

The start token wrapper, or null if none is configured. The caller is responsible for disposing the returned wrapper.

GetStopTokens()

Returns the configured stop tokens (EOS).

public TokenUnions? GetStopTokens()

Returns

TokenUnions

The stop tokens wrapper, or null if none are configured. The caller is responsible for disposing the returned wrapper.

ReleaseUnmanagedResources()

protected override void ReleaseUnmanagedResources()

Tokenize(string)

Tokenizes text using the engine's tokenizer.

public TokenizeResult? Tokenize(string text)

Parameters

text string

The UTF-8 string to tokenize.

Returns

TokenizeResult

The tokenize result wrapper, or null on failure. The caller is responsible for disposing the returned wrapper.