View Source Qdrant.Api.Http.Collections (Qdrant v0.0.6)
Qdrant API Collections.
Collections are searchable collections of points.
Link to this section Summary
Functions
Get cluster information for a collection See more on qdrant
Get detailed information about specified existing collection. See more on qdrant
Create new collection with given parameters. See more on qdrant
Create index for field in collection See more on qdrant
Drop collection and all associated data See more on qdrant
Delete index for field in collection See more on qdrant
Get list of all aliases for a collection See more on qdrant
Get list name of all existing collections. See more on qdrant
Update aliases of the collections See more on qdrant
Update collection parameters See more on qdrant
Update collection cluster setup See more on qdrant
Link to this section Types
@type alias_actions_list() :: %{ actions: [delete_alias() | create_alias() | rename_alias()] }
@type body_schema() :: %{field_name: String.t(), field_schema: field_schema()}
@type cluster_update_body() :: %{move_shard: shadred_operation_params()} | %{replicate_shard: shadred_operation_params()} | %{abort_transfer: shadred_operation_params()} | %{drop_replica: drop_replica_params()}
@type delete_alias() :: %{alias_name: String.t()}
@type field_schema() :: %{ type: index_body_type(), tokenizers: tokenizer_type(), min_token_len: integer(), max_token_len: integer(), lowercase: boolean() }
@type index_body_type() :: :keyword | :integer | :float | :geo | :text
@type ordering() :: :weak | :medium | :strong
@type tokenizer_type() :: :prefix | :whitespace | :word
Link to this section Functions
Get cluster information for a collection See more on qdrant
path-parameters
Path parameters
- collection_name required : Name of the collection to retrieve the cluster info for
example
Example
iex> Qdrant.collection_cluster_info("collection_name")
{:ok, %{"status" => "ok", "time" => 0, "result" => %{"operation_id" => 42, status: "acknowledged"} }}}}
Get detailed information about specified existing collection. See more on qdrant
path-parameters
Path parameters
- collection_name required: name of the collection
example
Example
iex> Qdrant.Api.Http.Collections.collection_info("my_collection")
{:ok, %Tesla.Env{status: 200,
body: %{
"result" => %{
"collection_type" => "Flat",
"name" => "my_collection",
"points_count" => 0,
"vectors_count" => 0
},
"status" => "ok",
"time" => 2.043e-6
}
}
}
Create new collection with given parameters. See more on qdrant
path-parameters
Path parameters
- name required : Name of the new collection
query-parameters
Query parameters
- timeout optional : Wait for operation commit timeout in seconds. If timeout is reached - request will return with service error.
request-body-schema
Request body schema
vectors
required: Vector params separator for single and multiple vector modes. Single mode:%{size: 128, distance: "Cosine"}
or multiple mode:%{default: {size: 128, distance: "Cosine"}}
shard_number
optional:null
orpositive integer
Default:null
. Number of shards in collection. Default is 1 for standalone, otherwise equal to the number of nodes Minimum is 1.replication_factor
optional:null
orpositive integer
Default:null
. Number of shards replicas. Default is 1 Minimum is 1write_consistency_factor
optional:null
orpositive integer
Default:null
. Defines how many replicas should apply the operation for us to consider it successful. Increasing this number will make the collection more resilient to inconsistencies, but will also make it fail if not enough replicas are available. Does not have any performance impact.on_disk_payload
optional:boolean or null
Default:null
. If true - point's payload will not be stored in memory. It will be read from the disk every time it is requested. This setting saves RAM by (slightly) increasing the response time. Note: those payload values that are involved in filtering and are indexed - remain in RAM.hnsw_config
optional: Custom params for HNSW index. If none - values from service configuration file are used.wal_config
optional: Custom params for WAL. If none - values from service configuration file are used.optimizers_config
optional: Custom params for Optimizers. If none - values from service configuration file are used.init_from
optional:null
orstring
Default:null
. Specify other collection to copy data from.quantization_config
optional: Default:null
. m Quantization parameters. If none - quantization is disabled.
create_field_index(collection_name, body, wait \\ false, ordering \\ nil)
View Source@spec create_field_index(String.t(), body_schema(), boolean(), ordering() | nil) :: {:ok, map()} | {:error, any()}
Create index for field in collection See more on qdrant
path-parameters
Path parameters
- collection_name required : Name of the collection
query-parameters
Query parameters
wait
optional : If true, wait for changes to actually happenordering
optional : Define ordering guarantees for the operation
request-body-schema
Request body schema
field_name
required : Name of the field to indexfield_schema
required : Type of the field to index
example
Example
iex> Qdrant.create_field_index("collection_name", %{field_name: "field_name", field_schema: "field_schema"})
{:ok, %{"status" => "ok", "time" => 0, "result" => %{"operation_id" => 42, status: "acknowledged"} }}}}
Drop collection and all associated data See more on qdrant
path-parameters
Path parameters
- collection_name required : Name of the collection to delete
query-parameters
Query parameters
- timeout optional : Wait for operation commit timeout in seconds. If timeout is reached - request will return with service error.
delete_field_index(collection_name, field_name, wait \\ false, ordering \\ nil)
View Source@spec delete_field_index(String.t(), String.t(), boolean(), ordering() | nil) :: {:ok, map()} | {:error, any()}
Delete index for field in collection See more on qdrant
path-parameters
Path parameters
collection_name required : Name of the collection
field_name required : Name of the field where to delete the index
query-parameters
Query parameters
wait
optional : If true, wait for changes to actually happenordering
optional : Define ordering guarantees for the operation
example
Example
iex> Qdrant.delete_field_index("collection_name", "field_name")
{:ok, %{"status" => "ok", "time" => 0, "result" => %{"operation_id" => 42, status: "acknowledged"} }}}}
Get list of all aliases for a collection See more on qdrant
path-parameters
Path parameters
- collection_name required : Name of the collection to retrieve the aliases for
example
Example
iex> Qdrant.list_collection_aliases("collection_name")
{:ok, %{"status" => "ok", "time" => 0, "result" => %{"operation_id" => 42, status: "acknowledged"} }}}}
@spec list_collections() :: {:ok, Tesla.Env.t()} | {:error, any()}
Get list name of all existing collections. See more on qdrant
example
Example
iex> Qdrant.Api.Http.Collections.list_collections()
{:ok, %Tesla.Env{status: 200,
body: %{
"result" => %{"collections" => [...]},
"status" => "ok",
"time" => 2.043e-6
}
}
}
@spec update_aliases(alias_actions_list(), integer() | nil) :: {:ok, map()} | {:error, any()}
Update aliases of the collections See more on qdrant
query-parameters
Query parameters
- timeout optional : Wait for operation commit timeout in seconds. If timeout is reached - request will return with service error.
request-body-schema
Request body schema
actions
required: List of actions to perform. Create_alias or delete_alias or rename_alias.
example
Example
iex> Qdrant.update_aliases(%{
...> actions: [
...> %{create_alias: %{alias: "alias_name", collection: "collection_name"}},
...> %{delete_alias: %{alias: "alias_name"}},
...> %{rename_alias: %{alias: "alias_name", new_alias: "new_alias_name"}}
...> ]
...> })
{:ok, %{"result" => true, "status" => "ok", "time" => 0}}
Update collection parameters See more on qdrant
path-parameters
Path parameters
- collection_name required : Name of the collection to update
query-parameters
Query parameters
- timeout optional : Wait for operation commit timeout in seconds. If timeout is reached - request will return with service error.
request-body-schema
Request body schema
optimizers_config
optional: Custom params for Optimizers. If none - values from service configuration file are used. This operation is blocking, it will only proceed ones all current optimizations are completeparams
optional: Collection base params. If none - values from service configuration file are used.
@spec update_collection_cluster(String.t(), cluster_update_body(), integer() | nil) :: {:ok, map()} | {:error, any()}
Update collection cluster setup See more on qdrant
path-parameters
Path parameters
- collection_name required : Name of the collection on which to to apply the cluster update operation
query-parameters
Query parameters
timeout
optional : Wait for operation commit timeout in seconds. If timeout is reached - request will return with service error.
request-body-schema
Request body schema
move_shard
orreplicate_shard
orabort_transfer
ordrop_replica
required : List of actions to perform.
example
Example
iex> Qdrant.update_collection_cluster("collection_name", %{
...> move_shard: %{
...> shard_id: 1,
...> to_peer_id: 42,
...> from_peer_id: 69
...> }
...> })
{:ok, %{"status" => "ok", "time" => 0, "result" => %{"operation_id" => 42, status: "acknowledged"} }}}}
iex> Qdrant.update_collection_cluster("collection_name", %{
...> drop_replica: %{
...> shard_id: 1,
...> peer_id: 42
...> }
...> })
{:ok, %{"status" => "ok", "time" => 0, "result" => %{"operation_id" => 42, status: "acknowledged"} }}}}