EmbeddingMetadata

public final class EmbeddingMetadata


Metadata for an EmbeddingModel.

Summary

Public constructors

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

Public methods

final LocalDate

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

final int

The output dimension of the generated EmbeddingVector (e.g., 768).

final LocalDate

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

final LocalDate

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

final @NonNull LocaleList

The LocaleList of locales supported by this model.

final @NonNull List<@Modality @NonNull Integer>

The list of supported input modalities for this model.

@NonNull String

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 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 LocaleList of locales supported by this model. An empty LocaleList 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 Modality for available values (e.g., Modality.TEXT, Modality.IMAGE).

toString

public @NonNull String toString()