Interface NearestNeighbors.NeighborOrBuilder (3.46.0)

public static interface NearestNeighbors.NeighborOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDistance()

public abstract double getDistance()

The distance between the neighbor and the query vector.

double distance = 2;

Returns
Type Description
double

The distance.

getEntityId()

public abstract String getEntityId()

The id of the similar entity.

string entity_id = 1;

Returns
Type Description
String

The entityId.

getEntityIdBytes()

public abstract ByteString getEntityIdBytes()

The id of the similar entity.

string entity_id = 1;

Returns
Type Description
ByteString

The bytes for entityId.

getEntityKeyValues()

public abstract FetchFeatureValuesResponse getEntityKeyValues()

The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true. Otherwise, only the "entity_id" and "distance" fields are populated.

.google.cloud.aiplatform.v1.FetchFeatureValuesResponse entity_key_values = 3;

Returns
Type Description
FetchFeatureValuesResponse

The entityKeyValues.

getEntityKeyValuesOrBuilder()

public abstract FetchFeatureValuesResponseOrBuilder getEntityKeyValuesOrBuilder()

The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true. Otherwise, only the "entity_id" and "distance" fields are populated.

.google.cloud.aiplatform.v1.FetchFeatureValuesResponse entity_key_values = 3;

Returns
Type Description
FetchFeatureValuesResponseOrBuilder

hasEntityKeyValues()

public abstract boolean hasEntityKeyValues()

The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true. Otherwise, only the "entity_id" and "distance" fields are populated.

.google.cloud.aiplatform.v1.FetchFeatureValuesResponse entity_key_values = 3;

Returns
Type Description
boolean

Whether the entityKeyValues field is set.