Class NativeAPI.EmbeddingOptions

Namespace

Uralstech.UAI.LiteRTLM.Native

public static class NativeAPI.EmbeddingOptions

Inheritance

object

NativeAPI.EmbeddingOptions

Methods

litert_lm_embedding_options_create()

Creates LiteRT LM Embedding Options with default values (normalize = true, insert_special_tokens = true). The caller is responsible for destroying options using litert_lm_embedding_options_delete(nint).

public static extern nint litert_lm_embedding_options_create()

Returns

nint

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

litert_lm_embedding_options_delete(nint)

Destroys LiteRT LM Embedding Options.

public static extern void litert_lm_embedding_options_delete(nint options)

Parameters

options nint

The options to destroy.

litert_lm_embedding_options_get_input_overflow_strategy(nint)

Gets the input overflow strategy.

public static extern InputOverflowStrategy litert_lm_embedding_options_get_input_overflow_strategy(nint options)

Parameters

options nint

The options to inspect.

Returns

InputOverflowStrategy

The overflow strategy configured in options.

litert_lm_embedding_options_get_insert_special_tokens(nint)

Gets whether special tokens should be automatically inserted.

public static extern bool litert_lm_embedding_options_get_insert_special_tokens(nint options)

Parameters

options nint

The options to inspect.

Returns

bool

true if special tokens insertion is enabled; otherwise, false.

litert_lm_embedding_options_get_normalize(nint)

Gets whether the embedding should be L2 normalized.

public static extern bool litert_lm_embedding_options_get_normalize(nint options)

Parameters

options nint

The options to inspect.

Returns

bool

true if normalization is enabled; otherwise, false.

litert_lm_embedding_options_get_output_size(nint)

Gets the output embedding size.

public static extern int litert_lm_embedding_options_get_output_size(nint options)

Parameters

options nint

The options to inspect.

Returns

int

The output embedding size, or -1 if not set (using default size).

litert_lm_embedding_options_get_vision_tokens_per_image(nint)

Gets the vision tokens per image.

public static extern int litert_lm_embedding_options_get_vision_tokens_per_image(nint options)

Parameters

options nint

The options to inspect.

Returns

int

The vision tokens per image configured in options, or 0 if not set.

litert_lm_embedding_options_set_input_overflow_strategy(nint, InputOverflowStrategy)

Sets the input overflow strategy.

public static extern void litert_lm_embedding_options_set_input_overflow_strategy(nint options, InputOverflowStrategy strategy)

Parameters

options nint

The options to modify.

strategy InputOverflowStrategy

The overflow strategy to use.

litert_lm_embedding_options_set_insert_special_tokens(nint, bool)

Sets whether special tokens (BOS, EOS, start/end of image, start/end of audio) should be automatically inserted.

public static extern void litert_lm_embedding_options_set_insert_special_tokens(nint options, bool insertSpecialTokens)

Parameters

options nint

The options to modify.

insertSpecialTokens bool

Whether to insert special tokens.

litert_lm_embedding_options_set_normalize(nint, bool)

Sets whether the embedding should be L2 normalized.

public static extern void litert_lm_embedding_options_set_normalize(nint options, bool normalize)

Parameters

options nint

The options to modify.

normalize bool

Whether to normalize.

litert_lm_embedding_options_set_output_size(nint, int)

Sets the output embedding size to truncate the embedding to.

public static extern void litert_lm_embedding_options_set_output_size(nint options, int outputSize)

Parameters

options nint

The options to modify.

outputSize int

The output embedding size to truncate to. Pass 0 or a negative value (e.g., 0 or -1) to unset and use the default output embedding size.

litert_lm_embedding_options_set_vision_tokens_per_image(nint, int)

Sets the vision tokens per image.

public static extern void litert_lm_embedding_options_set_vision_tokens_per_image(nint options, int visionTokensPerImage)

Parameters

options nint

The options to modify.

visionTokensPerImage int

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