class Qdrant::Api::StrictModeConfig

Included Modules

Defined in:

qdrant-api/models/strict_mode_config.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(enabled : Bool | Nil = nil, max_query_limit : Int32 | Nil = nil, max_timeout : Int32 | Nil = nil, unindexed_filtering_retrieve : Bool | Nil = nil, unindexed_filtering_update : Bool | Nil = nil, search_max_hnsw_ef : Int32 | Nil = nil, search_allow_exact : Bool | Nil = nil, search_max_oversampling : Float64 | Nil = nil, upsert_max_batchsize : Int32 | Nil = nil, search_max_batchsize : Int32 | Nil = nil, max_collection_vector_size_bytes : Int32 | Nil = nil, read_rate_limit : Int32 | Nil = nil, write_rate_limit : Int32 | Nil = nil, max_collection_payload_size_bytes : Int32 | Nil = nil, max_points_count : Int32 | Nil = nil, filter_max_conditions : Int32 | Nil = nil, condition_max_size : Int32 | Nil = nil, multivector_config : Hash(String, StrictModeMultivector) | Nil = nil, sparse_config : Hash(String, StrictModeSparse) | Nil = nil, max_payload_index_count : Int32 | Nil = nil, max_resident_memory_percent : Int32 | Nil = nil, max_disk_usage_percent : Int32 | 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 condition_max_size : Int32 | Nil #

Max size of a condition, eg. items in MatchAny.


[View source]
def condition_max_size=(value : Int32 | Nil) #

Max size of a condition, eg. items in MatchAny.


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

[View source]
def enabled : Bool | Nil #

Optional properties Whether strict mode is enabled for a collection or not.


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

Optional properties Whether strict mode is enabled for a collection or not.


[View source]
def filter_max_conditions : Int32 | Nil #

Max conditions a filter can have.


[View source]
def filter_max_conditions=(value : Int32 | Nil) #

Max conditions a filter can have.


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

[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_collection_payload_size_bytes : Int32 | Nil #

Max size of a collections payload storage in bytes


[View source]
def max_collection_payload_size_bytes=(value : Int32 | Nil) #

Max size of a collections payload storage in bytes


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

[View source]
def max_collection_vector_size_bytes : Int32 | Nil #

Max size of a collections vector storage in bytes, ignoring replicas.


[View source]
def max_collection_vector_size_bytes=(value : Int32 | Nil) #

Max size of a collections vector storage in bytes, ignoring replicas.


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

[View source]
def max_disk_usage_percent : Int32 | Nil #

Reject disk-consuming update operations (e.g. upsert, set payload) when the filesystem hosting Qdrant storage is filled above this percentage of its total capacity. Value in [1, 100]. Applied uniformly to external and internal (replication) traffic — rejection is deterministic so it does not cause replica divergence. Delete operations are not affected, so callers can still free disk space. Free space is sampled with a small TTL cache; the gate may take a few seconds to react.


[View source]
def max_disk_usage_percent=(value : Int32 | Nil) #

Reject disk-consuming update operations (e.g. upsert, set payload) when the filesystem hosting Qdrant storage is filled above this percentage of its total capacity. Value in [1, 100]. Applied uniformly to external and internal (replication) traffic — rejection is deterministic so it does not cause replica divergence. Delete operations are not affected, so callers can still free disk space. Free space is sampled with a small TTL cache; the gate may take a few seconds to react.


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

[View source]
def max_payload_index_count : Int32 | Nil #

Max number of payload indexes in a collection


[View source]
def max_payload_index_count=(value : Int32 | Nil) #

Max number of payload indexes in a collection


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

[View source]
def max_points_count : Int32 | Nil #

Max number of points estimated in a collection


[View source]
def max_points_count=(value : Int32 | Nil) #

Max number of points estimated in a collection


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

[View source]
def max_query_limit : Int32 | Nil #

Max allowed limit parameter for all APIs that don't have their own max limit.


[View source]
def max_query_limit=(value : Int32 | Nil) #

Max allowed limit parameter for all APIs that don't have their own max limit.


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

[View source]
def max_resident_memory_percent : Int32 | Nil #

Reject memory-consuming update operations (e.g. upsert, set payload) when the process resident memory exceeds this percentage of total system memory (or cgroup limit). Value in [1, 100]. Applied uniformly to external and internal (replication) traffic — rejection is deterministic so it does not cause replica divergence. Delete operations are not affected, so callers can still free memory.


[View source]
def max_resident_memory_percent=(value : Int32 | Nil) #

Reject memory-consuming update operations (e.g. upsert, set payload) when the process resident memory exceeds this percentage of total system memory (or cgroup limit). Value in [1, 100]. Applied uniformly to external and internal (replication) traffic — rejection is deterministic so it does not cause replica divergence. Delete operations are not affected, so callers can still free memory.


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

[View source]
def max_timeout : Int32 | Nil #

Max allowed timeout parameter.


[View source]
def max_timeout=(value : Int32 | Nil) #

Max allowed timeout parameter.


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

[View source]
def multivector_config : Hash(String, StrictModeMultivector) | Nil #

Multivector strict mode configuration


[View source]
def multivector_config=(multivector_config : Hash(String, StrictModeMultivector) | Nil) #

Multivector strict mode configuration


[View source]
def read_rate_limit : Int32 | Nil #

Max number of read operations per minute per replica


[View source]
def read_rate_limit=(value : Int32 | Nil) #

Max number of read operations per minute per replica


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

[View source]
def search_allow_exact : Bool | Nil #

Whether exact search is allowed.


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

Whether exact search is allowed.


[View source]
def search_max_batchsize : Int32 | Nil #

Max batchsize when searching


[View source]
def search_max_batchsize=(value : Int32 | Nil) #

Max batchsize when searching


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

[View source]
def search_max_hnsw_ef : Int32 | Nil #

Max HNSW ef value allowed in search parameters.


[View source]
def search_max_hnsw_ef=(value : Int32 | Nil) #

Max HNSW ef value allowed in search parameters.


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

[View source]
def search_max_oversampling : Float64 | Nil #

Max oversampling value allowed in search.


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

Max oversampling value allowed in search.


[View source]
def sparse_config : Hash(String, StrictModeSparse) | Nil #

Sparse vector strict mode configuration


[View source]
def sparse_config=(sparse_config : Hash(String, StrictModeSparse) | Nil) #

Sparse vector strict mode configuration


[View source]
def unindexed_filtering_retrieve : Bool | Nil #

Allow usage of unindexed fields in retrieval based (e.g. search) filters.


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

Allow usage of unindexed fields in retrieval based (e.g. search) filters.


[View source]
def unindexed_filtering_update : Bool | Nil #

Allow usage of unindexed fields in filtered updates (e.g. delete by payload).


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

Allow usage of unindexed fields in filtered updates (e.g. delete by payload).


[View source]
def upsert_max_batchsize : Int32 | Nil #

Max batchsize when upserting


[View source]
def upsert_max_batchsize=(value : Int32 | Nil) #

Max batchsize when upserting


[View source]
def upsert_max_batchsize_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]
def write_rate_limit : Int32 | Nil #

Max number of write operations per minute per replica


[View source]
def write_rate_limit=(value : Int32 | Nil) #

Max number of write operations per minute per replica


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

[View source]