SearchResult.EmbeddingMatchInfo

Kotlin |Java

public static final class SearchResult.EmbeddingMatchInfo
extends Object implements Parcelable

java.lang.Object
↳	android.app.appsearch.SearchResult.EmbeddingMatchInfo

This class represents match objects for any snippets that might be present in SearchResults from an embedding query. Using this class, you can get:

the semantic score of the matching vector with the embedding query
the query embedding vector index - the index of the query EmbeddingVector in the list returned by SearchSpec.getEmbeddingParameters()
the embedding search metric type for the corresponding query

for each vector match in the document.

Summary

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<SearchResult.EmbeddingMatchInfo>`	`CREATOR`

Public constructors
`EmbeddingMatchInfo(double semanticScore, int queryEmbeddingVectorIndex, int embeddingSearchMetricType)` Creates a new immutable EmbeddingMatchInfo.

Public methods
`int`	`getEmbeddingSearchMetricType()` Gets the embedding search metric type that this embedding match corresponds to.
`int`	`getQueryEmbeddingVectorIndex()` Gets the index of the query vector that this embedding match corresponds to.
`double`	`getSemanticScore()` Gets the semantic score corresponding to the embedding match.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Added in T Extensions 18

public static final Creator<SearchResult.EmbeddingMatchInfo> CREATOR

Added in T Extensions 18

public EmbeddingMatchInfo (double semanticScore, 
                int queryEmbeddingVectorIndex, 
                int embeddingSearchMetricType)

Creates a new immutable EmbeddingMatchInfo.

Parameters
`semanticScore`	`double`: the semantic score of the embedding match against the query vector.
`queryEmbeddingVectorIndex`	`int`: the index of the matched query embedding vector in `SearchSpec.getEmbeddingParameters()`
`embeddingSearchMetricType`	`int`: the search metric type used to calculate the score for the match and the query vector Value is `SearchSpec.EMBEDDING_SEARCH_METRIC_TYPE_DEFAULT`, `SearchSpec.EMBEDDING_SEARCH_METRIC_TYPE_COSINE`, `SearchSpec.EMBEDDING_SEARCH_METRIC_TYPE_DOT_PRODUCT`, or `SearchSpec.EMBEDDING_SEARCH_METRIC_TYPE_EUCLIDEAN`

Added in T Extensions 18

public int getEmbeddingSearchMetricType ()

Gets the embedding search metric type that this embedding match corresponds to.

Returns
`int`	Value is `SearchSpec.EMBEDDING_SEARCH_METRIC_TYPE_DEFAULT`, `SearchSpec.EMBEDDING_SEARCH_METRIC_TYPE_COSINE`, `SearchSpec.EMBEDDING_SEARCH_METRIC_TYPE_DOT_PRODUCT`, or `SearchSpec.EMBEDDING_SEARCH_METRIC_TYPE_EUCLIDEAN`

Added in T Extensions 18

public int getQueryEmbeddingVectorIndex ()

Gets the index of the query vector that this embedding match corresponds to. This is the index of the query EmbeddingVector in the list returned by SearchSpec.getEmbeddingParameters()

Returns
`int`

Added in T Extensions 18

public double getSemanticScore ()

Gets the semantic score corresponding to the embedding match.

Returns
`double`

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES