Class SearchResult.SearchResultMetadata.Builder (0.21.0)

public static final class SearchResult.SearchResultMetadata.Builder extends GeneratedMessage.Builder<SearchResult.SearchResultMetadata.Builder> implements SearchResult.SearchResultMetadataOrBuilder

Quality signals describing how this result was retrieved, combined and re-ranked. Only populated when BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.search_signals_enabled is true.

Protobuf type google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllSearchDistances(Iterable<? extends SearchResult.SearchResultMetadata.SearchDistance> values)

public SearchResult.SearchResultMetadata.Builder addAllSearchDistances(Iterable<? extends SearchResult.SearchResultMetadata.SearchDistance> values)

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
values Iterable<? extends com.google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata.SearchDistance>
Returns
Type Description
SearchResult.SearchResultMetadata.Builder

addSearchDistances(SearchResult.SearchResultMetadata.SearchDistance value)

public SearchResult.SearchResultMetadata.Builder addSearchDistances(SearchResult.SearchResultMetadata.SearchDistance value)

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
value SearchResult.SearchResultMetadata.SearchDistance
Returns
Type Description
SearchResult.SearchResultMetadata.Builder

addSearchDistances(SearchResult.SearchResultMetadata.SearchDistance.Builder builderForValue)

public SearchResult.SearchResultMetadata.Builder addSearchDistances(SearchResult.SearchResultMetadata.SearchDistance.Builder builderForValue)

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
builderForValue SearchResult.SearchResultMetadata.SearchDistance.Builder
Returns
Type Description
SearchResult.SearchResultMetadata.Builder

addSearchDistances(int index, SearchResult.SearchResultMetadata.SearchDistance value)

public SearchResult.SearchResultMetadata.Builder addSearchDistances(int index, SearchResult.SearchResultMetadata.SearchDistance value)

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];

Parameters
Name Description
index int
value SearchResult.SearchResultMetadata.SearchDistance
Returns
Type Description
SearchResult.SearchResultMetadata.Builder

addSearchDistances(int index, SearchResult.SearchResultMetadata.SearchDistance.Builder builderForValue)

public SearchResult.SearchResultMetadata.Builder addSearchDistances(int index, SearchResult.SearchResultMetadata.SearchDistance.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue SearchResult.SearchResultMetadata.SearchDistance.Builder
Returns
Type Description
SearchResult.SearchResultMetadata.Builder

addSearchDistancesBuilder()

public SearchResult.SearchResultMetadata.SearchDistance.Builder addSearchDistancesBuilder()

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
SearchResult.SearchResultMetadata.SearchDistance.Builder

addSearchDistancesBuilder(int index)

public SearchResult.SearchResultMetadata.SearchDistance.Builder addSearchDistancesBuilder(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.Builder

build()

public SearchResult.SearchResultMetadata build()
Returns
Type Description
SearchResult.SearchResultMetadata

buildPartial()

public SearchResult.SearchResultMetadata buildPartial()
Returns
Type Description
SearchResult.SearchResultMetadata

clear()

public SearchResult.SearchResultMetadata.Builder clear()
Returns
Type Description
SearchResult.SearchResultMetadata.Builder
Overrides

clearRrfRankerResult()

public SearchResult.SearchResultMetadata.Builder clearRrfRankerResult()

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.Builder

clearSearchDistances()

public SearchResult.SearchResultMetadata.Builder clearSearchDistances()

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
SearchResult.SearchResultMetadata.Builder

clearVertexRankerResult()

public SearchResult.SearchResultMetadata.Builder clearVertexRankerResult()

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.Builder

getDefaultInstanceForType()

public SearchResult.SearchResultMetadata getDefaultInstanceForType()
Returns
Type Description
SearchResult.SearchResultMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getRrfRankerResult()

public 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.

getRrfRankerResultBuilder()

public SearchResult.SearchResultMetadata.RrfRankerResult.Builder getRrfRankerResultBuilder()

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.Builder

getRrfRankerResultOrBuilder()

public 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 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

getSearchDistancesBuilder(int index)

public SearchResult.SearchResultMetadata.SearchDistance.Builder getSearchDistancesBuilder(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.Builder

getSearchDistancesBuilderList()

public List<SearchResult.SearchResultMetadata.SearchDistance.Builder> getSearchDistancesBuilderList()

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<Builder>

getSearchDistancesCount()

public 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 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 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 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 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.

getVertexRankerResultBuilder()

public SearchResult.SearchResultMetadata.VertexRankerResult.Builder getVertexRankerResultBuilder()

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.Builder

getVertexRankerResultOrBuilder()

public 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchResult.SearchResultMetadata other)

public SearchResult.SearchResultMetadata.Builder mergeFrom(SearchResult.SearchResultMetadata other)
Parameter
Name Description
other SearchResult.SearchResultMetadata
Returns
Type Description
SearchResult.SearchResultMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchResult.SearchResultMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResult.SearchResultMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchResult.SearchResultMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchResult.SearchResultMetadata.Builder
Overrides

mergeRrfRankerResult(SearchResult.SearchResultMetadata.RrfRankerResult value)

public SearchResult.SearchResultMetadata.Builder mergeRrfRankerResult(SearchResult.SearchResultMetadata.RrfRankerResult value)

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];

Parameter
Name Description
value SearchResult.SearchResultMetadata.RrfRankerResult
Returns
Type Description
SearchResult.SearchResultMetadata.Builder

mergeVertexRankerResult(SearchResult.SearchResultMetadata.VertexRankerResult value)

public SearchResult.SearchResultMetadata.Builder mergeVertexRankerResult(SearchResult.SearchResultMetadata.VertexRankerResult value)

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];

