# EmbeddingMetadata


```
class EmbeddingMetadata
```

<br />

*** ** * ** ***

Metadata for an `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingModel`.

## Summary

| ### Public constructors |
|---|
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingMetadata#EmbeddingMetadata(kotlin.Int,kotlin.collections.List,android.os.LocaleList,java.time.LocalDate,java.time.LocalDate,java.time.LocalDate)( dimension: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html, supportedModalities: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<@https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/Modality https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html>, supportedLocales: https://developer.android.com/reference/android/os/LocaleList.html, releaseDate: https://developer.android.com/reference/java/time/LocalDate.html?, shutdownDate: https://developer.android.com/reference/java/time/LocalDate.html?, deprecationDate: https://developer.android.com/reference/java/time/LocalDate.html? )` |

| ### Public functions |
|---|---|
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingMetadata#toString()()` |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/java/time/LocalDate.html?` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingMetadata#deprecationDate()` The UTC date when this model is marked deprecated and callers should migrate to a newer model, or `null` if not available. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingMetadata#dimension()` The output dimension of the generated `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingVector` (e.g., 768). |
| `https://developer.android.com/reference/java/time/LocalDate.html?` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingMetadata#releaseDate()` The UTC release date of this model, or `null` if not available. |
| `https://developer.android.com/reference/java/time/LocalDate.html?` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingMetadata#shutdownDate()` The planned UTC date when this model will be decommissioned and no longer served, or `null` if not available. |
| `https://developer.android.com/reference/android/os/LocaleList.html` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingMetadata#supportedLocales()` The `https://developer.android.com/reference/android/os/LocaleList.html` of locales supported by this model. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html>` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingMetadata#supportedModalities()` The list of supported input modalities for this model. |

## Public constructors

### EmbeddingMetadata

```
EmbeddingMetadata(
    dimension: Int = 0,
    supportedModalities: List<@Modality Int> = listOf(Modality.TEXT),
    supportedLocales: LocaleList = LocaleList.getEmptyLocaleList(),
    releaseDate: LocalDate? = null,
    shutdownDate: LocalDate? = null,
    deprecationDate: LocalDate? = null
)
```

## Public functions

### toString

```
open fun toString(): String
```

## Public properties

### deprecationDate

```
val deprecationDate: LocalDate?
```

The UTC date when this model is marked deprecated and callers should migrate to a newer model, or `null` if not available.

### dimension

```
val dimension: Int
```

The output dimension of the generated `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/EmbeddingVector` (e.g., 768).

### releaseDate

```
val releaseDate: LocalDate?
```

The UTC release date of this model, or `null` if not available.

### shutdownDate

```
val shutdownDate: LocalDate?
```

The planned UTC date when this model will be decommissioned and no longer served, or `null` if not available.

### supportedLocales

```
val supportedLocales: LocaleList
```

The `https://developer.android.com/reference/android/os/LocaleList.html` of locales supported by this model. An empty `https://developer.android.com/reference/android/os/LocaleList.html` indicates that supported locales are unspecified or the model is locale-agnostic.

### supportedModalities

```
val supportedModalities: List<Int>
```

The list of supported input modalities for this model. See `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/Modality` for available values (e.g., `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/Modality#TEXT()`, `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/embedding/Modality#IMAGE()`).