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 |
Public methods | |
---|---|
Boolean |
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 |
hashCode() |
Unit |
writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel. |
Properties | |
---|---|
static Parcelable.Creator<EmbeddingVector!> |
Public constructors
EmbeddingVector
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
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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
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
fun getValues(): FloatArray
Returns the values of this embedding vector.
Return | |
---|---|
FloatArray |
This value cannot be null . |
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
static val CREATOR: Parcelable.Creator<EmbeddingVector!>