Package io.qdrant.client.grpc
Interface Points.SearchPointGroupsOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Points.SearchPointGroups
,Points.SearchPointGroups.Builder
- Enclosing class:
- Points
public static interface Points.SearchPointGroupsOrBuilder
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 conditionsPayload field to group by, must be a string or number field.com.google.protobuf.ByteString
Payload field to group by, must be a string or number field.int
Maximum amount of points to return per groupint
getLimit()
Max number of resultSearch configSearch configOptions for specifying read consistency guaranteesOptions for specifying read consistency guaranteesfloat
If provided - cut off results with worse scoresfloat
getVector
(int index) Vector to compare againstint
Vector to compare againstVector to compare againstWhich vector to use for search, if not specified - use default vectorcom.google.protobuf.ByteString
Which vector to use for search, if not specified - use default vectorOptions for specifying how to use the group id to lookup points in another collectionOptions for specifying how to use the group id to lookup points in another collectionOptions 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
Search configboolean
Options for specifying read consistency guaranteesboolean
If provided - cut off results with worse scoresboolean
Which vector to use for search, if not specified - use default vectorboolean
Options for specifying how to use the group id to lookup points in another collectionboolean
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.
-
getVectorList
Vector to compare against
repeated float vector = 2;
- Returns:
- A list containing the vector.
-
getVectorCount
int getVectorCount()Vector to compare against
repeated float vector = 2;
- Returns:
- The count of vector.
-
getVector
float getVector(int index) Vector to compare against
repeated float vector = 2;
- Parameters:
index
- The index of the element to return.- Returns:
- The vector at the given index.
-
hasFilter
boolean hasFilter()Filter conditions - return only those points that satisfy the specified conditions
.qdrant.Filter filter = 3;
- 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 = 3;
- Returns:
- The filter.
-
getFilterOrBuilder
Points.FilterOrBuilder getFilterOrBuilder()Filter conditions - return only those points that satisfy the specified conditions
.qdrant.Filter filter = 3;
-
getLimit
int getLimit()Max number of result
uint32 limit = 4;
- Returns:
- The limit.
-
hasWithPayload
boolean hasWithPayload()Options for specifying which payload to include or not
.qdrant.WithPayloadSelector with_payload = 5;
- Returns:
- Whether the withPayload field is set.
-
getWithPayload
Points.WithPayloadSelector getWithPayload()Options for specifying which payload to include or not
.qdrant.WithPayloadSelector with_payload = 5;
- Returns:
- The withPayload.
-
getWithPayloadOrBuilder
Points.WithPayloadSelectorOrBuilder getWithPayloadOrBuilder()Options for specifying which payload to include or not
.qdrant.WithPayloadSelector with_payload = 5;
-
hasParams
boolean hasParams()Search config
.qdrant.SearchParams params = 6;
- Returns:
- Whether the params field is set.
-
getParams
Points.SearchParams getParams()Search config
.qdrant.SearchParams params = 6;
- Returns:
- The params.
-
getParamsOrBuilder
Points.SearchParamsOrBuilder getParamsOrBuilder()Search config
.qdrant.SearchParams params = 6;
-
hasScoreThreshold
boolean hasScoreThreshold()If provided - cut off results with worse scores
optional float score_threshold = 7;
- Returns:
- Whether the scoreThreshold field is set.
-
getScoreThreshold
float getScoreThreshold()If provided - cut off results with worse scores
optional float score_threshold = 7;
- Returns:
- The scoreThreshold.
-
hasVectorName
boolean hasVectorName()Which vector to use for search, if not specified - use default vector
optional string vector_name = 8;
- Returns:
- Whether the vectorName field is set.
-
getVectorName
String getVectorName()Which vector to use for search, if not specified - use default vector
optional string vector_name = 8;
- Returns:
- The vectorName.
-
getVectorNameBytes
com.google.protobuf.ByteString getVectorNameBytes()Which vector to use for search, if not specified - use default vector
optional string vector_name = 8;
- Returns:
- The bytes for vectorName.
-
hasWithVectors
boolean hasWithVectors()Options for specifying which vectors to include into response
optional .qdrant.WithVectorsSelector with_vectors = 9;
- 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 = 9;
- Returns:
- The withVectors.
-
getWithVectorsOrBuilder
Points.WithVectorsSelectorOrBuilder getWithVectorsOrBuilder()Options for specifying which vectors to include into response
optional .qdrant.WithVectorsSelector with_vectors = 9;
-
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 = 10;
- 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 = 10;
- Returns:
- The bytes for groupBy.
-
getGroupSize
int getGroupSize()Maximum amount of points to return per group
uint32 group_size = 11;
- Returns:
- The groupSize.
-
hasReadConsistency
boolean hasReadConsistency()Options for specifying read consistency guarantees
optional .qdrant.ReadConsistency read_consistency = 12;
- Returns:
- Whether the readConsistency field is set.
-
getReadConsistency
Points.ReadConsistency getReadConsistency()Options for specifying read consistency guarantees
optional .qdrant.ReadConsistency read_consistency = 12;
- Returns:
- The readConsistency.
-
getReadConsistencyOrBuilder
Points.ReadConsistencyOrBuilder getReadConsistencyOrBuilder()Options for specifying read consistency guarantees
optional .qdrant.ReadConsistency read_consistency = 12;
-
hasWithLookup
boolean hasWithLookup()Options for specifying how to use the group id to lookup points in another collection
optional .qdrant.WithLookup with_lookup = 13;
- 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 = 13;
- 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 = 13;
-