Table of Contents

Class NativeAPI.EmbeddingEngineSettings

Namespace
Uralstech.UAI.LiteRTLM.Native
public static class NativeAPI.EmbeddingEngineSettings
Inheritance
object
NativeAPI.EmbeddingEngineSettings

Methods

litert_lm_embedding_engine_settings_create(string, string, string?, string?)

Creates LiteRT LM Embedding Engine Settings. The caller is responsible for destroying the settings using litert_lm_embedding_engine_settings_delete(nint).

public static extern nint litert_lm_embedding_engine_settings_create(string modelPath, string backendStr, string? visionBackendStr, string? audioBackendStr)

Parameters

modelPath string

The path to the model file.

backendStr string

The backend to use (e.g., "cpu", "gpu", "npu").

visionBackendStr string

The vision backend to use, or null if not set.

audioBackendStr string

The audio backend to use, or null if not set.

Returns

nint

A pointer to the created settings, or nint.Zero on failure.

litert_lm_embedding_engine_settings_delete(nint)

Destroys LiteRT LM Embedding Engine Settings.

public static extern void litert_lm_embedding_engine_settings_delete(nint settings)

Parameters

settings nint

The settings to destroy.

litert_lm_embedding_engine_settings_set_activation_data_type(nint, ActivationDataType)

Sets the activation data type for the embedding engine settings.

public static extern void litert_lm_embedding_engine_settings_set_activation_data_type(nint settings, ActivationDataType activationDataType)

Parameters

settings nint

The embedding engine settings.

activationDataType ActivationDataType

The activation data type (FLOAT32, FLOAT16, etc.).

litert_lm_embedding_engine_settings_set_audio_litert_dispatch_lib_dir(nint, string)

Sets the LiteRT dispatch library directory for the audio NPU backend.

public static extern void litert_lm_embedding_engine_settings_set_audio_litert_dispatch_lib_dir(nint settings, string libDir)

Parameters

settings nint

The embedding engine settings.

libDir string

The dispatch library directory.

litert_lm_embedding_engine_settings_set_audio_num_threads(nint, int)

Sets the number of threads for the audio CPU backend in Embedding Engine Settings.

public static extern void litert_lm_embedding_engine_settings_set_audio_num_threads(nint settings, int numThreads)

Parameters

settings nint

The embedding engine settings.

numThreads int

The number of threads.

litert_lm_embedding_engine_settings_set_cache_dir(nint, string)

Sets the cache directory for the Embedding Engine.

public static extern void litert_lm_embedding_engine_settings_set_cache_dir(nint settings, string cacheDir)

Parameters

settings nint

The embedding engine settings.

cacheDir string

The cache directory.

litert_lm_embedding_engine_settings_set_litert_dispatch_lib_dir(nint, string)

Sets the LiteRT dispatch library directory for the main NPU backend.

public static extern void litert_lm_embedding_engine_settings_set_litert_dispatch_lib_dir(nint settings, string libDir)

Parameters

settings nint

The embedding engine settings.

libDir string

The dispatch library directory.

litert_lm_embedding_engine_settings_set_max_input_length(nint, int)

Sets the maximum sequence length (in tokens) for text encoder signatures in Embedding Engine Settings.

public static extern void litert_lm_embedding_engine_settings_set_max_input_length(nint settings, int maxInputLength)

Parameters

settings nint

The embedding engine settings.

maxInputLength int

The maximum input length. Passing a non-positive value unsets the option.

litert_lm_embedding_engine_settings_set_min_input_length(nint, int)

Sets the minimum sequence length (in tokens) for text encoder signatures in Embedding Engine Settings.

public static extern void litert_lm_embedding_engine_settings_set_min_input_length(nint settings, int minInputLength)

Parameters

settings nint

The embedding engine settings.

minInputLength int

The minimum input length. Passing a negative value unsets the option.

litert_lm_embedding_engine_settings_set_num_threads(nint, int)

Sets the number of threads for the CPU backend in Embedding Engine Settings.

public static extern void litert_lm_embedding_engine_settings_set_num_threads(nint settings, int numThreads)

Parameters

settings nint

The embedding engine settings.

numThreads int

The number of threads.

litert_lm_embedding_engine_settings_set_vision_litert_dispatch_lib_dir(nint, string)

Sets the LiteRT dispatch library directory for the vision NPU backend.

public static extern void litert_lm_embedding_engine_settings_set_vision_litert_dispatch_lib_dir(nint settings, string libDir)

Parameters

settings nint

The embedding engine settings.

libDir string

The dispatch library directory.

litert_lm_embedding_engine_settings_set_vision_tokens_per_image(nint, int)

Sets the desired number of vision tokens generated per image in Embedding Engine Settings.

public static extern void litert_lm_embedding_engine_settings_set_vision_tokens_per_image(nint settings, int visionTokensPerImage)

Parameters

settings nint

The embedding engine settings.

visionTokensPerImage int

The vision tokens per image. Passing a non-positive value unsets the option.