class
Qdrant::Api::CollectionInfo
- Qdrant::Api::CollectionInfo
- Reference
- Object
Overview
Current statistics and configuration of the collection
Included Modules
- JSON::Serializable
- Qdrant::Api::Serializable
- Qdrant::Api::Validation
- YAML::Serializable
Defined in:
qdrant-api/models/collection_info.crConstructors
-
.new(status : CollectionStatus, optimizer_status : OptimizersStatus, segments_count : Int32, config : CollectionConfig, payload_schema : Hash(String, PayloadIndexInfo), warnings : Array(CollectionWarning) | Nil = nil, indexed_vectors_count : Int32 | Nil = nil, points_count : Int32 | Nil = nil, update_queue : UpdateQueueInfo | Nil = nil)
Initializes the object @param [Hash] attributes Model attributes in the form of hash
- .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
- .new(pull : JSON::PullParser)
- .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. - #config : CollectionConfig
- #config=(config : CollectionConfig)
-
#hash(hasher)
See
Object#hash(hasher) -
#indexed_vectors_count : Int32 | Nil
Approximate number of indexed vectors in the collection.
-
#indexed_vectors_count=(value : Int32 | Nil)
Approximate number of indexed vectors in the collection.
- #indexed_vectors_count_validation_error(value) : String | Nil
-
#list_invalid_properties
Show invalid properties with the reasons.
- #optimizer_status : OptimizersStatus
- #optimizer_status=(optimizer_status : OptimizersStatus)
-
#payload_schema : Hash(String, PayloadIndexInfo)
Types of stored payload
-
#payload_schema=(payload_schema : Hash(String, PayloadIndexInfo))
Types of stored payload
-
#points_count : Int32 | Nil
Approximate number of points (vectors + payloads) in collection.
-
#points_count=(value : Int32 | Nil)
Approximate number of points (vectors + payloads) in collection.
- #points_count_validation_error(value) : String | Nil
-
#segments_count : Int32
Number of segments in collection.
-
#segments_count=(value : Int32)
Number of segments in collection.
- #segments_count_validation_error(value) : String | Nil
-
#status : CollectionStatus
Required properties
-
#status=(status : CollectionStatus)
Required properties
-
#update_queue : UpdateQueueInfo | Nil
Update queue info
-
#update_queue=(update_queue : UpdateQueueInfo | Nil)
Update queue info
-
#valid?
Check to see if the all the properties in the model are valid @return true if the model is valid
-
#warnings : Array(CollectionWarning) | Nil
Optional properties Warnings related to the collection
-
#warnings=(warnings : Array(CollectionWarning) | Nil)
Optional properties Warnings related to the collection
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?.
Approximate number of indexed vectors in the collection. Indexed vectors in large segments are faster to query, as it is stored in a specialized vector index.
Approximate number of indexed vectors in the collection. Indexed vectors in large segments are faster to query, as it is stored in a specialized vector index.
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Approximate number of points (vectors + payloads) in collection. Each point could be accessed by unique id.
Approximate number of points (vectors + payloads) in collection. Each point could be accessed by unique id.
Number of segments in collection. Each segment has independent vector as payload indexes
Number of segments in collection. Each segment has independent vector as payload indexes
Check to see if the all the properties in the model are valid @return true if the model is valid
Optional properties Warnings related to the collection
Optional properties Warnings related to the collection