Interface SearchResult.SearchResultMetadata.SearchDistanceOrBuilder (0.21.0)

0.21.0 (latest) 0.17.0 0.16.0 0.15.0 0.12.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.1.0

public static interface SearchResult.SearchResultMetadata.SearchDistanceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDistance()

public abstract double getDistance()

Output only. The similarity distance of this data object for the search.

double distance = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
double	The distance.

getRank()

public abstract int getRank()

Output only. The order of this data object in the search's result list, starting at 1 for the top (best-ranked) result.

int32 rank = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The rank.

getSearchIndex()

public abstract int getSearchIndex()

Output only. The index of the search in the BatchSearchDataObjectsRequest.searches this distance corresponds to.

int32 search_index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The searchIndex.