class
Qdrant::Api::UpdateCollection
- Qdrant::Api::UpdateCollection
- Reference
- Object
Overview
Operation for updating parameters of the existing collection
Included Modules
- JSON::Serializable
- Qdrant::Api::Serializable
- Qdrant::Api::Validation
- YAML::Serializable
Defined in:
qdrant-api/models/update_collection.crConstructors
- .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
- .new(pull : JSON::PullParser)
-
.new(vectors : Hash(String, VectorParamsDiff) | Nil = nil, optimizers_config : OptimizersConfigDiff | Nil = nil, params : CollectionParamsDiff | Nil = nil, hnsw_config : HnswConfigDiff | Nil = nil, quantization_config : QuantizationConfigDiff | Nil = nil, sparse_vectors : Hash(String, SparseVectorParams) | Nil = nil, strict_mode_config : StrictModeConfig | Nil = nil, metadata : Hash(String, JSON::Any) | 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. -
#hash(hasher)
See
Object#hash(hasher) -
#hnsw_config : HnswConfigDiff | Nil
HNSW parameters to update for the collection index.
-
#hnsw_config=(hnsw_config : HnswConfigDiff | Nil)
HNSW parameters to update for the collection index.
-
#list_invalid_properties
Show invalid properties with the reasons.
-
#metadata : Hash(String, JSON::Any) | Nil
Metadata to update for the collection.
-
#metadata=(metadata : Hash(String, JSON::Any) | Nil)
Metadata to update for the collection.
-
#optimizers_config : OptimizersConfigDiff | Nil
Custom params for Optimizers.
-
#optimizers_config=(optimizers_config : OptimizersConfigDiff | Nil)
Custom params for Optimizers.
-
#params : CollectionParamsDiff | Nil
Collection base params.
-
#params=(params : CollectionParamsDiff | Nil)
Collection base params.
-
#quantization_config : QuantizationConfigDiff | Nil
Quantization parameters to update.
-
#quantization_config=(quantization_config : QuantizationConfigDiff | Nil)
Quantization parameters to update.
-
#sparse_vectors : Hash(String, SparseVectorParams) | Nil
Map of sparse vector data parameters to update for each sparse vector.
-
#sparse_vectors=(sparse_vectors : Hash(String, SparseVectorParams) | Nil)
Map of sparse vector data parameters to update for each sparse vector.
- #strict_mode_config : StrictModeConfig | Nil
- #strict_mode_config=(strict_mode_config : StrictModeConfig | Nil)
-
#valid?
Check to see if the all the properties in the model are valid @return true if the model is valid
-
#vectors : Hash(String, VectorParamsDiff) | Nil
Optional properties Map of vector data parameters to update for each named vector.
-
#vectors=(vectors : Hash(String, VectorParamsDiff) | Nil)
Optional properties Map of vector data parameters to update for each named vector.
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?.
HNSW parameters to update for the collection index. If none - it is left unchanged.
HNSW parameters to update for the collection index. If none - it is left unchanged.
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Metadata to update for the collection. If provided, this will merge with existing metadata. To remove metadata, set it to an empty object.
Metadata to update for the collection. If provided, this will merge with existing metadata. To remove metadata, set it to an empty object.
Custom params for Optimizers. If none - it is left unchanged. This operation is blocking, it will only proceed once all current optimizations are complete
Custom params for Optimizers. If none - it is left unchanged. This operation is blocking, it will only proceed once all current optimizations are complete
Collection base params. If none - it is left unchanged.
Quantization parameters to update. If none - it is left unchanged.
Quantization parameters to update. If none - it is left unchanged.
Map of sparse vector data parameters to update for each sparse vector.
Map of sparse vector data parameters to update for each sparse vector.
Check to see if the all the properties in the model are valid @return true if the model is valid
Optional properties Map of vector data parameters to update for each named vector. To update parameters in a collection having a single unnamed vector, use an empty string as name.
Optional properties Map of vector data parameters to update for each named vector. To update parameters in a collection having a single unnamed vector, use an empty string as name.