Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [T Extensions 18](https://developer.android.com/sdkExtensions) Summary: [Inherited Constants](https://developer.android.com/reference/android/app/appsearch/SearchResult.EmbeddingMatchInfo#inhconstants) \| [Fields](https://developer.android.com/reference/android/app/appsearch/SearchResult.EmbeddingMatchInfo#lfields) \| [Ctors](https://developer.android.com/reference/android/app/appsearch/SearchResult.EmbeddingMatchInfo#pubctors) \| [Methods](https://developer.android.com/reference/android/app/appsearch/SearchResult.EmbeddingMatchInfo#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/app/appsearch/SearchResult.EmbeddingMatchInfo#inhmethods)

# SearchResult.EmbeddingMatchInfo

*** ** * ** ***

` public static final class SearchResult.EmbeddingMatchInfo `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.app.appsearch.SearchResult.EmbeddingMatchInfo |

<br />

*** ** * ** ***

This class represents match objects for any snippets that might be present in `https://developer.android.com/reference/android/app/appsearch/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 `https://developer.android.com/reference/android/app/appsearch/EmbeddingVector` in the list returned by `https://developer.android.com/reference/android/app/appsearch/SearchSpec#getEmbeddingParameters()`
- the embedding search metric type for the corresponding query

for each vector match in the document.

<br />

## Summary

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/app/appsearch/SearchResult.EmbeddingMatchInfo>` | `https://developer.android.com/reference/android/app/appsearch/SearchResult.EmbeddingMatchInfo#CREATOR` <br /> |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/app/appsearch/SearchResult.EmbeddingMatchInfo#EmbeddingMatchInfo(double,%20int,%20int)(double semanticScore, int queryEmbeddingVectorIndex, int embeddingSearchMetricType) ` Creates a new immutable EmbeddingMatchInfo. |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/app/appsearch/SearchResult.EmbeddingMatchInfo#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` int` | ` https://developer.android.com/reference/android/app/appsearch/SearchResult.EmbeddingMatchInfo#getEmbeddingSearchMetricType()() ` Gets the embedding search metric type that this embedding match corresponds to. |
| ` int` | ` https://developer.android.com/reference/android/app/appsearch/SearchResult.EmbeddingMatchInfo#getQueryEmbeddingVectorIndex()() ` Gets the index of the query vector that this embedding match corresponds to. |
| ` double` | ` https://developer.android.com/reference/android/app/appsearch/SearchResult.EmbeddingMatchInfo#getSemanticScore()() ` Gets the semantic score corresponding to the embedding match. |
| ` void` | ` https://developer.android.com/reference/android/app/appsearch/SearchResult.EmbeddingMatchInfo#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Fields

### CREATOR

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [T Extensions 18](https://developer.android.com/sdkExtensions)

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

<br />

<br />

## Public constructors

### EmbeddingMatchInfo

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [T Extensions 18](https://developer.android.com/sdkExtensions)

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

Creates a new immutable EmbeddingMatchInfo.

<br />

| Parameters ||
|---|---|
| `semanticScore` | `double`: the semantic score of the embedding match against the query vector. <br /> |
| `queryEmbeddingVectorIndex` | `int`: the index of the matched query embedding vector in `https://developer.android.com/reference/android/app/appsearch/SearchSpec#getEmbeddingParameters()` <br /> |
| `embeddingSearchMetricType` | `int`: the search metric type used to calculate the score for the match and the query vector. Value is one of the following: - `https://developer.android.com/reference/android/app/appsearch/SearchSpec#EMBEDDING_SEARCH_METRIC_TYPE_DEFAULT` - `https://developer.android.com/reference/android/app/appsearch/SearchSpec#EMBEDDING_SEARCH_METRIC_TYPE_COSINE` - `https://developer.android.com/reference/android/app/appsearch/SearchSpec#EMBEDDING_SEARCH_METRIC_TYPE_DOT_PRODUCT` - `https://developer.android.com/reference/android/app/appsearch/SearchSpec#EMBEDDING_SEARCH_METRIC_TYPE_EUCLIDEAN` |

## Public methods

### describeContents

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public int describeContents ()
```

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getEmbeddingSearchMetricType

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [T Extensions 18](https://developer.android.com/sdkExtensions)

```
public int getEmbeddingSearchMetricType ()
```

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

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/app/appsearch/SearchSpec#EMBEDDING_SEARCH_METRIC_TYPE_DEFAULT` - `https://developer.android.com/reference/android/app/appsearch/SearchSpec#EMBEDDING_SEARCH_METRIC_TYPE_COSINE` - `https://developer.android.com/reference/android/app/appsearch/SearchSpec#EMBEDDING_SEARCH_METRIC_TYPE_DOT_PRODUCT` - `https://developer.android.com/reference/android/app/appsearch/SearchSpec#EMBEDDING_SEARCH_METRIC_TYPE_EUCLIDEAN` |

### getQueryEmbeddingVectorIndex

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [T Extensions 18](https://developer.android.com/sdkExtensions)

```
public int getQueryEmbeddingVectorIndex ()
```

Gets the index of the query vector that this embedding match corresponds to. This is the index of the query `https://developer.android.com/reference/android/app/appsearch/EmbeddingVector` in the list returned by `https://developer.android.com/reference/android/app/appsearch/SearchSpec#getEmbeddingParameters()`

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getSemanticScore

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)  
Also in [T Extensions 18](https://developer.android.com/sdkExtensions)

```
public double getSemanticScore ()
```

Gets the semantic score corresponding to the embedding match.

<br />

| Returns ||
|---|---|
| `double` | <br /> |

### writeToParcel

Added in [version 36.1](https://developer.android.com/topic/libraries/support-library/revisions)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |