Package com.google.datastore.v1

Interface FindNearestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FindNearest, FindNearest.Builder
public interface FindNearestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasVectorProperty

      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:
      Whether the vectorProperty field is set.

    • getVectorProperty

      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:
      The vectorProperty.

    • getVectorPropertyOrBuilder

      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];

    • hasQueryVector

      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:
      Whether the queryVector field is set.

    • getQueryVector

      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:
      The queryVector.

    • getQueryVectorOrBuilder

      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];

    • getDistanceMeasureValue

      int getDistanceMeasureValue()
       Required. The Distance Measure to use, required.
      .google.datastore.v1.FindNearest.DistanceMeasure distance_measure = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for distanceMeasure.

    • getDistanceMeasure

      FindNearest.DistanceMeasure getDistanceMeasure()
       Required. The Distance Measure to use, required.
      .google.datastore.v1.FindNearest.DistanceMeasure distance_measure = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The distanceMeasure.

    • hasLimit

      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:
      Whether the limit field is set.

    • getLimit

      com.google.protobuf.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:
      The limit.

    • getLimitOrBuilder

      com.google.protobuf.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];

    • getDistanceResultProperty

      String getDistanceResultProperty()
       Optional. Optional name of the field to output the result of the vector
 distance calculation. Must conform to [entity
 property][google.datastore.v1.Entity.properties] limitations.
      string distance_result_property = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The distanceResultProperty.

    • getDistanceResultPropertyBytes

      com.google.protobuf.ByteString getDistanceResultPropertyBytes()
       Optional. Optional name of the field to output the result of the vector
 distance calculation. Must conform to [entity
 property][google.datastore.v1.Entity.properties] limitations.
      string distance_result_property = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for distanceResultProperty.

    • hasDistanceThreshold

      boolean hasDistanceThreshold()
       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:
      Whether the distanceThreshold field is set.

    • getDistanceThreshold

      com.google.protobuf.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:
      The distanceThreshold.

    • getDistanceThresholdOrBuilder

      com.google.protobuf.DoubleValueOrBuilder getDistanceThresholdOrBuilder()
       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];