Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Interface SearchResultOrBuilder (0.21.0)

public interface SearchResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDataObject()

public abstract DataObject getDataObject()

Output only. The matching data object.

.google.cloud.vectorsearch.v1beta.DataObject data_object = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`DataObject`	The dataObject.

getDataObjectOrBuilder()

public abstract DataObjectOrBuilder getDataObjectOrBuilder()

Output only. The matching data object.

.google.cloud.vectorsearch.v1beta.DataObject data_object = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`DataObjectOrBuilder`

getDistance()

public abstract double getDistance()

Output only. Similarity distance or ranker score returned by BatchSearchDataObjects.

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

Returns
Type	Description
`double`	The distance.

getSearchResultMetadata()

public abstract SearchResult.SearchResultMetadata getSearchResultMetadata()

Output only. Quality signals for this result. Only populated when BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.search_signals_enabled is true.

.google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata search_result_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`SearchResult.SearchResultMetadata`	The searchResultMetadata.

getSearchResultMetadataOrBuilder()

public abstract SearchResult.SearchResultMetadataOrBuilder getSearchResultMetadataOrBuilder()

Output only. Quality signals for this result. Only populated when BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.search_signals_enabled is true.

.google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata search_result_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`SearchResult.SearchResultMetadataOrBuilder`

hasDataObject()

public abstract boolean hasDataObject()

Output only. The matching data object.

.google.cloud.vectorsearch.v1beta.DataObject data_object = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the dataObject field is set.

hasDistance()

public abstract boolean hasDistance()

Output only. Similarity distance or ranker score returned by BatchSearchDataObjects.

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

Returns
Type	Description
`boolean`	Whether the distance field is set.

hasSearchResultMetadata()

public abstract boolean hasSearchResultMetadata()

Output only. Quality signals for this result. Only populated when BatchSearchDataObjectsRequest.BatchSearchMetadataOptions.search_signals_enabled is true.

.google.cloud.vectorsearch.v1beta.SearchResult.SearchResultMetadata search_result_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the searchResultMetadata field is set.