# EmbeddingMetadata


```
public final class EmbeddingMetadata
```

<br />

*** ** * ** ***

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

## Summary

| ### Public constructors |
|---|
| `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingMetadata#EmbeddingMetadata(kotlin.Int,kotlin.collections.List,android.os.LocaleList,java.time.LocalDate,java.time.LocalDate,java.time.LocalDate)( int dimension, @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/util/List.html<@https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/Modality @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/lang/Integer.html> supportedModalities, @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/android/os/LocaleList.html supportedLocales, https://developer.android.com/reference/java/time/LocalDate.html releaseDate, https://developer.android.com/reference/java/time/LocalDate.html shutdownDate, https://developer.android.com/reference/java/time/LocalDate.html deprecationDate )` |

| ### Public methods |
|---|---|
| `final https://developer.android.com/reference/java/time/LocalDate.html` | `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingMetadata#getDeprecationDate()()` The UTC date when this model is marked deprecated and callers should migrate to a newer model, or `null` if not available. |
| `final int` | `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingMetadata#getDimension()()` The output dimension of the generated `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingVector` (e.g., 768). |
| `final https://developer.android.com/reference/java/time/LocalDate.html` | `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingMetadata#getReleaseDate()()` The UTC release date of this model, or `null` if not available. |
| `final https://developer.android.com/reference/java/time/LocalDate.html` | `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingMetadata#getShutdownDate()()` The planned UTC date when this model will be decommissioned and no longer served, or `null` if not available. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/android/os/LocaleList.html` | `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingMetadata#getSupportedLocales()()` The `https://developer.android.com/reference/android/os/LocaleList.html` of locales supported by this model. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/util/List.html<@https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/Modality @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/lang/Integer.html>` | `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingMetadata#getSupportedModalities()()` The list of supported input modalities for this model. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/lang/String.html` | `https://developers.google.com/android/reference/com/google/mlkit/genai/embedding/EmbeddingMetadata#toString()()` |

## Public constructors

### EmbeddingMetadata

```
public EmbeddingMetadata(
    int dimension,
    @NonNull List<@Modality @NonNull Integer> supportedModalities,
    @NonNull LocaleList supportedLocales,
    LocalDate releaseDate,
    LocalDate shutdownDate,
    LocalDate deprecationDate
)
```

## Public methods

### getDeprecationDate

```
public final LocalDate getDeprecationDate()
```

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

### getDimension

```
public final int getDimension()
```

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

### getReleaseDate

```
public final LocalDate getReleaseDate()
```

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

### getShutdownDate

```
public final LocalDate getShutdownDate()
```

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

### getSupportedLocales

```
public final @NonNull LocaleList getSupportedLocales()
```

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.

### getSupportedModalities

```
public final @NonNull List<@Modality @NonNull Integer> getSupportedModalities()
```

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

### toString

```
public @NonNull String toString()
```