public static interface SearchResult.SearchResultMetadataOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getRrfRankerResult()
public abstract SearchResult.SearchResultMetadata.RrfRankerResult getRrfRankerResult()Output only. The RRF combination signals for this data object. Only set when the request combines results using RRF.
.google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata.RrfRankerResult rrf_ranker_result = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
SearchResult.SearchResultMetadata.RrfRankerResult |
The rrfRankerResult. |
getRrfRankerResultOrBuilder()
public abstract SearchResult.SearchResultMetadata.RrfRankerResultOrBuilder getRrfRankerResultOrBuilder()Output only. The RRF combination signals for this data object. Only set when the request combines results using RRF.
.google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata.RrfRankerResult rrf_ranker_result = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
SearchResult.SearchResultMetadata.RrfRankerResultOrBuilder |
|
getSearchDistances(int index)
public abstract SearchResult.SearchResultMetadata.SearchDistance getSearchDistances(int index)Output only. The per-search distances for this data object, one entry per batch search that returned it.
repeated .google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata.SearchDistance search_distances = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResult.SearchResultMetadata.SearchDistance |
|
getSearchDistancesCount()
public abstract int getSearchDistancesCount()Output only. The per-search distances for this data object, one entry per batch search that returned it.
repeated .google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata.SearchDistance search_distances = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getSearchDistancesList()
public abstract List<SearchResult.SearchResultMetadata.SearchDistance> getSearchDistancesList()Output only. The per-search distances for this data object, one entry per batch search that returned it.
repeated .google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata.SearchDistance search_distances = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<SearchDistance> |
|
getSearchDistancesOrBuilder(int index)
public abstract SearchResult.SearchResultMetadata.SearchDistanceOrBuilder getSearchDistancesOrBuilder(int index)Output only. The per-search distances for this data object, one entry per batch search that returned it.
repeated .google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata.SearchDistance search_distances = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResult.SearchResultMetadata.SearchDistanceOrBuilder |
|
getSearchDistancesOrBuilderList()
public abstract List<? extends SearchResult.SearchResultMetadata.SearchDistanceOrBuilder> getSearchDistancesOrBuilderList()Output only. The per-search distances for this data object, one entry per batch search that returned it.
repeated .google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata.SearchDistance search_distances = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata.SearchDistanceOrBuilder> |
|
getVertexRankerResult()
public abstract SearchResult.SearchResultMetadata.VertexRankerResult getVertexRankerResult()Output only. The Vertex re-ranking signals for this data object. Only set when the request re-ranks results using the Vertex ranker.
.google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata.VertexRankerResult vertex_ranker_result = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
SearchResult.SearchResultMetadata.VertexRankerResult |
The vertexRankerResult. |
getVertexRankerResultOrBuilder()
public abstract SearchResult.SearchResultMetadata.VertexRankerResultOrBuilder getVertexRankerResultOrBuilder()Output only. The Vertex re-ranking signals for this data object. Only set when the request re-ranks results using the Vertex ranker.
.google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata.VertexRankerResult vertex_ranker_result = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
SearchResult.SearchResultMetadata.VertexRankerResultOrBuilder |
|
hasRrfRankerResult()
public abstract boolean hasRrfRankerResult()Output only. The RRF combination signals for this data object. Only set when the request combines results using RRF.
.google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata.RrfRankerResult rrf_ranker_result = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the rrfRankerResult field is set. |
hasVertexRankerResult()
public abstract boolean hasVertexRankerResult()Output only. The Vertex re-ranking signals for this data object. Only set when the request re-ranks results using the Vertex ranker.
.google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata.VertexRankerResult vertex_ranker_result = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the vertexRankerResult field is set. |