class
Qdrant::Api::Collections
- Qdrant::Api::Collections
- Reference
- Object
Defined in:
qdrant-api/api/collections.crqdrant-api/client.cr
Constructors
Instance Method Summary
-
#aliases(change_aliases_operation : Qdrant::Api::ChangeAliasesOperation | Nil = nil, *, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::CreateShardKey200Response)
Update aliases of the collections
-
#aliases_get(collection_name : String) : Response(Qdrant::Api::GetCollectionAliases200Response)
List aliases for collection Get list of all aliases for a collection
-
#cluster(collection_name : String) : Response(Qdrant::Api::CollectionClusterInfo200Response)
Collection cluster info Get cluster information for a collection
-
#cluster_post(collection_name : String, cluster_operations : Qdrant::Api::ClusterOperations | Nil = nil, *, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::CreateShardKey200Response)
Update collection cluster setup
-
#delete(collection_name : String, *, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::CreateShardKey200Response)
Delete collection Drop collection and all associated data
-
#exists(collection_name : String) : Response(Qdrant::Api::CollectionExists200Response)
Check the existence of a collection Returns "true" if the given collection name exists, and "false" otherwise
-
#facet(collection_name : String, facet_request : Qdrant::Api::FacetRequest | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::Facet200Response)
Facet a payload key with a given filter.
-
#get(collection_name : String) : Response(Qdrant::Api::GetCollection200Response)
Collection info Get detailed information about specified existing collection
- #index : Collections::Index
-
#list : Response(Qdrant::Api::GetCollections200Response)
List collections Get list name of all existing collections
-
#optimizations(collection_name : String, *, _with : String | Nil = nil, completed_limit : Int32 | Nil = nil) : Response(Qdrant::Api::GetOptimizations200Response)
Get optimization progress Get progress of ongoing and completed optimizations for a collection
-
#partial_update(collection_name : String, update_collection : Qdrant::Api::UpdateCollection | Nil = nil, *, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::CreateShardKey200Response)
Update collection parameters Update parameters of the existing collection
- #points : Collections::Points
- #shards : Collections::Shards
- #snapshots : Collections::Snapshots
-
#update(collection_name : String, create_collection : Qdrant::Api::CreateCollection | Nil = nil, *, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::CreateShardKey200Response)
Create collection Create new collection with given parameters
- #vectors : Collections::Vectors
Constructor Detail
Instance Method Detail
Update aliases of the collections
List aliases for collection Get list of all aliases for a collection
Collection cluster info Get cluster information for a collection
Update collection cluster setup
Delete collection Drop collection and all associated data
Check the existence of a collection Returns "true" if the given collection name exists, and "false" otherwise
Facet a payload key with a given filter. Count points that satisfy the given filter for each unique value of a payload key.
Collection info Get detailed information about specified existing collection
List collections Get list name of all existing collections
Get optimization progress Get progress of ongoing and completed optimizations for a collection
Update collection parameters Update parameters of the existing collection
Create collection Create new collection with given parameters