Interface FindNeighborsResponse.NeighborOrBuilder (3.47.0)

public static interface FindNeighborsResponse.NeighborOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDatapoint()

public abstract IndexDatapoint getDatapoint()

The datapoint of the neighbor. Note that full datapoints are returned only when "return_full_datapoint" is set to true. Otherwise, only the "datapoint_id" and "crowding_tag" fields are populated.

.google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1;

Returns
Type Description
IndexDatapoint

The datapoint.

getDatapointOrBuilder()

public abstract IndexDatapointOrBuilder getDatapointOrBuilder()

The datapoint of the neighbor. Note that full datapoints are returned only when "return_full_datapoint" is set to true. Otherwise, only the "datapoint_id" and "crowding_tag" fields are populated.

.google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1;

Returns
Type Description
IndexDatapointOrBuilder

getDistance()

public abstract double getDistance()

The distance between the neighbor and the dense embedding query.

double distance = 2;

Returns
Type Description
double

The distance.

getSparseDistance()

public abstract double getSparseDistance()

The distance between the neighbor and the query sparse_embedding.

double sparse_distance = 3;

Returns
Type Description
double

The sparseDistance.

hasDatapoint()

public abstract boolean hasDatapoint()

The datapoint of the neighbor. Note that full datapoints are returned only when "return_full_datapoint" is set to true. Otherwise, only the "datapoint_id" and "crowding_tag" fields are populated.

.google.cloud.aiplatform.v1.IndexDatapoint datapoint = 1;

Returns
Type Description
boolean

Whether the datapoint field is set.