# EmbeddingGeneration


```
public static class EmbeddingGeneration
```

<br />

*** ** * ** ***

Entry point for getting `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingModel` instances.

## Summary

| ### Public fields |
|---|---|
| `static @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingGeneration` | `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingGeneration#INSTANCE()` |

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingModel>` | `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingGeneration#getEmbeddingModels(kotlin.String)(https://developer.android.com/reference/java/lang/String.html modelSignature)` Returns embedding models available on the device using default `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingOptions`, optionally filtered by `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingGeneration#getEmbeddingModels(kotlin.String)`. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingModel>` | `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingGeneration#getEmbeddingModels(com.google.mlkit.genai.embedding.EmbeddingOptions)(@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingOptions options)` Returns embedding models available on the device matching the given `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingGeneration#getEmbeddingModels(com.google.mlkit.genai.embedding.EmbeddingOptions)`. |

## 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 `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingOptions`, optionally filtered by `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingGeneration#getEmbeddingModels(kotlin.String)`.

Each returned `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingModel` holds client resources; callers should call `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingModel#close()` on any unused instances and when finished.

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html 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 |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingModel>` | A list of matching `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/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 `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingGeneration#getEmbeddingModels(com.google.mlkit.genai.embedding.EmbeddingOptions)`.

Each returned `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingModel` holds client resources; callers should call `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingModel#close()` on any unused instances and when finished.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingOptions options` | The `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingOptions` specifying an optional model signature filter and background executor. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingModel>` | A list of matching `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingModel` instances available on the device, or an empty list if no available model matches `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingOptions#modelSignature()`. |