Package io.qdrant.client.grpc
Interface Points.RecommendPointsOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Points.RecommendPoints
,Points.RecommendPoints.Builder
- Enclosing class:
- Points
public static interface Points.RecommendPointsOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionname of the collectioncom.google.protobuf.ByteString
name of the collectionFilter conditions - return only those points that satisfy the specified conditionsFilter conditions - return only those points that satisfy the specified conditionslong
getLimit()
Max number of resultName of the collection to use for points lookup, if not specified - use current collectionName of the collection to use for points lookup, if not specified - use current collectiongetNegative
(int index) Try to avoid vectors like the vector from these pointsint
Try to avoid vectors like the vector from these pointsTry to avoid vectors like the vector from these pointsgetNegativeOrBuilder
(int index) Try to avoid vectors like the vector from these pointsList<? extends Points.PointIdOrBuilder>
Try to avoid vectors like the vector from these pointsgetNegativeVectors
(int index) Try to avoid vectors like thisint
Try to avoid vectors like thisTry to avoid vectors like thisgetNegativeVectorsOrBuilder
(int index) Try to avoid vectors like thisList<? extends Points.VectorOrBuilder>
Try to avoid vectors like thislong
Offset of the resultSearch configSearch configgetPositive
(int index) Look for vectors closest to the vectors from these pointsint
Look for vectors closest to the vectors from these pointsLook for vectors closest to the vectors from these pointsgetPositiveOrBuilder
(int index) Look for vectors closest to the vectors from these pointsList<? extends Points.PointIdOrBuilder>
Look for vectors closest to the vectors from these pointsgetPositiveVectors
(int index) Look for vectors closest to thoseint
Look for vectors closest to thoseLook for vectors closest to thosegetPositiveVectorsOrBuilder
(int index) Look for vectors closest to thoseList<? extends Points.VectorOrBuilder>
Look for vectors closest to thoseOptions for specifying read consistency guaranteesOptions for specifying read consistency guaranteesfloat
If provided - cut off results with worse scoresHow to use the example vectors to find the resultsint
How to use the example vectors to find the resultsgetUsing()
Define which vector to use for recommendation, if not specified - default vectorcom.google.protobuf.ByteString
Define which vector to use for recommendation, if not specified - default vectorOptions for specifying which payload to include or notOptions for specifying which payload to include or notOptions for specifying which vectors to include into responseOptions for specifying which vectors to include into responseboolean
Filter conditions - return only those points that satisfy the specified conditionsboolean
Name of the collection to use for points lookup, if not specified - use current collectionboolean
Offset of the resultboolean
Search configboolean
Options for specifying read consistency guaranteesboolean
If provided - cut off results with worse scoresboolean
How to use the example vectors to find the resultsboolean
hasUsing()
Define which vector to use for recommendation, if not specified - default vectorboolean
Options for specifying which payload to include or notboolean
Options for specifying which vectors to include into responseMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
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
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
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
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
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
long getLimit()Max number of result
uint64 limit = 5;
- Returns:
- The limit.
-
hasWithPayload
boolean hasWithPayload()Options for specifying which payload to include or not
.qdrant.WithPayloadSelector with_payload = 7;
- Returns:
- Whether the withPayload field is set.
-
getWithPayload
Points.WithPayloadSelector getWithPayload()Options for specifying which payload to include or not
.qdrant.WithPayloadSelector with_payload = 7;
- Returns:
- The withPayload.
-
getWithPayloadOrBuilder
Points.WithPayloadSelectorOrBuilder getWithPayloadOrBuilder()Options for specifying which payload to include or not
.qdrant.WithPayloadSelector with_payload = 7;
-
hasParams
boolean hasParams()Search config
.qdrant.SearchParams params = 8;
- Returns:
- Whether the params field is set.
-
getParams
Points.SearchParams getParams()Search config
.qdrant.SearchParams params = 8;
- Returns:
- The params.
-
getParamsOrBuilder
Points.SearchParamsOrBuilder getParamsOrBuilder()Search config
.qdrant.SearchParams params = 8;
-
hasScoreThreshold
boolean hasScoreThreshold()If provided - cut off results with worse scores
optional float score_threshold = 9;
- Returns:
- Whether the scoreThreshold field is set.
-
getScoreThreshold
float getScoreThreshold()If provided - cut off results with worse scores
optional float score_threshold = 9;
- Returns:
- The scoreThreshold.
-
hasOffset
boolean hasOffset()Offset of the result
optional uint64 offset = 10;
- Returns:
- Whether the offset field is set.
-
getOffset
long getOffset()Offset of the result
optional uint64 offset = 10;
- Returns:
- The offset.
-
hasUsing
boolean hasUsing()Define which vector to use for recommendation, if not specified - default vector
optional string using = 11;
- 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 = 11;
- Returns:
- The using.
-
getUsingBytes
com.google.protobuf.ByteString getUsingBytes()Define which vector to use for recommendation, if not specified - default vector
optional string using = 11;
- Returns:
- The bytes for using.
-
hasWithVectors
boolean hasWithVectors()Options for specifying which vectors to include into response
optional .qdrant.WithVectorsSelector with_vectors = 12;
- 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 = 12;
- Returns:
- The withVectors.
-
getWithVectorsOrBuilder
Points.WithVectorsSelectorOrBuilder getWithVectorsOrBuilder()Options for specifying which vectors to include into response
optional .qdrant.WithVectorsSelector with_vectors = 12;
-
hasLookupFrom
boolean hasLookupFrom()Name of the collection to use for points lookup, if not specified - use current collection
optional .qdrant.LookupLocation lookup_from = 13;
- 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 = 13;
- 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 = 13;
-
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;
-
hasStrategy
boolean hasStrategy()How to use the example vectors to find the results
optional .qdrant.RecommendStrategy strategy = 16;
- Returns:
- Whether the strategy field is set.
-
getStrategyValue
int getStrategyValue()How to use the example vectors to find the results
optional .qdrant.RecommendStrategy strategy = 16;
- 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 = 16;
- Returns:
- The strategy.
-
getPositiveVectorsList
List<Points.Vector> getPositiveVectorsList()Look for vectors closest to those
repeated .qdrant.Vector positive_vectors = 17;
-
getPositiveVectors
Look for vectors closest to those
repeated .qdrant.Vector positive_vectors = 17;
-
getPositiveVectorsCount
int getPositiveVectorsCount()Look for vectors closest to those
repeated .qdrant.Vector positive_vectors = 17;
-
getPositiveVectorsOrBuilderList
List<? extends Points.VectorOrBuilder> getPositiveVectorsOrBuilderList()Look for vectors closest to those
repeated .qdrant.Vector positive_vectors = 17;
-
getPositiveVectorsOrBuilder
Look for vectors closest to those
repeated .qdrant.Vector positive_vectors = 17;
-
getNegativeVectorsList
List<Points.Vector> getNegativeVectorsList()Try to avoid vectors like this
repeated .qdrant.Vector negative_vectors = 18;
-
getNegativeVectors
Try to avoid vectors like this
repeated .qdrant.Vector negative_vectors = 18;
-
getNegativeVectorsCount
int getNegativeVectorsCount()Try to avoid vectors like this
repeated .qdrant.Vector negative_vectors = 18;
-
getNegativeVectorsOrBuilderList
List<? extends Points.VectorOrBuilder> getNegativeVectorsOrBuilderList()Try to avoid vectors like this
repeated .qdrant.Vector negative_vectors = 18;
-
getNegativeVectorsOrBuilder
Try to avoid vectors like this
repeated .qdrant.Vector negative_vectors = 18;
-