EmbeddingGeneration

public static class EmbeddingGeneration


Entry point for getting EmbeddingModel instances.

Summary

Public fields

static @NonNull EmbeddingGeneration

Public methods

final @NonNull List<@NonNull EmbeddingModel>
getEmbeddingModels(String modelSignature)

Returns embedding models available on the device using default EmbeddingOptions, optionally filtered by modelSignature.

final @NonNull List<@NonNull EmbeddingModel>

Returns embedding models available on the device matching the given options.

Public fields

INSTANCE

public static @NonNull EmbeddingGeneration INSTANCE

Public methods

getEmbeddingModels

public final @NonNull List<@NonNull EmbeddingModel> getEmbeddingModels(String modelSignature)

Returns embedding models available on the device using default EmbeddingOptions, optionally filtered by modelSignature.

Each returned EmbeddingModel holds client resources; callers should call EmbeddingModel.close on any unused instances and when finished.

Parameters
String modelSignature

The signature of the desired embedding model. If null or empty, returns all available embedding models on the device; otherwise returns only models matching the signature (or an empty list if none match).

Returns
@NonNull List<@NonNull EmbeddingModel>

A list of matching EmbeddingModel instances available on the device.

getEmbeddingModels

public final @NonNull List<@NonNull EmbeddingModel> getEmbeddingModels(@NonNull EmbeddingOptions options)

Returns embedding models available on the device matching the given options.

Each returned EmbeddingModel holds client resources; callers should call EmbeddingModel.close on any unused instances and when finished.

Parameters
@NonNull EmbeddingOptions options

The EmbeddingOptions specifying an optional model signature filter and background executor.

Returns
@NonNull List<@NonNull EmbeddingModel>

A list of matching EmbeddingModel instances available on the device, or an empty list if no available model matches EmbeddingOptions.modelSignature.