EmbeddingVector
class EmbeddingVector : Parcelable
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 methods |
| Boolean |
|
| 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 |
|
| Unit |
Flatten this object in to a Parcel.
|
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
| Parameters |
obj |
the reference object with which to compare. |
| 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.
hashCode
fun hashCode(): Int
| Return |
Int |
a hash code value for this object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
Properties
