Package com.google.firestore.v1

Interface StructuredQuery.FindNearestOrBuilder

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

  • Method Details

    • hasVectorField

      boolean hasVectorField()
       Required. An indexed vector field to search upon. Only documents which
 contain vectors whose dimensionality match the query_vector can be
 returned.
      .google.firestore.v1.StructuredQuery.FieldReference vector_field = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the vectorField field is set.

    • getVectorField

      StructuredQuery.FieldReference getVectorField()
       Required. An indexed vector field to search upon. Only documents which
 contain vectors whose dimensionality match the query_vector can be
 returned.
      .google.firestore.v1.StructuredQuery.FieldReference vector_field = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The vectorField.

    • getVectorFieldOrBuilder

      StructuredQuery.FieldReferenceOrBuilder getVectorFieldOrBuilder()
       Required. An indexed vector field to search upon. Only documents which
 contain vectors whose dimensionality match the query_vector can be
 returned.
      .google.firestore.v1.StructuredQuery.FieldReference vector_field = 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.firestore.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.firestore.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.firestore.v1.Value query_vector = 2 [(.google.api.field_behavior) = REQUIRED];

    • getDistanceMeasureValue

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

    • getDistanceMeasure

      StructuredQuery.FindNearest.DistanceMeasure getDistanceMeasure()
       Required. The distance measure to use, required.
      .google.firestore.v1.StructuredQuery.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 1000.
      .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 1000.
      .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 1000.
      .google.protobuf.Int32Value limit = 4 [(.google.api.field_behavior) = REQUIRED];

    • getDistanceResultField

      String getDistanceResultField()
       Optional. Optional name of the field to output the result of the vector
 distance calculation. Must conform to [document field
 name][google.firestore.v1.Document.fields] limitations.
      string distance_result_field = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The distanceResultField.

    • getDistanceResultFieldBytes

      com.google.protobuf.ByteString getDistanceResultFieldBytes()
       Optional. Optional name of the field to output the result of the vector
 distance calculation. Must conform to [document field
 name][google.firestore.v1.Document.fields] limitations.
      string distance_result_field = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for distanceResultField.

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