Parameter
Name Description
value SearchResult.SearchResultMetadata.VertexRankerResult
Returns
Type Description
SearchResult.SearchResultMetadata.Builder

removeSearchDistances(int index)

public SearchResult.SearchResultMetadata.Builder removeSearchDistances(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.Builder

setRrfRankerResult(SearchResult.SearchResultMetadata.RrfRankerResult value)

public SearchResult.SearchResultMetadata.Builder setRrfRankerResult(SearchResult.SearchResultMetadata.RrfRankerResult value)

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];

Parameter
Name Description
value SearchResult.SearchResultMetadata.RrfRankerResult
Returns
Type Description
SearchResult.SearchResultMetadata.Builder

setRrfRankerResult(SearchResult.SearchResultMetadata.RrfRankerResult.Builder builderForValue)

public SearchResult.SearchResultMetadata.Builder setRrfRankerResult(SearchResult.SearchResultMetadata.RrfRankerResult.Builder builderForValue)

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];

Parameter
Name Description
builderForValue SearchResult.SearchResultMetadata.RrfRankerResult.Builder
Returns
Type Description
SearchResult.SearchResultMetadata.Builder

setSearchDistances(int index, SearchResult.SearchResultMetadata.SearchDistance value)

public SearchResult.SearchResultMetadata.Builder setSearchDistances(int index, SearchResult.SearchResultMetadata.SearchDistance value)

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];

Parameters
Name Description
index int
value SearchResult.SearchResultMetadata.SearchDistance
Returns
Type Description
SearchResult.SearchResultMetadata.Builder

setSearchDistances(int index, SearchResult.SearchResultMetadata.SearchDistance.Builder builderForValue)

public SearchResult.SearchResultMetadata.Builder setSearchDistances(int index, SearchResult.SearchResultMetadata.SearchDistance.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue SearchResult.SearchResultMetadata.SearchDistance.Builder
Returns
Type Description
SearchResult.SearchResultMetadata.Builder

setVertexRankerResult(SearchResult.SearchResultMetadata.VertexRankerResult value)

public SearchResult.SearchResultMetadata.Builder setVertexRankerResult(SearchResult.SearchResultMetadata.VertexRankerResult value)

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];

Parameter
Name Description
value SearchResult.SearchResultMetadata.VertexRankerResult
Returns
Type Description
SearchResult.SearchResultMetadata.Builder

setVertexRankerResult(SearchResult.SearchResultMetadata.VertexRankerResult.Builder builderForValue)

public SearchResult.SearchResultMetadata.Builder setVertexRankerResult(SearchResult.SearchResultMetadata.VertexRankerResult.Builder builderForValue)

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];

Parameter
Name Description
builderForValue SearchResult.SearchResultMetadata.VertexRankerResult.Builder
Returns
Type Description
SearchResult.SearchResultMetadata.Builder