class Qdrant::Api::CreateCollection

• Qdrant::Api::CreateCollection
• Reference
• Object

Overview

Operation for creating new collection and (optionally) specify index params

Included Modules

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

Defined in:

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(pull : JSON::PullParser)
• .new(vectors : VectorsConfig | Nil = nil, shard_number : Int32 | Nil = nil, sharding_method : ShardingMethod | Nil = nil, replication_factor : Int32 | Nil = nil, write_consistency_factor : Int32 | Nil = nil, on_disk_payload : Bool | Nil = nil, hnsw_config : HnswConfigDiff | Nil = nil, wal_config : WalConfigDiff | Nil = nil, optimizers_config : OptimizersConfigDiff | Nil = nil, quantization_config : QuantizationConfig | 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 true if this reference is the same as other.

• #hash(hasher)

  See Object#hash(hasher)

• #hnsw_config : HnswConfigDiff | Nil

  Custom params for HNSW index.

• #hnsw_config=(hnsw_config : HnswConfigDiff | Nil)

  Custom params for HNSW index.

• #list_invalid_properties

  Show invalid properties with the reasons.

• #metadata : Hash(String, JSON::Any) | Nil

  Arbitrary JSON metadata for the collection This can be used to store application-specific information such as creation time, migration data, inference model info, etc.

• #metadata=(metadata : Hash(String, JSON::Any) | Nil)

  Arbitrary JSON metadata for the collection This can be used to store application-specific information such as creation time, migration data, inference model info, etc.

• #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.

• #optimizers_config : OptimizersConfigDiff | Nil

  Custom params for Optimizers.

• #optimizers_config=(optimizers_config : OptimizersConfigDiff | Nil)

  Custom params for Optimizers.

• #quantization_config : QuantizationConfig | Nil

  Quantization parameters.

• #quantization_config=(quantization_config : QuantizationConfig | Nil)

  Quantization parameters.

• #replication_factor : Int32 | Nil

  Number of shards replicas.

• #replication_factor=(value : Int32 | Nil)

  Number of shards replicas.

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

  For auto sharding: Number of shards in collection.

• #shard_number=(value : Int32 | Nil)

  For auto sharding: Number of shards in collection.

• #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

  Sparse vector data config.

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

  Sparse vector data config.

• #strict_mode_config : StrictModeConfig | Nil

  Strict-mode config.

• #strict_mode_config=(strict_mode_config : StrictModeConfig | Nil)

  Strict-mode config.

• #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

• #wal_config : WalConfigDiff | Nil

  Custom params for WAL.

• #wal_config=(wal_config : WalConfigDiff | Nil)

  Custom params for WAL.

• #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