Package io.qdrant.client.grpc

Class Points.SearchParams

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Points.SearchParams.Builder
    Protobuf type qdrant.SearchParams

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    EXACT_FIELD_NUMBER
     
    static final int
    HNSW_EF_FIELD_NUMBER
     
    static final int
    INDEXED_ONLY_FIELD_NUMBER
     
    static final int
    QUANTIZATION_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Points.SearchParams
    getDefaultInstance()
     
    Points.SearchParams
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getExact()
    Search without approximation.
    long
    getHnswEf()
    Params relevant to HNSW index.
    boolean
    getIndexedOnly()
    If enabled, the engine will only perform search among indexed or small segments.
    com.google.protobuf.Parser<Points.SearchParams>
    getParserForType()
     
    Points.QuantizationSearchParams
    getQuantization()
    If set to true, search will ignore quantized vector data
    Points.QuantizationSearchParamsOrBuilder
    getQuantizationOrBuilder()
    If set to true, search will ignore quantized vector data
    int
    getSerializedSize()
     
    boolean
    hasExact()
    Search without approximation.
    int
    hashCode()
     
    boolean
    hasHnswEf()
    Params relevant to HNSW index.
    boolean
    hasIndexedOnly()
    If enabled, the engine will only perform search among indexed or small segments.
    boolean
    hasQuantization()
    If set to true, search will ignore quantized vector data
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Points.SearchParams.Builder
    newBuilder()
     
    static Points.SearchParams.Builder
    newBuilder(Points.SearchParams prototype)
     
    Points.SearchParams.Builder
    newBuilderForType()
     
    protected Points.SearchParams.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Points.SearchParams
    parseDelimitedFrom(InputStream input)
     
    static Points.SearchParams
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Points.SearchParams
    parseFrom(byte[] data)
     
    static Points.SearchParams
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Points.SearchParams
    parseFrom(com.google.protobuf.ByteString data)
     
    static Points.SearchParams
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Points.SearchParams
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Points.SearchParams
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Points.SearchParams
    parseFrom(InputStream input)
     
    static Points.SearchParams
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Points.SearchParams
    parseFrom(ByteBuffer data)
     
    static Points.SearchParams
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Points.SearchParams>
    parser()
     
    Points.SearchParams.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • 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

    • hasHnswEf

      public boolean hasHnswEf()
      
Params relevant to HNSW index. Size of the beam in a beam-search.
Larger the value - more accurate the result, more time required for search.
      optional uint64 hnsw_ef = 1;
      Specified by:
      hasHnswEf in interface Points.SearchParamsOrBuilder
      Returns:
      Whether the hnswEf field is set.

    • getHnswEf

      public long getHnswEf()
      
Params relevant to HNSW index. Size of the beam in a beam-search.
Larger the value - more accurate the result, more time required for search.
      optional uint64 hnsw_ef = 1;
      Specified by:
      getHnswEf in interface Points.SearchParamsOrBuilder
      Returns:
      The hnswEf.

    • hasExact

      public boolean hasExact()
      
Search without approximation. If set to true, search may run long but with exact results.
      optional bool exact = 2;
      Specified by:
      hasExact in interface Points.SearchParamsOrBuilder
      Returns:
      Whether the exact field is set.

    • getExact

      public boolean getExact()
      
Search without approximation. If set to true, search may run long but with exact results.
      optional bool exact = 2;
      Specified by:
      getExact in interface Points.SearchParamsOrBuilder
      Returns:
      The exact.

    • hasQuantization

      public boolean hasQuantization()
      
If set to true, search will ignore quantized vector data
      optional .qdrant.QuantizationSearchParams quantization = 3;
      Specified by:
      hasQuantization in interface Points.SearchParamsOrBuilder
      Returns:
      Whether the quantization field is set.

    • getQuantization

      public Points.QuantizationSearchParams getQuantization()
      
If set to true, search will ignore quantized vector data
      optional .qdrant.QuantizationSearchParams quantization = 3;
      Specified by:
      getQuantization in interface Points.SearchParamsOrBuilder
      Returns:
      The quantization.

    • getQuantizationOrBuilder

      public Points.QuantizationSearchParamsOrBuilder getQuantizationOrBuilder()
      
If set to true, search will ignore quantized vector data
      optional .qdrant.QuantizationSearchParams quantization = 3;
      Specified by:
      getQuantizationOrBuilder in interface Points.SearchParamsOrBuilder

    • hasIndexedOnly

      public boolean hasIndexedOnly()
      
If enabled, the engine will only perform search among indexed or small segments.
Using this option prevents slow searches in case of delayed index, but does not
guarantee that all uploaded vectors will be included in search results
      optional bool indexed_only = 4;
      Specified by:
      hasIndexedOnly in interface Points.SearchParamsOrBuilder
      Returns:
      Whether the indexedOnly field is set.

    • getIndexedOnly

      public boolean getIndexedOnly()
      
If enabled, the engine will only perform search among indexed or small segments.
Using this option prevents slow searches in case of delayed index, but does not
guarantee that all uploaded vectors will be included in search results
      optional bool indexed_only = 4;
      Specified by:
      getIndexedOnly in interface Points.SearchParamsOrBuilder
      Returns:
      The indexedOnly.

    • 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.SearchParams parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Points.SearchParams 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.SearchParams parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Points.SearchParams.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Points.SearchParams getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Points.SearchParams> 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.SearchParams getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder