Interface FindNearestOrBuilder (2.25.1)

public interface FindNearestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDistanceMeasure()

public abstract FindNearest.DistanceMeasure getDistanceMeasure()

Required. The Distance Measure to use, required.

.google.datastore.v1.FindNearest.DistanceMeasure distance_measure = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`FindNearest.DistanceMeasure`	The distanceMeasure.

getDistanceMeasureValue()

public abstract int getDistanceMeasureValue()

Required. The Distance Measure to use, required.

.google.datastore.v1.FindNearest.DistanceMeasure distance_measure = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`	The enum numeric value on the wire for distanceMeasure.

getDistanceResultProperty()

public abstract String getDistanceResultProperty()

Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations.

string distance_result_property = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The distanceResultProperty.

getDistanceResultPropertyBytes()

public abstract ByteString getDistanceResultPropertyBytes()

Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations.

string distance_result_property = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for distanceResultProperty.

getDistanceThreshold()

public abstract DoubleValue getDistanceThreshold()

Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified distance_measure will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted.

For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold

.google.protobuf.DoubleValue distance_threshold = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`DoubleValue`	The distanceThreshold.

getDistanceThresholdOrBuilder()

public abstract DoubleValueOrBuilder getDistanceThresholdOrBuilder()

For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold

.google.protobuf.DoubleValue distance_threshold = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`DoubleValueOrBuilder`

getLimit()

public abstract Int32Value getLimit()

Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100.

.google.protobuf.Int32Value limit = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Int32Value`	The limit.

getLimitOrBuilder()

public abstract Int32ValueOrBuilder getLimitOrBuilder()

Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100.

.google.protobuf.Int32Value limit = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Int32ValueOrBuilder`

getQueryVector()

public abstract Value getQueryVector()

Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.

.google.datastore.v1.Value query_vector = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Value`	The queryVector.

getQueryVectorOrBuilder()

public abstract ValueOrBuilder getQueryVectorOrBuilder()

Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.

.google.datastore.v1.Value query_vector = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ValueOrBuilder`

getVectorProperty()

public abstract PropertyReference getVectorProperty()

Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.

.google.datastore.v1.PropertyReference vector_property = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`PropertyReference`	The vectorProperty.

getVectorPropertyOrBuilder()

public abstract PropertyReferenceOrBuilder getVectorPropertyOrBuilder()

Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.

.google.datastore.v1.PropertyReference vector_property = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`PropertyReferenceOrBuilder`

hasDistanceThreshold()

public abstract boolean hasDistanceThreshold()

For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold

.google.protobuf.DoubleValue distance_threshold = 6 [(.google.api.field_behavior) = OPTIONAL];

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

hasLimit()

public abstract boolean hasLimit()

Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100.

.google.protobuf.Int32Value limit = 4 [(.google.api.field_behavior) = REQUIRED];

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

hasQueryVector()

public abstract boolean hasQueryVector()

Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.

.google.datastore.v1.Value query_vector = 2 [(.google.api.field_behavior) = REQUIRED];

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

hasVectorProperty()

public abstract boolean hasVectorProperty()

Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.

.google.datastore.v1.PropertyReference vector_property = 1 [(.google.api.field_behavior) = REQUIRED];

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