# EmbeddingGeneration


```
object EmbeddingGeneration
```

<br />

*** ** * ** ***

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

## Summary

| ### Public functions |
|---|---|
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingModel>` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingGeneration#getEmbeddingModels(kotlin.String)(modelSignature: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html?)` Returns embedding models available on the device using default `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingOptions`, optionally filtered by `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingGeneration#getEmbeddingModels(kotlin.String)`. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingModel>` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingGeneration#getEmbeddingModels(com.google.mlkit.genai.embedding.EmbeddingOptions)(options: https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingOptions)` Returns embedding models available on the device matching the given `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingGeneration#getEmbeddingModels(com.google.mlkit.genai.embedding.EmbeddingOptions)`. |

## Public functions

### getEmbeddingModels

```
suspend fun getEmbeddingModels(modelSignature: String? = null): List<EmbeddingModel>
```

Returns embedding models available on the device using default `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingOptions`, optionally filtered by `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingGeneration#getEmbeddingModels(kotlin.String)`.

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

| Parameters |
|---|---|
| `modelSignature: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html? = null` | 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://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingModel>` | A list of matching `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingModel` instances available on the device. |

### getEmbeddingModels

```
suspend fun getEmbeddingModels(options: EmbeddingOptions): List<EmbeddingModel>
```

Returns embedding models available on the device matching the given `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingGeneration#getEmbeddingModels(com.google.mlkit.genai.embedding.EmbeddingOptions)`.

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

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

| Returns |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingModel>` | A list of matching `https://developers.google.com/android/reference/kotlin/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/kotlin/com/google/mlkit/genai/embedding/EmbeddingOptions#modelSignature()`. |