Added in API level 36
Also in T Extensions 16

EmbeddingVector

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
Public constructors
EmbeddingVector(values: FloatArray, modelSignature: String)

Creates a new EmbeddingVector.
Public methods
Int

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
String

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

Returns the values of this embedding vector.
Int

Returns a hash code value for the object.
Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<EmbeddingVector!>

Public constructors

EmbeddingVector

Added in API level 36
Also 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

describeContents

Added in API level 36
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 36
fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getModelSignature

Added in API level 36
Also 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 API level 36
Also in T Extensions 16
fun getValues(): FloatArray

Returns the values of this embedding vector.

Return
FloatArray This value cannot be null.

hashCode

Added in API level 36
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Return
Int a hash code value for this object.

writeToParcel

Added in API level 36
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 the following:

Properties

CREATOR

Added in API level 36
Also in T Extensions 16
static val CREATOR: Parcelable.Creator<EmbeddingVector!>