class Qdrant::Api::CollectionInfo

Overview

Current statistics and configuration of the collection

Included Modules

Defined in:

qdrant-api/models/collection_info.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(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


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

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

[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 config : CollectionConfig #

[View source]
def config=(config : CollectionConfig) #

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

See Object#hash(hasher)


def indexed_vectors_count : Int32 | Nil #

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.


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

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.


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

[View source]
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 optimizer_status : OptimizersStatus #

[View source]
def optimizer_status=(optimizer_status : OptimizersStatus) #

[View source]
def payload_schema : Hash(String, PayloadIndexInfo) #

Types of stored payload


[View source]
def payload_schema=(payload_schema : Hash(String, PayloadIndexInfo)) #

Types of stored payload


[View source]
def points_count : Int32 | Nil #

Approximate number of points (vectors + payloads) in collection. Each point could be accessed by unique id.


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

Approximate number of points (vectors + payloads) in collection. Each point could be accessed by unique id.


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

[View source]
def segments_count : Int32 #

Number of segments in collection. Each segment has independent vector as payload indexes


[View source]
def segments_count=(value : Int32) #

Number of segments in collection. Each segment has independent vector as payload indexes


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

[View source]
def status : CollectionStatus #

Required properties


[View source]
def status=(status : CollectionStatus) #

Required properties


[View source]
def update_queue : UpdateQueueInfo | Nil #

Update queue info


[View source]
def update_queue=(update_queue : UpdateQueueInfo | Nil) #

Update queue info


[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 warnings : Array(CollectionWarning) | Nil #

Optional properties Warnings related to the collection


[View source]
def warnings=(warnings : Array(CollectionWarning) | Nil) #

Optional properties Warnings related to the collection


[View source]