class Qdrant::Api::AcornSearchParams

Overview

ACORN-related search parameters

Included Modules

Defined in:

qdrant-api/models/acorn_search_params.cr

Constructors

Instance Method Summary

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

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(enable : Bool | Nil = false, max_selectivity : Float64 | Nil = nil) #

Initializes the object @param [Hash] attributes Model attributes in the form of hash


[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]
def self.new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def enable : Bool | Nil #

Optional properties If true, then ACORN may be used for the HNSW search based on filters selectivity. Improves search recall for searches with multiple low-selectivity payload filters, at cost of performance.


[View source]
def enable=(enable : Bool | Nil) #

Optional properties If true, then ACORN may be used for the HNSW search based on filters selectivity. Improves search recall for searches with multiple low-selectivity payload filters, at cost of performance.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def list_invalid_properties #

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons


[View source]
def max_selectivity : Float64 | Nil #

Maximum selectivity of filters to enable ACORN. If estimated filters selectivity is higher than this value, ACORN will not be used. Selectivity is estimated as: estimated number of points satisfying the filters / total number of points. 0.0 for never, 1.0 for always. Default is 0.4.


[View source]
def max_selectivity=(value : Float64 | Nil) #

Maximum selectivity of filters to enable ACORN. If estimated filters selectivity is higher than this value, ACORN will not be used. Selectivity is estimated as: estimated number of points satisfying the filters / total number of points. 0.0 for never, 1.0 for always. Default is 0.4.


[View source]
def max_selectivity_validation_error(value) : String | Nil #

[View source]
def valid? #

Check to see if the all the properties in the model are valid @return true if the model is valid


[View source]