Package io.qdrant.client.grpc

Interface Points.RecommendPointGroupsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Points.RecommendPointGroups, Points.RecommendPointGroups.Builder
Enclosing class:
Points
public static interface Points.RecommendPointGroupsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getCollectionName

      String getCollectionName()
       Name of the collection
      string collection_name = 1;
      Returns:
      The collectionName.

    • getCollectionNameBytes

      com.google.protobuf.ByteString getCollectionNameBytes()
       Name of the collection
      string collection_name = 1;
      Returns:
      The bytes for collectionName.

    • getPositiveList

      List<Points.PointId> getPositiveList()
       Look for vectors closest to the vectors from these points
      repeated .qdrant.PointId positive = 2;

    • getPositive

      Points.PointId getPositive(int index)
       Look for vectors closest to the vectors from these points
      repeated .qdrant.PointId positive = 2;

    • getPositiveCount

      int getPositiveCount()
       Look for vectors closest to the vectors from these points
      repeated .qdrant.PointId positive = 2;

    • getPositiveOrBuilderList

      List<? extends Points.PointIdOrBuilder> getPositiveOrBuilderList()
       Look for vectors closest to the vectors from these points
      repeated .qdrant.PointId positive = 2;

    • getPositiveOrBuilder

      Points.PointIdOrBuilder getPositiveOrBuilder(int index)
       Look for vectors closest to the vectors from these points
      repeated .qdrant.PointId positive = 2;

    • getNegativeList

      List<Points.PointId> getNegativeList()
       Try to avoid vectors like the vector from these points
      repeated .qdrant.PointId negative = 3;

    • getNegative

      Points.PointId getNegative(int index)
       Try to avoid vectors like the vector from these points
      repeated .qdrant.PointId negative = 3;

    • getNegativeCount

      int getNegativeCount()
       Try to avoid vectors like the vector from these points
      repeated .qdrant.PointId negative = 3;

    • getNegativeOrBuilderList

      List<? extends Points.PointIdOrBuilder> getNegativeOrBuilderList()
       Try to avoid vectors like the vector from these points
      repeated .qdrant.PointId negative = 3;

    • getNegativeOrBuilder

      Points.PointIdOrBuilder getNegativeOrBuilder(int index)
       Try to avoid vectors like the vector from these points
      repeated .qdrant.PointId negative = 3;

    • hasFilter

      boolean hasFilter()
       Filter conditions - return only those points that satisfy the specified conditions
      .qdrant.Filter filter = 4;
      Returns:
      Whether the filter field is set.

    • getFilter

      Points.Filter getFilter()
       Filter conditions - return only those points that satisfy the specified conditions
      .qdrant.Filter filter = 4;
      Returns:
      The filter.

    • getFilterOrBuilder

      Points.FilterOrBuilder getFilterOrBuilder()
       Filter conditions - return only those points that satisfy the specified conditions
      .qdrant.Filter filter = 4;

    • getLimit

      int getLimit()
       Max number of groups in result
      uint32 limit = 5;
      Returns:
      The limit.

    • hasWithPayload

      boolean hasWithPayload()
       Options for specifying which payload to include or not
      .qdrant.WithPayloadSelector with_payload = 6;
      Returns:
      Whether the withPayload field is set.

    • getWithPayload

      Points.WithPayloadSelector getWithPayload()
       Options for specifying which payload to include or not
      .qdrant.WithPayloadSelector with_payload = 6;
      Returns:
      The withPayload.

    • getWithPayloadOrBuilder

      Points.WithPayloadSelectorOrBuilder getWithPayloadOrBuilder()
       Options for specifying which payload to include or not
      .qdrant.WithPayloadSelector with_payload = 6;

    • hasParams

      boolean hasParams()
       Search config
      .qdrant.SearchParams params = 7;
      Returns:
      Whether the params field is set.

    • getParams

      Points.SearchParams getParams()
       Search config
      .qdrant.SearchParams params = 7;
      Returns:
      The params.

    • getParamsOrBuilder

      Points.SearchParamsOrBuilder getParamsOrBuilder()
       Search config
      .qdrant.SearchParams params = 7;

    • hasScoreThreshold

      boolean hasScoreThreshold()
       If provided - cut off results with worse scores
      optional float score_threshold = 8;
      Returns:
      Whether the scoreThreshold field is set.

    • getScoreThreshold

      float getScoreThreshold()
       If provided - cut off results with worse scores
      optional float score_threshold = 8;
      Returns:
      The scoreThreshold.

    • hasUsing

      boolean hasUsing()
       Define which vector to use for recommendation, if not specified - default vector
      optional string using = 9;
      Returns:
      Whether the using field is set.

    • getUsing

      String getUsing()
       Define which vector to use for recommendation, if not specified - default vector
      optional string using = 9;
      Returns:
      The using.

    • getUsingBytes

      com.google.protobuf.ByteString getUsingBytes()
       Define which vector to use for recommendation, if not specified - default vector
      optional string using = 9;
      Returns:
      The bytes for using.

    • hasWithVectors

      boolean hasWithVectors()
       Options for specifying which vectors to include into response
      optional .qdrant.WithVectorsSelector with_vectors = 10;
      Returns:
      Whether the withVectors field is set.

    • getWithVectors

      Points.WithVectorsSelector getWithVectors()
       Options for specifying which vectors to include into response
      optional .qdrant.WithVectorsSelector with_vectors = 10;
      Returns:
      The withVectors.

    • getWithVectorsOrBuilder

      Points.WithVectorsSelectorOrBuilder getWithVectorsOrBuilder()
       Options for specifying which vectors to include into response
      optional .qdrant.WithVectorsSelector with_vectors = 10;

    • hasLookupFrom

      boolean hasLookupFrom()
       Name of the collection to use for points lookup, if not specified - use current collection
      optional .qdrant.LookupLocation lookup_from = 11;
      Returns:
      Whether the lookupFrom field is set.

    • getLookupFrom

      Points.LookupLocation getLookupFrom()
       Name of the collection to use for points lookup, if not specified - use current collection
      optional .qdrant.LookupLocation lookup_from = 11;
      Returns:
      The lookupFrom.

    • getLookupFromOrBuilder

      Points.LookupLocationOrBuilder getLookupFromOrBuilder()
       Name of the collection to use for points lookup, if not specified - use current collection
      optional .qdrant.LookupLocation lookup_from = 11;

    • getGroupBy

      String getGroupBy()
       Payload field to group by, must be a string or number field. If there are multiple values for the field, all of them will be used. One point can be in multiple groups.
      string group_by = 12;
      Returns:
      The groupBy.

    • getGroupByBytes

      com.google.protobuf.ByteString getGroupByBytes()
       Payload field to group by, must be a string or number field. If there are multiple values for the field, all of them will be used. One point can be in multiple groups.
      string group_by = 12;
      Returns:
      The bytes for groupBy.

    • getGroupSize

      int getGroupSize()
       Maximum amount of points to return per group
      uint32 group_size = 13;
      Returns:
      The groupSize.

    • hasReadConsistency

      boolean hasReadConsistency()
       Options for specifying read consistency guarantees
      optional .qdrant.ReadConsistency read_consistency = 14;
      Returns:
      Whether the readConsistency field is set.

    • getReadConsistency

      Points.ReadConsistency getReadConsistency()
       Options for specifying read consistency guarantees
      optional .qdrant.ReadConsistency read_consistency = 14;
      Returns:
      The readConsistency.

    • getReadConsistencyOrBuilder

      Points.ReadConsistencyOrBuilder getReadConsistencyOrBuilder()
       Options for specifying read consistency guarantees
      optional .qdrant.ReadConsistency read_consistency = 14;

    • hasWithLookup

      boolean hasWithLookup()
       Options for specifying how to use the group id to lookup points in another collection
      optional .qdrant.WithLookup with_lookup = 15;
      Returns:
      Whether the withLookup field is set.

    • getWithLookup

      Points.WithLookup getWithLookup()
       Options for specifying how to use the group id to lookup points in another collection
      optional .qdrant.WithLookup with_lookup = 15;
      Returns:
      The withLookup.

    • getWithLookupOrBuilder

      Points.WithLookupOrBuilder getWithLookupOrBuilder()
       Options for specifying how to use the group id to lookup points in another collection
      optional .qdrant.WithLookup with_lookup = 15;

    • hasStrategy

      boolean hasStrategy()
       How to use the example vectors to find the results
      optional .qdrant.RecommendStrategy strategy = 17;
      Returns:
      Whether the strategy field is set.

    • getStrategyValue

      int getStrategyValue()
       How to use the example vectors to find the results
      optional .qdrant.RecommendStrategy strategy = 17;
      Returns:
      The enum numeric value on the wire for strategy.

    • getStrategy

      Points.RecommendStrategy getStrategy()
       How to use the example vectors to find the results
      optional .qdrant.RecommendStrategy strategy = 17;
      Returns:
      The strategy.

    • getPositiveVectorsList

      List<Points.Vector> getPositiveVectorsList()
       Look for vectors closest to those
      repeated .qdrant.Vector positive_vectors = 18;

    • getPositiveVectors

      Points.Vector getPositiveVectors(int index)
       Look for vectors closest to those
      repeated .qdrant.Vector positive_vectors = 18;

    • getPositiveVectorsCount

      int getPositiveVectorsCount()
       Look for vectors closest to those
      repeated .qdrant.Vector positive_vectors = 18;

    • getPositiveVectorsOrBuilderList

      List<? extends Points.VectorOrBuilder> getPositiveVectorsOrBuilderList()
       Look for vectors closest to those
      repeated .qdrant.Vector positive_vectors = 18;

    • getPositiveVectorsOrBuilder

      Points.VectorOrBuilder getPositiveVectorsOrBuilder(int index)
       Look for vectors closest to those
      repeated .qdrant.Vector positive_vectors = 18;

    • getNegativeVectorsList

      List<Points.Vector> getNegativeVectorsList()
       Try to avoid vectors like this
      repeated .qdrant.Vector negative_vectors = 19;

    • getNegativeVectors

      Points.Vector getNegativeVectors(int index)
       Try to avoid vectors like this
      repeated .qdrant.Vector negative_vectors = 19;

    • getNegativeVectorsCount

      int getNegativeVectorsCount()
       Try to avoid vectors like this
      repeated .qdrant.Vector negative_vectors = 19;

    • getNegativeVectorsOrBuilderList

      List<? extends Points.VectorOrBuilder> getNegativeVectorsOrBuilderList()
       Try to avoid vectors like this
      repeated .qdrant.Vector negative_vectors = 19;

    • getNegativeVectorsOrBuilder

      Points.VectorOrBuilder getNegativeVectorsOrBuilder(int index)
       Try to avoid vectors like this
      repeated .qdrant.Vector negative_vectors = 19;