EmbeddingMetadata

class EmbeddingMetadata


Metadata for an EmbeddingModel.

Summary

Public constructors

EmbeddingMetadata(
    dimension: Int,
    supportedModalities: List<@Modality Int>,
    supportedLocales: LocaleList,
    releaseDate: LocalDate?,
    shutdownDate: LocalDate?,
    deprecationDate: LocalDate?
)

Public functions

open String

Public properties

LocalDate?

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

Int

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

LocalDate?

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

LocalDate?

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

LocaleList

The LocaleList of locales supported by this model.

List<Int>

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