Package io.qdrant.client.grpc

Class Points.SearchPointGroups

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.qdrant.client.grpc.Points.SearchPointGroups
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Points.SearchPointGroupsOrBuilder, Serializable
Enclosing class:
Points
public static final class Points.SearchPointGroups extends com.google.protobuf.GeneratedMessageV3 implements Points.SearchPointGroupsOrBuilder
Protobuf type qdrant.SearchPointGroups
See Also:

  • Field Details

    • COLLECTION_NAME_FIELD_NUMBER

      public static final int COLLECTION_NAME_FIELD_NUMBER
      See Also:

    • VECTOR_FIELD_NUMBER

      public static final int VECTOR_FIELD_NUMBER
      See Also:

    • FILTER_FIELD_NUMBER

      public static final int FILTER_FIELD_NUMBER
      See Also:

    • LIMIT_FIELD_NUMBER

      public static final int LIMIT_FIELD_NUMBER
      See Also:

    • WITH_PAYLOAD_FIELD_NUMBER

      public static final int WITH_PAYLOAD_FIELD_NUMBER
      See Also:

    • PARAMS_FIELD_NUMBER

      public static final int PARAMS_FIELD_NUMBER
      See Also:

    • SCORE_THRESHOLD_FIELD_NUMBER

      public static final int SCORE_THRESHOLD_FIELD_NUMBER
      See Also:

    • VECTOR_NAME_FIELD_NUMBER

      public static final int VECTOR_NAME_FIELD_NUMBER
      See Also:

    • WITH_VECTORS_FIELD_NUMBER

      public static final int WITH_VECTORS_FIELD_NUMBER
      See Also:

    • GROUP_BY_FIELD_NUMBER

      public static final int GROUP_BY_FIELD_NUMBER
      See Also:

    • GROUP_SIZE_FIELD_NUMBER

      public static final int GROUP_SIZE_FIELD_NUMBER
      See Also:

    • READ_CONSISTENCY_FIELD_NUMBER

      public static final int READ_CONSISTENCY_FIELD_NUMBER
      See Also:

    • WITH_LOOKUP_FIELD_NUMBER

      public static final int WITH_LOOKUP_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getCollectionName

      public String getCollectionName()
       Name of the collection
      string collection_name = 1;
      Specified by:
      getCollectionName in interface Points.SearchPointGroupsOrBuilder
      Returns:
      The collectionName.

    • getCollectionNameBytes

      public com.google.protobuf.ByteString getCollectionNameBytes()
       Name of the collection
      string collection_name = 1;
      Specified by:
      getCollectionNameBytes in interface Points.SearchPointGroupsOrBuilder
      Returns:
      The bytes for collectionName.

    • getVectorList

      public List<Float> getVectorList()
       Vector to compare against
      repeated float vector = 2;
      Specified by:
      getVectorList in interface Points.SearchPointGroupsOrBuilder
      Returns:
      A list containing the vector.

    • getVectorCount

      public int getVectorCount()
       Vector to compare against
      repeated float vector = 2;
      Specified by:
      getVectorCount in interface Points.SearchPointGroupsOrBuilder
      Returns:
      The count of vector.

    • getVector

      public float getVector(int index)
       Vector to compare against
      repeated float vector = 2;
      Specified by:
      getVector in interface Points.SearchPointGroupsOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The vector at the given index.

    • hasFilter

      public boolean hasFilter()
       Filter conditions - return only those points that satisfy the specified conditions
      .qdrant.Filter filter = 3;
      Specified by:
      hasFilter in interface Points.SearchPointGroupsOrBuilder
      Returns:
      Whether the filter field is set.

    • getFilter

      public Points.Filter getFilter()
       Filter conditions - return only those points that satisfy the specified conditions
      .qdrant.Filter filter = 3;
      Specified by:
      getFilter in interface Points.SearchPointGroupsOrBuilder
      Returns:
      The filter.

    • getFilterOrBuilder

      public Points.FilterOrBuilder getFilterOrBuilder()
       Filter conditions - return only those points that satisfy the specified conditions
      .qdrant.Filter filter = 3;
      Specified by:
      getFilterOrBuilder in interface Points.SearchPointGroupsOrBuilder

    • getLimit

      public int getLimit()
       Max number of result
      uint32 limit = 4;
      Specified by:
      getLimit in interface Points.SearchPointGroupsOrBuilder
      Returns:
      The limit.

    • hasWithPayload

      public boolean hasWithPayload()
       Options for specifying which payload to include or not
      .qdrant.WithPayloadSelector with_payload = 5;
      Specified by:
      hasWithPayload in interface Points.SearchPointGroupsOrBuilder
      Returns:
      Whether the withPayload field is set.

    • getWithPayload

      public Points.WithPayloadSelector getWithPayload()
       Options for specifying which payload to include or not
      .qdrant.WithPayloadSelector with_payload = 5;
      Specified by:
      getWithPayload in interface Points.SearchPointGroupsOrBuilder
      Returns:
      The withPayload.

    • getWithPayloadOrBuilder

      public Points.WithPayloadSelectorOrBuilder getWithPayloadOrBuilder()
       Options for specifying which payload to include or not
      .qdrant.WithPayloadSelector with_payload = 5;
      Specified by:
      getWithPayloadOrBuilder in interface Points.SearchPointGroupsOrBuilder

    • hasParams

      public boolean hasParams()
       Search config
      .qdrant.SearchParams params = 6;
      Specified by:
      hasParams in interface Points.SearchPointGroupsOrBuilder
      Returns:
      Whether the params field is set.

    • getParams

      public Points.SearchParams getParams()
       Search config
      .qdrant.SearchParams params = 6;
      Specified by:
      getParams in interface Points.SearchPointGroupsOrBuilder
      Returns:
      The params.

    • getParamsOrBuilder

      public Points.SearchParamsOrBuilder getParamsOrBuilder()
       Search config
      .qdrant.SearchParams params = 6;
      Specified by:
      getParamsOrBuilder in interface Points.SearchPointGroupsOrBuilder

    • hasScoreThreshold

      public boolean hasScoreThreshold()
       If provided - cut off results with worse scores
      optional float score_threshold = 7;
      Specified by:
      hasScoreThreshold in interface Points.SearchPointGroupsOrBuilder
      Returns:
      Whether the scoreThreshold field is set.

    • getScoreThreshold

      public float getScoreThreshold()
       If provided - cut off results with worse scores
      optional float score_threshold = 7;
      Specified by:
      getScoreThreshold in interface Points.SearchPointGroupsOrBuilder
      Returns:
      The scoreThreshold.

    • hasVectorName

      public boolean hasVectorName()
       Which vector to use for search, if not specified - use default vector
      optional string vector_name = 8;
      Specified by:
      hasVectorName in interface Points.SearchPointGroupsOrBuilder
      Returns:
      Whether the vectorName field is set.

    • getVectorName

      public String getVectorName()
       Which vector to use for search, if not specified - use default vector
      optional string vector_name = 8;
      Specified by:
      getVectorName in interface Points.SearchPointGroupsOrBuilder
      Returns:
      The vectorName.

    • getVectorNameBytes

      public com.google.protobuf.ByteString getVectorNameBytes()
       Which vector to use for search, if not specified - use default vector
      optional string vector_name = 8;
      Specified by:
      getVectorNameBytes in interface Points.SearchPointGroupsOrBuilder
      Returns:
      The bytes for vectorName.

    • hasWithVectors

      public boolean hasWithVectors()
       Options for specifying which vectors to include into response
      optional .qdrant.WithVectorsSelector with_vectors = 9;
      Specified by:
      hasWithVectors in interface Points.SearchPointGroupsOrBuilder
      Returns:
      Whether the withVectors field is set.

    • getWithVectors

      public Points.WithVectorsSelector getWithVectors()
       Options for specifying which vectors to include into response
      optional .qdrant.WithVectorsSelector with_vectors = 9;
      Specified by:
      getWithVectors in interface Points.SearchPointGroupsOrBuilder
      Returns:
      The withVectors.

    • getWithVectorsOrBuilder

      public Points.WithVectorsSelectorOrBuilder getWithVectorsOrBuilder()
       Options for specifying which vectors to include into response
      optional .qdrant.WithVectorsSelector with_vectors = 9;
      Specified by:
      getWithVectorsOrBuilder in interface Points.SearchPointGroupsOrBuilder

    • getGroupBy

      public 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;
      Specified by:
      getGroupBy in interface Points.SearchPointGroupsOrBuilder
      Returns:
      The groupBy.

    • getGroupByBytes

      public 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;
      Specified by:
      getGroupByBytes in interface Points.SearchPointGroupsOrBuilder
      Returns:
      The bytes for groupBy.

    • getGroupSize

      public int getGroupSize()
       Maximum amount of points to return per group
      uint32 group_size = 11;
      Specified by:
      getGroupSize in interface Points.SearchPointGroupsOrBuilder
      Returns:
      The groupSize.

    • hasReadConsistency

      public boolean hasReadConsistency()
       Options for specifying read consistency guarantees
      optional .qdrant.ReadConsistency read_consistency = 12;
      Specified by:
      hasReadConsistency in interface Points.SearchPointGroupsOrBuilder
      Returns:
      Whether the readConsistency field is set.

    • getReadConsistency

      public Points.ReadConsistency getReadConsistency()
       Options for specifying read consistency guarantees
      optional .qdrant.ReadConsistency read_consistency = 12;
      Specified by:
      getReadConsistency in interface Points.SearchPointGroupsOrBuilder
      Returns:
      The readConsistency.

    • getReadConsistencyOrBuilder

      public Points.ReadConsistencyOrBuilder getReadConsistencyOrBuilder()
       Options for specifying read consistency guarantees
      optional .qdrant.ReadConsistency read_consistency = 12;
      Specified by:
      getReadConsistencyOrBuilder in interface Points.SearchPointGroupsOrBuilder

    • hasWithLookup

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

    • getWithLookup

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

    • getWithLookupOrBuilder

      public Points.WithLookupOrBuilder getWithLookupOrBuilder()
       Options for specifying how to use the group id to lookup points in another collection
      optional .qdrant.WithLookup with_lookup = 13;
      Specified by:
      getWithLookupOrBuilder in interface Points.SearchPointGroupsOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Points.SearchPointGroups parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Points.SearchPointGroups parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Points.SearchPointGroups parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Points.SearchPointGroups parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Points.SearchPointGroups parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Points.SearchPointGroups parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Points.SearchPointGroups parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Points.SearchPointGroups parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Points.SearchPointGroups parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Points.SearchPointGroups parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Points.SearchPointGroups parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Points.SearchPointGroups parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Points.SearchPointGroups.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Points.SearchPointGroups.Builder newBuilder()

    • newBuilder

      public static Points.SearchPointGroups.Builder newBuilder(Points.SearchPointGroups prototype)

    • toBuilder

      public Points.SearchPointGroups.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Points.SearchPointGroups.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Points.SearchPointGroups getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Points.SearchPointGroups> parser()

    • getParserForType

      public com.google.protobuf.Parser<Points.SearchPointGroups> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Points.SearchPointGroups getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder