EmbeddingVector

Kotlin |Java

class EmbeddingVector : Parcelable

kotlin.Any
↳	android.app.appsearch.EmbeddingVector

Embeddings are vector representations of data, such as text, images, and audio, which can be generated by machine learning models and used for semantic search. This class represents an embedding vector, which wraps a float array for the values of the embedding vector and a model signature that can be any string to distinguish between embedding vectors generated by different models.

For more details on how embedding search works, check AppSearchSession.search and SearchSpec.Builder.setRankingStrategy(String).

Summary

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
`EmbeddingVector(values: FloatArray, modelSignature: String)` Creates a new `EmbeddingVector`.

Public methods
Boolean	`equals(other: Any?)`
String	`getModelSignature()` Returns the model signature of this embedding vector, which is an arbitrary string to distinguish between embedding vectors generated by different models.
FloatArray	`getValues()` Returns the values of this embedding vector.
Int	`hashCode()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<EmbeddingVector!>	`CREATOR`

Public constructors

EmbeddingVector

Added in T Extensions 16

EmbeddingVector(
    values: FloatArray, 
    modelSignature: String)

Creates a new EmbeddingVector.

Parameters
`values`	FloatArray: This value cannot be `null`.
`modelSignature`	String: This value cannot be `null`.

Exceptions
`java.lang.IllegalArgumentException`	if `values` is empty.

Public methods

equals

fun equals(other: Any?): Boolean

getModelSignature

Added in T Extensions 16

fun getModelSignature(): String

Returns the model signature of this embedding vector, which is an arbitrary string to distinguish between embedding vectors generated by different models.

Return
`String`	This value cannot be `null`.

getValues

Added in T Extensions 16

fun getValues(): FloatArray

Returns the values of this embedding vector.

Return
`FloatArray`	This value cannot be `null`.

hashCode

fun hashCode(): Int

writeToParcel

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in T Extensions 16

static val CREATOR: Parcelable.Creator<EmbeddingVector!>