com.google.cloud.aiplatform.v1beta1

Interface NearestNeighbors.NeighborOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

NearestNeighbors.Neighbor, NearestNeighbors.Neighbor.Builder

Enclosing class:

NearestNeighbors

public static interface NearestNeighbors.NeighborOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
double	getDistance() The distance between the neighbor and the query vector.
String	getEntityId() The id of the similar entity.
com.google.protobuf.ByteString	getEntityIdBytes() The id of the similar entity.
FetchFeatureValuesResponse	getEntityKeyValues() The attributes of the neighbor, e.g.
FetchFeatureValuesResponseOrBuilder	getEntityKeyValuesOrBuilder() The attributes of the neighbor, e.g.
boolean	hasEntityKeyValues() The attributes of the neighbor, e.g.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getEntityId

String getEntityId()

 The id of the similar entity.
 

string entity_id = 1;

Returns:

The entityId.

getEntityIdBytes

com.google.protobuf.ByteString getEntityIdBytes()

 The id of the similar entity.
 

string entity_id = 1;

Returns:

The bytes for entityId.

getDistance

double getDistance()

 The distance between the neighbor and the query vector.
 

double distance = 2;

Returns:

The distance.

hasEntityKeyValues

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.v1beta1.FetchFeatureValuesResponse entity_key_values = 3;

Returns:

Whether the entityKeyValues field is set.

getEntityKeyValues

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.v1beta1.FetchFeatureValuesResponse entity_key_values = 3;

Returns:

The entityKeyValues.

getEntityKeyValuesOrBuilder

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.v1beta1.FetchFeatureValuesResponse entity_key_values = 3;