class Qdrant::Api::CollectionParams

• Qdrant::Api::CollectionParams
• Reference
• Object

Included Modules

• JSON::Serializable
• Qdrant::Api::Serializable
• Qdrant::Api::Validation
• YAML::Serializable

Defined in:

qdrant-api/models/collection_params.cr

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(pull : JSON::PullParser)
• .new(vectors : VectorsConfig | Nil = nil, shard_number : Int32 | Nil = 1, sharding_method : ShardingMethod | Nil = nil, replication_factor : Int32 | Nil = 1, write_consistency_factor : Int32 | Nil = 1, read_fan_out_factor : Int32 | Nil = nil, read_fan_out_delay_ms : Int32 | Nil = nil, on_disk_payload : Bool | Nil = true, sparse_vectors : Hash(String, SparseVectorParams) | 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 true if this reference is the same as other.

• #hash(hasher)

  See Object#hash(hasher)

• #list_invalid_properties

  Show invalid properties with the reasons.

• #on_disk_payload : Bool | Nil

  If true - point's payload will not be stored in memory.

• #on_disk_payload=(on_disk_payload : Bool | Nil)

  If true - point's payload will not be stored in memory.

• #read_fan_out_delay_ms : Int32 | Nil

  Define number of milliseconds to wait before attempting to read from another replica.

• #read_fan_out_delay_ms=(value : Int32 | Nil)

  Define number of milliseconds to wait before attempting to read from another replica.

• #read_fan_out_delay_ms_validation_error(value) : String | Nil
• #read_fan_out_factor : Int32 | Nil

  Defines how many additional replicas should be processing read request at the same time.

• #read_fan_out_factor=(value : Int32 | Nil)

  Defines how many additional replicas should be processing read request at the same time.

• #read_fan_out_factor_validation_error(value) : String | Nil
• #replication_factor : Int32 | Nil

  Number of replicas for each shard

• #replication_factor=(value : Int32 | Nil)

  Number of replicas for each shard

• #replication_factor_validation_error(value) : String | Nil
• #shard_number : Int32 | Nil

  Number of shards the collection has

• #shard_number=(value : Int32 | Nil)

  Number of shards the collection has

• #shard_number_validation_error(value) : String | Nil
• #sharding_method : ShardingMethod | Nil

  Sharding method Default is Auto - points are distributed across all available shards Custom - points are distributed across shards according to shard key

• #sharding_method=(sharding_method : ShardingMethod | Nil)

  Sharding method Default is Auto - points are distributed across all available shards Custom - points are distributed across shards according to shard key

• #sparse_vectors : Hash(String, SparseVectorParams) | Nil

  Configuration of the sparse vector storage

• #sparse_vectors=(sparse_vectors : Hash(String, SparseVectorParams) | Nil)

  Configuration of the sparse vector storage

• #valid?

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

• #vectors : VectorsConfig | Nil

  Optional properties

• #vectors=(vectors : VectorsConfig | Nil)

  Optional properties

• #write_consistency_factor : Int32 | Nil

  Defines how many replicas should apply the operation for us to consider it successful.

• #write_consistency_factor=(value : Int32 | Nil)

  Defines how many replicas should apply the operation for us to consider it successful.

• #write_consistency_factor_validation_error(value) : String | Nil

Constructor Detail

Instance Method Detail