class
Qdrant::Api::SearchParams
- Qdrant::Api::SearchParams
- Reference
- Object
Overview
Additional parameters of the search
Included Modules
- JSON::Serializable
- Qdrant::Api::Serializable
- Qdrant::Api::Validation
- YAML::Serializable
Defined in:
qdrant-api/models/search_params.crConstructors
- .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
- .new(pull : JSON::PullParser)
-
.new(hnsw_ef : Int32 | Nil = nil, exact : Bool | Nil = false, quantization : QuantizationSearchParams | Nil = nil, indexed_only : Bool | Nil = false, acorn : AcornSearchParams | Nil = nil)
Initializes the object @param [Hash] attributes Model attributes in the form of hash
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
- .new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#acorn : AcornSearchParams | Nil
ACORN search params
-
#acorn=(acorn : AcornSearchParams | Nil)
ACORN search params
-
#exact : Bool | Nil
Search without approximation.
-
#exact=(exact : Bool | Nil)
Search without approximation.
-
#hash(hasher)
See
Object#hash(hasher) -
#hnsw_ef : Int32 | Nil
Optional properties Params relevant to HNSW index Size of the beam in a beam-search.
-
#hnsw_ef=(value : Int32 | Nil)
Optional properties Params relevant to HNSW index Size of the beam in a beam-search.
- #hnsw_ef_validation_error(value) : String | Nil
-
#indexed_only : Bool | Nil
If enabled, the engine will only perform search among indexed or small segments.
-
#indexed_only=(indexed_only : Bool | Nil)
If enabled, the engine will only perform search among indexed or small segments.
-
#list_invalid_properties
Show invalid properties with the reasons.
-
#quantization : QuantizationSearchParams | Nil
Quantization params
-
#quantization=(quantization : QuantizationSearchParams | Nil)
Quantization params
-
#valid?
Check to see if the all the properties in the model are valid @return true if the model is valid
Macros inherited from module Qdrant::Api::Validation
validates(name, klass, nilable, **rules)
validates
Instance methods inherited from module Qdrant::Api::Serializable
eql?(other)
eql?,
to_body : Hash(String, JSON::Any)
to_body,
to_h : Hash(String, JSON::Any)
to_h,
to_s(io : IO) : Nil
to_s
Constructor Detail
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
Search without approximation. If set to true, search may run long but with exact results.
Search without approximation. If set to true, search may run long but with exact results.
Optional properties 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 properties 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.
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
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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Check to see if the all the properties in the model are valid @return true if the model is valid