atmon docs

REFERENCE/TOOLKITS/QDRANT.MD

Qdrant

Vector database. Create and manage collections, add and delete points, and run vector search, recommendation, and filtered queries.

PropertyValue
Slugqdrant
Definition version0.1.0
Base URLhttps://{{account.hostname}}:{{account.port}}
Auth schemesapi_key
Action tools65
By class17 read, 36 write, 12 destructive
Triggers0
Provider rate limitnot declared, so outbound calls are unpaced

Measured routing accuracy

83 golden cases replayed through the router over the whole index: measured over corpus ea4f12ad2948 (65 toolkits, 2283 tools indexed and 13 declared uncallable), 65 cases written by hand and 18 cases from the paraphrase pass. A case counts as top-1 when its gold tool ranked first and top-8 when it reached the slate at all.

MeasureCasesShare
top-165/8378.3%
top-881/8397.6%

The sweep is offline: the reranker is a deterministic identity fake that returns candidates in the order retrieval produced them, so top-1 measures retrieval order rather than a reranked slate. just eval-live measures the same cases through the live reranker.

Authentication

Connect an entity with ConnectionsService.InitiateConnection, naming this toolkit's slug. Credentials stay in the connections vault; callers hold connected-account ids only.

api_key

PropertyValue
Placementheader
Nameapi-key
Rendered as{key}

Submit the key with ConnectionsService rather than putting it in a request; it is sealed at rest and never returned.

Tools

65 action tools. The catalog-wide slug is qdrant.<tool>, which is what search_tools returns and call_tool takes.

qdrant.root

Returns information about the running Qdrant instance. Returns information about the running Qdrant instance like version and commit id. Calls GET /.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /.

Takes no arguments.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
commitstring
titlestring
versionstring

Also retrieved by: "what version is this server", "build and commit of the running instance", "basic info about the service".

qdrant.get_collections_aliases

List collections aliases. Get list of all existing collections aliases. Calls GET /aliases.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /aliases.

Takes no arguments.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.aliasesarray
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "every nickname across all indexes", "which alternate names are defined", "the full alias mapping on this cluster".

qdrant.cluster_status

Read the Qdrant cluster's state: which nodes and peers are members, which one leads, and where raft consensus stands. Use for questions about node health and cluster membership. Calls GET /cluster.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /cluster.

Takes no arguments.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobjectInformation about current cluster status and structure
result.statusstring, one of disabled
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "how are the nodes doing", "which peers belong to this deployment", "who leads the raft group right now".

qdrant.remove_peer

Remove peer from the cluster. Tries to remove peer from the cluster. Calls DELETE /cluster/peer/{peer_id}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /cluster/peer/{{params.peer_id}}.

Arguments:

ArgumentTypeRequiredNotes
forcebooleannoIf true - removes peer even if it has shards/replicas on it. Defaults to false.
peer_idintegeryesId of the peer
timeoutintegernoWait for operation commit timeout in seconds. If timeout is reached - request will return with service error.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultboolean
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "drop a node from the cluster", "detach a member by its id", "take a peer out of consensus".

qdrant.recover_current_peer

Tries to recover current peer Raft state. Calls POST /cluster/recover.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /cluster/recover.

Takes no arguments.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultboolean
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "repair this node's raft state", "bring a peer back into consensus", "fix a member that fell out of the cluster".

qdrant.cluster_telemetry

Collect cluster telemetry data. Get telemetry data, from the point of view of the cluster. Calls GET /cluster/telemetry.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /cluster/telemetry.

Arguments:

ArgumentTypeRequiredNotes
details_levelintegernoThe level of detail to include in the response
timeoutintegernoTimeout for this request. Defaults to 60.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.clusterobject
result.collectionsobject
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "usage figures across every peer", "cluster-wide stats and counters", "how the whole deployment is performing".

qdrant.get_collections

List the collections in Qdrant: the name of every vector store and embedding index this database holds. Use when someone asks what stores or indexes exist. Calls GET /collections.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /collections.

Takes no arguments.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.collectionsarray
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "what vector stores exist here", "every index this database holds", "names of the embedding stores".

qdrant.update_aliases

Update aliases of the collections. Calls POST /collections/aliases.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/aliases.

Arguments:

ArgumentTypeRequiredNotes
actionsarray of objectyes
actions[].create_aliasobjectyesCreate alternative name for a collection. Collection will be available under both names for search, retrieve,
timeoutintegernoWait for operation commit timeout in seconds. If timeout is reached - request will return with service error.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultboolean
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "point a nickname at a different index", "swap which collection a name resolves to", "add or drop alternate names in one call".

qdrant.get_collection

Read one Qdrant collection's info and configuration: the vector size and distance metric of a store, its shard, replica, and payload settings, and how many records it holds. Calls GET /collections/{collection_name}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /collections/{{params.collection_name}}.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to retrieve

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobjectCurrent statistics and configuration of the collection
result.configobjectInformation about the collection configuration
result.indexed_vectors_countinteger (uint)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.
result.optimizer_statusstring, one of okCurrent state of the collection
result.payload_schemaobjectTypes of stored payload
result.points_countinteger (uint)Approximate number of points (vectors + payloads) in collection. Each point could be accessed by unique id.
result.segments_countinteger (uint)Number of segments in collection. Each segment has independent vector as payload indexes
result.statusstring, one of green, yellow, grey, redCurrent state of the collection. Green - all good. Yellow - optimization is running, 'Grey' - optimizations are possible but not triggered, Red - some operations failed and was not recovered
result.update_queueobjectUpdate queue info
result.warningsarrayWarnings related to the collection
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "how is this store configured", "what vector size and metric does it use", "shard and replica settings of one store".

qdrant.create_collection

Create a Qdrant collection: a new vector store for embeddings, with the vector size, distance metric, and sharding it should use. Calls PUT /collections/{collection_name}.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /collections/{{params.collection_name}}.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the new collection
hnsw_configobjectnoCustom params for HNSW index. If none - values from service configuration file are used.
hnsw_config.ef_constructinteger (uint)noNumber of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build the index.
hnsw_config.full_scan_thresholdinteger (uint)noMinimal size threshold (in KiloBytes) below which full-scan is preferred over HNSW search. This measures the total size of vectors being queried against. When the maximum estimated amount of points...
hnsw_config.inline_storagebooleannoStore copies of original and quantized vectors within the HNSW index file. Default: false. Enabling this option will trade the search speed for disk usage by reducing amount of random seeks during...
hnsw_config.minteger (uint)noNumber of edges per node in the index graph. Larger the value - more accurate the search, more space required.
hnsw_config.max_indexing_threadsinteger (uint)noNumber of parallel threads used for background index building. If 0 - automatically select from 8 to 16. Best to keep between 8 and 16 to prevent likelihood of building broken/inefficient HNSW...
hnsw_config.on_diskbooleannoStore HNSW index on disk. If set to false, the index will be stored in RAM. Default: false
hnsw_config.payload_minteger (uint)noCustom M param for additional payload-aware HNSW links. If not set, default M will be used.
metadataobjectnoArbitrary 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_payloadbooleannoIf 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...
optimizers_configobjectnoCustom params for Optimizers. If none - values from service configuration file are used.
optimizers_config.default_segment_numberinteger (uint)noTarget amount of segments optimizer will try to keep. Real amount of segments may vary depending on multiple parameters: - Amount of stored points - Current write RPS It is recommended to select...
optimizers_config.deleted_thresholdnumber (double)noThe minimal fraction of deleted vectors in a segment, required to perform segment optimization
optimizers_config.flush_interval_secinteger (uint64)noMinimum interval between forced flushes.
optimizers_config.indexing_thresholdinteger (uint)noMaximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing Default value is 20,000, based on...
optimizers_config.max_optimization_threadsstring, one of autonoMax number of threads (jobs) for running optimizations per shard. Note: each optimization job will also use max_indexing_threads threads by itself for index building. If "auto" - have no limit and...
optimizers_config.max_segment_sizeinteger (uint)noDo not create segments larger this size (in kilobytes). Large segments might require disproportionately long indexation times, therefore it makes sense to limit the size of segments. If indexation...
optimizers_config.memmap_thresholdinteger (uint)noMaximum size (in kilobytes) of vectors to store in-memory per segment. Segments larger than this threshold will be stored as read-only memmapped file. Memmap storage is disabled by default, to enable...
optimizers_config.prevent_unoptimizedbooleannoIf enabled, the service will try to prevent the creation of large unoptimized segments. When enabled, new points written to segments larger than the indexing threshold are stored as "deferred...
optimizers_config.vacuum_min_vector_numberinteger (uint)noThe minimal number of vectors in a segment, required to perform segment optimization
quantization_configobjectnoQuantization parameters. If none - quantization is disabled.
quantization_config.scalarobjectyes
replication_factorinteger (uint32)noNumber of shards replicas. Default is 1 Minimum is 1
shard_numberinteger (uint32)noFor auto sharding: Number of shards in collection. - Default is 1 for standalone, otherwise equal to the number of nodes - Minimum is 1 For custom sharding: Number of shards in collection per shard...
sharding_methodstring, one of auto, customnoSharding method Default is Auto - points are distributed across all available shards Custom - points are distributed across shards according to shard key
sparse_vectorsobjectnoSparse vector data config.
strict_mode_configobjectnoStrict-mode config.
strict_mode_config.condition_max_sizeinteger (uint)noMax size of a condition, eg. items in MatchAny.
strict_mode_config.enabledbooleannoWhether strict mode is enabled for a collection or not.
strict_mode_config.filter_max_conditionsinteger (uint)noMax conditions a filter can have.
strict_mode_config.max_collection_payload_size_bytesinteger (uint)noMax size of a collections payload storage in bytes
strict_mode_config.max_collection_vector_size_bytesinteger (uint)noMax size of a collections vector storage in bytes, ignoring replicas.
strict_mode_config.max_disk_usage_percentinteger (uint8)noReject disk-consuming update operations (e.g. upsert, set payload) when the filesystem hosting Qdrant storage is filled above this percentage of its total capacity. Value in [1, 100]. Applied...
strict_mode_config.max_payload_index_countinteger (uint)noMax number of payload indexes in a collection
strict_mode_config.max_points_countinteger (uint)noMax number of points estimated in a collection
strict_mode_config.max_query_limitinteger (uint)noMax allowed limit parameter for all APIs that don't have their own max limit.
strict_mode_config.max_resident_memory_percentinteger (uint8)noReject memory-consuming update operations (e.g. upsert, set payload) when the process resident memory exceeds this percentage of total system memory (or cgroup limit). Value in [1, 100]. Applied...
strict_mode_config.max_timeoutinteger (uint)noMax allowed timeout parameter.
strict_mode_config.multivector_configobjectnoMultivector strict mode configuration
strict_mode_config.read_rate_limitinteger (uint)noMax number of read operations per minute per replica
strict_mode_config.search_allow_exactbooleannoWhether exact search is allowed.
strict_mode_config.search_max_batchsizeinteger (uint)noMax batchsize when searching
strict_mode_config.search_max_hnsw_efinteger (uint)noMax HNSW ef value allowed in search parameters.
strict_mode_config.search_max_oversamplingnumber (double)noMax oversampling value allowed in search.
strict_mode_config.sparse_configobjectnoSparse vector strict mode configuration
strict_mode_config.unindexed_filtering_retrievebooleannoAllow usage of unindexed fields in retrieval based (e.g. search) filters.
strict_mode_config.unindexed_filtering_updatebooleannoAllow usage of unindexed fields in filtered updates (e.g. delete by payload).
strict_mode_config.upsert_max_batchsizeinteger (uint)noMax batchsize when upserting
strict_mode_config.write_rate_limitinteger (uint)noMax number of write operations per minute per replica
timeoutintegernoWait for operation commit timeout in seconds. If timeout is reached - request will return with service error.
vectorsobjectnoVector params separator for single and multiple vector modes Single mode: { "size": 128, "distance": "Cosine" } or multiple mode: { "default": { "size": 128, "distance": "Cosine" } }
vectors.datatypestring, one of float32, uint8, float16, turbo4noDefines which datatype should be used to represent vectors in the storage. Choosing different datatypes allows to optimize memory usage and performance vs accuracy. - For float32 datatype - vectors...
vectors.distancestring, one of Cosine, Euclid, Dot, ManhattanyesType of internal tags, build from payload Distance function types used to compare vectors
vectors.hnsw_configobjectnoCustom params for HNSW index. If none - values from collection configuration are used.
vectors.multivector_configobjectno
vectors.on_diskbooleannoIf true, vectors are served from disk, improving RAM usage at the cost of latency Default: false
vectors.quantization_configobjectnoCustom params for quantization. If none - values from collection configuration are used.
vectors.sizeinteger (uint64)yesSize of a vectors used
wal_configobjectnoCustom params for WAL. If none - values from service configuration file are used.
wal_config.wal_capacity_mbinteger (uint)noSize of a single WAL segment in MB
wal_config.wal_retain_closedinteger (uint)noNumber of closed WAL segments to retain
wal_config.wal_segments_aheadinteger (uint)noNumber of WAL segments to create ahead of actually used ones
write_consistency_factorinteger (uint32)noDefines 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...

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultboolean
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "set up a new vector store", "start a fresh index for embeddings", "make somewhere to keep my vectors".

qdrant.update_collection

Update collection parameters. Update parameters of the existing collection. Calls PATCH /collections/{collection_name}.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PATCH /collections/{{params.collection_name}}.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to update
hnsw_configobjectnoHNSW parameters to update for the collection index. If none - it is left unchanged.
hnsw_config.ef_constructinteger (uint)noNumber of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build the index.
hnsw_config.full_scan_thresholdinteger (uint)noMinimal size threshold (in KiloBytes) below which full-scan is preferred over HNSW search. This measures the total size of vectors being queried against. When the maximum estimated amount of points...
hnsw_config.inline_storagebooleannoStore copies of original and quantized vectors within the HNSW index file. Default: false. Enabling this option will trade the search speed for disk usage by reducing amount of random seeks during...
hnsw_config.minteger (uint)noNumber of edges per node in the index graph. Larger the value - more accurate the search, more space required.
hnsw_config.max_indexing_threadsinteger (uint)noNumber of parallel threads used for background index building. If 0 - automatically select from 8 to 16. Best to keep between 8 and 16 to prevent likelihood of building broken/inefficient HNSW...
hnsw_config.on_diskbooleannoStore HNSW index on disk. If set to false, the index will be stored in RAM. Default: false
hnsw_config.payload_minteger (uint)noCustom M param for additional payload-aware HNSW links. If not set, default M will be used.
metadataobjectnoMetadata to update for the collection. If provided, this will merge with existing metadata. To remove metadata, set it to an empty object.
optimizers_configobjectnoCustom params for Optimizers. If none - it is left unchanged. This operation is blocking, it will only proceed once all current optimizations are complete
optimizers_config.default_segment_numberinteger (uint)noTarget amount of segments optimizer will try to keep. Real amount of segments may vary depending on multiple parameters: - Amount of stored points - Current write RPS It is recommended to select...
optimizers_config.deleted_thresholdnumber (double)noThe minimal fraction of deleted vectors in a segment, required to perform segment optimization
optimizers_config.flush_interval_secinteger (uint64)noMinimum interval between forced flushes.
optimizers_config.indexing_thresholdinteger (uint)noMaximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing Default value is 20,000, based on...
optimizers_config.max_optimization_threadsstring, one of autonoMax number of threads (jobs) for running optimizations per shard. Note: each optimization job will also use max_indexing_threads threads by itself for index building. If "auto" - have no limit and...
optimizers_config.max_segment_sizeinteger (uint)noDo not create segments larger this size (in kilobytes). Large segments might require disproportionately long indexation times, therefore it makes sense to limit the size of segments. If indexation...
optimizers_config.memmap_thresholdinteger (uint)noMaximum size (in kilobytes) of vectors to store in-memory per segment. Segments larger than this threshold will be stored as read-only memmapped file. Memmap storage is disabled by default, to enable...
optimizers_config.prevent_unoptimizedbooleannoIf enabled, the service will try to prevent the creation of large unoptimized segments. When enabled, new points written to segments larger than the indexing threshold are stored as "deferred...
optimizers_config.vacuum_min_vector_numberinteger (uint)noThe minimal number of vectors in a segment, required to perform segment optimization
paramsobjectnoCollection base params. If none - it is left unchanged.
params.on_disk_payloadbooleannoIf 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...
params.read_fan_out_delay_msinteger (uint64)noDelay in milliseconds before sending read requests to remote nodes
params.read_fan_out_factorinteger (uint32)noFan-out every read request to these many additional remote nodes (and return first available response)
params.replication_factorinteger (uint32)noNumber of replicas for each shard
params.write_consistency_factorinteger (uint32)noMinimal number successful responses from replicas to consider operation successful
quantization_configobjectnoQuantization parameters to update. If none - it is left unchanged.
quantization_config.scalarobjectyes
sparse_vectorsobjectnoMap of sparse vector data parameters to update for each sparse vector.
strict_mode_configobjectno
strict_mode_config.condition_max_sizeinteger (uint)noMax size of a condition, eg. items in MatchAny.
strict_mode_config.enabledbooleannoWhether strict mode is enabled for a collection or not.
strict_mode_config.filter_max_conditionsinteger (uint)noMax conditions a filter can have.
strict_mode_config.max_collection_payload_size_bytesinteger (uint)noMax size of a collections payload storage in bytes
strict_mode_config.max_collection_vector_size_bytesinteger (uint)noMax size of a collections vector storage in bytes, ignoring replicas.
strict_mode_config.max_disk_usage_percentinteger (uint8)noReject disk-consuming update operations (e.g. upsert, set payload) when the filesystem hosting Qdrant storage is filled above this percentage of its total capacity. Value in [1, 100]. Applied...
strict_mode_config.max_payload_index_countinteger (uint)noMax number of payload indexes in a collection
strict_mode_config.max_points_countinteger (uint)noMax number of points estimated in a collection
strict_mode_config.max_query_limitinteger (uint)noMax allowed limit parameter for all APIs that don't have their own max limit.
strict_mode_config.max_resident_memory_percentinteger (uint8)noReject memory-consuming update operations (e.g. upsert, set payload) when the process resident memory exceeds this percentage of total system memory (or cgroup limit). Value in [1, 100]. Applied...
strict_mode_config.max_timeoutinteger (uint)noMax allowed timeout parameter.
strict_mode_config.multivector_configobjectnoMultivector strict mode configuration
strict_mode_config.read_rate_limitinteger (uint)noMax number of read operations per minute per replica
strict_mode_config.search_allow_exactbooleannoWhether exact search is allowed.
strict_mode_config.search_max_batchsizeinteger (uint)noMax batchsize when searching
strict_mode_config.search_max_hnsw_efinteger (uint)noMax HNSW ef value allowed in search parameters.
strict_mode_config.search_max_oversamplingnumber (double)noMax oversampling value allowed in search.
strict_mode_config.sparse_configobjectnoSparse vector strict mode configuration
strict_mode_config.unindexed_filtering_retrievebooleannoAllow usage of unindexed fields in retrieval based (e.g. search) filters.
strict_mode_config.unindexed_filtering_updatebooleannoAllow usage of unindexed fields in filtered updates (e.g. delete by payload).
strict_mode_config.upsert_max_batchsizeinteger (uint)noMax batchsize when upserting
strict_mode_config.write_rate_limitinteger (uint)noMax number of write operations per minute per replica
timeoutintegernoWait for operation commit timeout in seconds. If timeout is reached - request will return with service error.
vectorsobjectnoMap of vector data parameters to update for each named vector. To update parameters in a collection having a single unnamed vector, use an empty string as name.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultboolean
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "change an index's optimizer and hnsw settings", "tune segment and quantization config", "alter how a vector collection is stored".

qdrant.delete_collection

Delete a Qdrant collection: drop a whole vector store, its embeddings, and its metadata, permanently and without a recycle bin. Calls DELETE /collections/{collection_name}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /collections/{{params.collection_name}}.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to delete
timeoutintegernoWait for operation commit timeout in seconds. If timeout is reached - request will return with service error.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultboolean
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "drop a whole vector store", "throw away an index and its embeddings", "remove a store for good".

qdrant.get_collection_aliases

List a Qdrant collection's aliases: the alternative names that point at one vector store, which is how a rebuilt store takes over a name clients already query. Calls GET /collections/{collection_name}/aliases.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /collections/{{params.collection_name}}/aliases.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.aliasesarray
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "what other names point at this store", "alternative names for one index", "which store does an alias resolve to".

qdrant.collection_cluster_info

Collection cluster info. Get cluster information for a collection. Calls GET /collections/{collection_name}/cluster.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /collections/{{params.collection_name}}/cluster.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to retrieve the cluster info for

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobjectCurrent clustering distribution for the collection
result.local_shardsarrayLocal shards
result.peer_idinteger (uint64)ID of this peer
result.remote_shardsarrayRemote shards
result.resharding_operationsarrayResharding operations
result.shard_countinteger (uint)Total number of shards
result.shard_transfersarrayShard transfers
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "which shards of an index sit on which node", "peer placement for one vector collection", "local and remote shard layout here".

qdrant.update_collection_cluster

Update collection cluster setup. Calls POST /collections/{collection_name}/cluster.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/cluster.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection on which to to apply the cluster update operation
move_shardobjectyes
move_shard.from_peer_idinteger (uint64)yes
move_shard.methodstring, one of stream_records, snapshot, wal_delta, resharding_stream_recordsnoMethod for transferring the shard from one node to another
move_shard.shard_idinteger (uint32)yes
move_shard.to_peer_idinteger (uint64)yes
timeoutintegernoWait for operation commit timeout in seconds. If timeout is reached - request will return with service error.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultboolean
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "move a shard to another peer", "rebalance replicas across nodes", "change where partitions of an index live".

qdrant.collection_exists

Check whether a Qdrant collection exists: answer true or false for a vector store or index by name, without reading its configuration. Use before creating a store that may already be there. Calls GET /collections/{collection_name}/exists.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /collections/{{params.collection_name}}/exists.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobjectState of existence of a collection, true = exists, false = does not exist
result.existsboolean
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "is there already a store by that name", "has this index been created yet", "check a name before setting one up".

qdrant.facet

Facet a payload key with a given filter. Count points that satisfy the given filter for each unique value of a payload key. Calls POST /collections/{collection_name}/facet.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/facet.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to facet in
consistencyinteger (uint)noDefine read consistency guarantees for the operation
exactbooleannoWhether to do a more expensive exact count for each of the values in the facet. Default is false.
filterobjectnoFilter conditions - only consider points that satisfy these conditions.
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
keystringyesPayload key to use for faceting.
limitinteger (uint)noMax number of hits to return. Default is 10.
shard_keystringno
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.hitsarray
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "count matches per distinct value", "how many points share each payload value", "group a filtered result by one key".

qdrant.create_field_index

Index one payload field of a Qdrant collection, so filters and lookups on that attribute or metadata key run fast instead of scanning. Calls PUT /collections/{collection_name}/index.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /collections/{{params.collection_name}}/index.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection
field_namestringyes
field_schemastring, one of keyword, integer, float, geo, text, bool, datetime, uuidnoAll possible names of payload types
orderingstring, one of weak, medium, strongnodefine ordering guarantees for the operation
timeoutintegernoTimeout for the operation
waitbooleannoIf true, wait for changes to actually happen

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.operation_idinteger (uint64)Sequential number of the operation
result.statusstring, one of acknowledged, completed, wait_timeoutAcknowledged - Request is saved to WAL and will be process in a queue. Completed - Request is completed, changes are actual. WaitTimeout - Request is waiting for timeout.
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "make filtering on an attribute fast", "add a payload index on one field", "stop a metadata lookup from scanning".

qdrant.delete_field_index

Delete index for field in collection. Delete field index for collection. Calls DELETE /collections/{collection_name}/index/{field_name}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /collections/{{params.collection_name}}/index/{{params.field_name}}.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection
field_namestringyesName of the field where to delete the index
orderingstring, one of weak, medium, strongnodefine ordering guarantees for the operation
timeoutintegernoTimeout for the operation
waitbooleannoIf true, wait for changes to actually happen

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.operation_idinteger (uint64)Sequential number of the operation
result.statusstring, one of acknowledged, completed, wait_timeoutAcknowledged - Request is saved to WAL and will be process in a queue. Completed - Request is completed, changes are actual. WaitTimeout - Request is waiting for timeout.
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "drop a payload field index", "stop indexing one metadata key", "remove the secondary lookup on an attribute".

qdrant.get_optimizations

Get optimization progress. Get progress of ongoing and completed optimizations for a collection. Calls GET /collections/{collection_name}/optimizations.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /collections/{{params.collection_name}}/optimizations.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection
completed_limitintegernoMaximum number of completed optimizations to return. Ignored if completed is not in the with parameter. Defaults to 16.
withstringnoComma-separated list of optional fields to include in the response. Possible values: queued, completed, idle_segments.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobjectOptimizations progress for the collection
result.completedarrayCompleted optimizations. Requires ?with=completed. Limited by ?completed_limit=N.
result.idle_segmentsarraySegments that don't require optimization. Requires ?with=idle_segments.
result.queuedarrayAn estimated queue of pending optimizations. Requires ?with=queued.
result.runningarrayCurrently running optimizations.
result.summaryobject
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "how far along is indexing", "progress of segment merges for a collection", "which optimizers have finished".

qdrant.get_points

Get several Qdrant points by id: the vectors and metadata for a list of record ids in one call. Calls POST /collections/{collection_name}/points.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to retrieve from
consistencyinteger (uint)noDefine read consistency guarantees for the operation
idsarray of integeryesLook for points with ids
shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.
with_payloadbooleannoSelect which payload to return with the response. Default is true.
with_vectorbooleannoOptions for specifying which vector to include

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultarray of object
result[].idinteger (uint64)Type, used for specifying point ID in user interface
result[].order_valueinteger (int64)
result[].payloadobjectPayload - values assigned to the point
result[].shard_keystringShard Key
result[].vectorarrayVector of the point
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "fetch a batch of records by id", "read the vectors behind several ids", "pull back many rows at once".

qdrant.upsert_points

Write records into a Qdrant collection: load embeddings and their metadata into a vector store, inserting new ids and overwriting ids already there. Calls PUT /collections/{collection_name}/points.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /collections/{{params.collection_name}}/points.

Arguments:

ArgumentTypeRequiredNotes
batchobjectyes
batch.idsarrayyes
batch.payloadsarrayno
batch.vectorsarrayyes
collection_namestringyesName of the collection to update from
orderingstring, one of weak, medium, strongnodefine ordering guarantees for the operation
shard_keystringno
timeoutintegernoTimeout for the operation
update_filterobjectnoFilter to apply when updating existing points. Only points matching this filter will be updated. Points that don't match will keep their current state. New points will be inserted regardless of the...
update_filter.min_shouldobjectnoAt least minimum amount of given conditions should match
update_filter.mustobjectnoAll conditions must match
update_filter.must_notobjectnoAll conditions must NOT match
update_filter.shouldobjectnoAt least one of those conditions should match
update_modestring, one of upsert, insert_only, update_onlynoMode of the upsert operation: insert_only, upsert (default), update_only
waitbooleannoIf true, wait for changes to actually happen

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.operation_idinteger (uint64)Sequential number of the operation
result.statusstring, one of acknowledged, completed, wait_timeoutAcknowledged - Request is saved to WAL and will be process in a queue. Completed - Request is completed, changes are actual. WaitTimeout - Request is waiting for timeout.
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "load embeddings into a store", "write vectors and their metadata", "add or overwrite rows by id".

qdrant.batch_update

Batch update points. Apply a series of update operations for points, vectors and payloads. Calls POST /collections/{collection_name}/points/batch.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/batch.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to apply operations on
operationsarray of objectyes
operations[].upsertobjectyes
orderingstring, one of weak, medium, strongnodefine ordering guarantees for the operation
timeoutintegernoTimeout for the operation
waitbooleannoIf true, wait for changes to actually happen

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultarray of object
result[].operation_idinteger (uint64)Sequential number of the operation
result[].statusstring, one of acknowledged, completed, wait_timeoutAcknowledged - Request is saved to WAL and will be process in a queue. Completed - Request is completed, changes are actual. WaitTimeout - Request is waiting for timeout.
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "apply several point operations in one call", "insert, delete and set payload together", "run a list of vector changes at once".

qdrant.count_points

Count the records in a Qdrant collection: how many points a vector store holds, either all of them or only those a filter selects. Calls POST /collections/{collection_name}/points/count.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/count.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to count in
consistencyinteger (uint)noDefine read consistency guarantees for the operation
exactbooleannoIf true, count exact number of points. If false, count approximate number of points faster. Approximate count might be unreliable during the indexing process. Default: true. Defaults to true.
filterobjectnoLook only for points which satisfies this conditions
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.countinteger (uint)Number of points which satisfy the conditions
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "how many records does a store hold", "total rows that match a filter", "size of a vector store in records".

qdrant.delete_points

Delete records from a Qdrant collection: drop the embeddings and metadata for a list of ids, or for everything a filter selects. Calls POST /collections/{collection_name}/points/delete.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/delete.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to delete from
orderingstring, one of weak, medium, strongnodefine ordering guarantees for the operation
pointsarray of integeryes
shard_keystringno
timeoutintegernoTimeout for the operation
waitbooleannoIf true, wait for changes to actually happen

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.operation_idinteger (uint64)Sequential number of the operation
result.statusstring, one of acknowledged, completed, wait_timeoutAcknowledged - Request is saved to WAL and will be process in a queue. Completed - Request is completed, changes are actual. WaitTimeout - Request is waiting for timeout.
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "drop the vectors for these ids", "remove records that match a filter", "take rows out of a store".

qdrant.discover_points

Discover points. Use context and a target to find the most similar points to the target, constrained by the context. Calls POST /collections/{collection_name}/points/discover.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/discover.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to search in
consistencyinteger (uint)noDefine read consistency guarantees for the operation
contextarray of objectnoPairs of { positive, negative } examples to constrain the search. When using only the context (without a target), a special search - called context search - is performed where pairs of points are...
context[].negativeinteger (uint64)yesType, used for specifying point ID in user interface
context[].positiveinteger (uint64)yesType, used for specifying point ID in user interface
filterobjectnoLook only for points which satisfies this conditions
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
limitinteger (uint)yesMax number of result to return
lookup_fromobjectnoThe location used to lookup vectors. If not specified - use current collection. Note: the other collection should have the same vector size as the current collection
lookup_from.collectionstringyesName of the collection used for lookup
lookup_from.shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
lookup_from.vectorstringnoOptional name of the vector field within the collection. If not provided, the default vector field will be used.
offsetinteger (uint)noOffset of the first result to return. May be used to paginate results. Note: large offset values may cause performance issues.
paramsobjectnoAdditional search params
params.acornobjectnoACORN search params
params.exactbooleannoSearch without approximation. If set to true, search may run long but with exact results. Defaults to false.
params.hnsw_efinteger (uint)noParams relevant to HNSW index Size of the beam in a beam-search. Larger the value - more accurate the result, more time required for search.
params.indexed_onlybooleannoIf enabled, the engine will only perform search among indexed or small segments. Using this option prevents slow searches in case of delayed index, but does not guarantee that all uploaded vectors... Defaults to false.
params.quantizationobjectnoQuantization params
shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
targetinteger (uint64)noLook for vectors closest to this. When using the target (with or without context), the integer part of the score represents the rank with respect to the context, while the decimal part of the score...
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.
usingstringnoDefine which vector to use for recommendation, if not specified - try to use default vector
with_payloadbooleannoSelect which payload to return with the response. Default is false.
with_vectorbooleannoOptions for specifying which vectors to include into response. Default is false.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultarray of object
result[].idinteger (uint64)Type, used for specifying point ID in user interface
result[].order_valueinteger (int64)Order-by value
result[].payloadobjectPayload - values assigned to the point
result[].scorenumber (float)Points vector distance to the query vector
result[].shard_keystringShard Key
result[].vectorarrayVector of the point
result[].versioninteger (uint64)Point version
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "add points", "set up points", "start points".

qdrant.discover_batch_points

Discover batch points. Look for points based on target and/or positive and negative example pairs, in batch. Calls POST /collections/{collection_name}/points/discover/batch.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/discover/batch.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to search in
consistencyinteger (uint)noDefine read consistency guarantees for the operation
searchesarray of objectyes
searches[].contextarraynoPairs of { positive, negative } examples to constrain the search. When using only the context (without a target), a special search - called context search - is performed where pairs of points are...
searches[].filterobjectnoLook only for points which satisfies this conditions
searches[].limitinteger (uint)yesMax number of result to return
searches[].lookup_fromobjectnoThe location used to lookup vectors. If not specified - use current collection. Note: the other collection should have the same vector size as the current collection
searches[].offsetinteger (uint)noOffset of the first result to return. May be used to paginate results. Note: large offset values may cause performance issues.
searches[].paramsobjectnoAdditional search params
searches[].shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
searches[].targetinteger (uint64)noLook for vectors closest to this. When using the target (with or without context), the integer part of the score represents the rank with respect to the context, while the decimal part of the score...
searches[].usingstringnoDefine which vector to use for recommendation, if not specified - try to use default vector
searches[].with_payloadbooleannoSelect which payload to return with the response. Default is false.
searches[].with_vectorbooleannoOptions for specifying which vectors to include into response. Default is false.
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultarray of array
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "run several context searches at once", "positive and negative examples in one call", "batched discovery over target pairs".

qdrant.set_payload

Set metadata on Qdrant records: attach or overwrite payload fields, tags, and attributes on the points an id list or filter selects. Calls POST /collections/{collection_name}/points/payload.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/payload.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to set from
filterobjectnoAssigns payload to each point that satisfy this filter condition
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
keystringnoAssigns payload to each point that satisfy this path of property
orderingstring, one of weak, medium, strongnodefine ordering guarantees for the operation
payloadobjectyes
pointsarray of integernoAssigns payload to each point in this list
shard_keystringno
timeoutintegernoTimeout for the operation
waitbooleannoIf true, wait for changes to actually happen

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.operation_idinteger (uint64)Sequential number of the operation
result.statusstring, one of acknowledged, completed, wait_timeoutAcknowledged - Request is saved to WAL and will be process in a queue. Completed - Request is completed, changes are actual. WaitTimeout - Request is waiting for timeout.
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "tag records with metadata", "attach attributes to stored rows", "write a field onto these records".

qdrant.overwrite_payload

Overwrite payload. Replace full payload of points with new one. Calls PUT /collections/{collection_name}/points/payload.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /collections/{{params.collection_name}}/points/payload.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to set from
filterobjectnoAssigns payload to each point that satisfy this filter condition
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
keystringnoAssigns payload to each point that satisfy this path of property
orderingstring, one of weak, medium, strongnodefine ordering guarantees for the operation
payloadobjectyes
pointsarray of integernoAssigns payload to each point in this list
shard_keystringno
timeoutintegernoTimeout for the operation
waitbooleannoIf true, wait for changes to actually happen

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.operation_idinteger (uint64)Sequential number of the operation
result.statusstring, one of acknowledged, completed, wait_timeoutAcknowledged - Request is saved to WAL and will be process in a queue. Completed - Request is completed, changes are actual. WaitTimeout - Request is waiting for timeout.
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "replace payload", "overwrite payload", "swap out payload".

qdrant.clear_payload

Clear payload. Remove all payload for specified points. Calls POST /collections/{collection_name}/points/payload/clear.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/payload/clear.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to clear payload from
orderingstring, one of weak, medium, strongnodefine ordering guarantees for the operation
pointsarray of integeryes
shard_keystringno
timeoutintegernoTimeout for the operation
waitbooleannoIf true, wait for changes to actually happen

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.operation_idinteger (uint64)Sequential number of the operation
result.statusstring, one of acknowledged, completed, wait_timeoutAcknowledged - Request is saved to WAL and will be process in a queue. Completed - Request is completed, changes are actual. WaitTimeout - Request is waiting for timeout.
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "add payload", "set up payload", "start payload".

qdrant.delete_payload

Delete payload. Delete specified key payload for points. Calls POST /collections/{collection_name}/points/payload/delete.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/payload/delete.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to delete from
filterobjectnoDeletes values from points that satisfy this filter condition
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
keysarray of stringyesList of payload keys to remove from payload
orderingstring, one of weak, medium, strongnodefine ordering guarantees for the operation
pointsarray of integernoDeletes values from each point in this list
shard_keystringno
timeoutintegernoTimeout for the operation
waitbooleannoIf true, wait for changes to actually happen

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.operation_idinteger (uint64)Sequential number of the operation
result.statusstring, one of acknowledged, completed, wait_timeoutAcknowledged - Request is saved to WAL and will be process in a queue. Completed - Request is completed, changes are actual. WaitTimeout - Request is waiting for timeout.
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "get rid of payload", "take down payload", "clear out payload".

qdrant.query_points

Query a Qdrant collection: the general entry point that returns the closest matches to a vector, an id, or a set of examples, with filters, ordering, and grouping. Calls POST /collections/{collection_name}/points/query.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/query.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to query
consistencyinteger (uint)noDefine read consistency guarantees for the operation
filterobjectnoFilter conditions - return only those points that satisfy the specified conditions.
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
limitinteger (uint)noMax number of points to return. Default is 10.
lookup_fromobjectnoThe location to use for IDs lookup, if not specified - use the current collection and the 'using' vector Note: the other collection vectors should have the same vector size as the 'using' vector in...
lookup_from.collectionstringyesName of the collection used for lookup
lookup_from.shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
lookup_from.vectorstringnoOptional name of the vector field within the collection. If not provided, the default vector field will be used.
offsetinteger (uint)noOffset of the result. Skip this many points. Default is 0
paramsobjectnoSearch params for when there is no prefetch
params.acornobjectnoACORN search params
params.exactbooleannoSearch without approximation. If set to true, search may run long but with exact results. Defaults to false.
params.hnsw_efinteger (uint)noParams relevant to HNSW index Size of the beam in a beam-search. Larger the value - more accurate the result, more time required for search.
params.indexed_onlybooleannoIf enabled, the engine will only perform search among indexed or small segments. Using this option prevents slow searches in case of delayed index, but does not guarantee that all uploaded vectors... Defaults to false.
params.quantizationobjectnoQuantization params
prefetchobjectnoSub-requests to perform first. If present, the query will be performed on the results of the prefetch(es).
prefetch.filterobjectnoFilter conditions - return only those points that satisfy the specified conditions.
prefetch.limitinteger (uint)noMax number of points to return. Default is 10.
prefetch.lookup_fromobjectnoThe location to use for IDs lookup, if not specified - use the current collection and the 'using' vector Note: the other collection vectors should have the same vector size as the 'using' vector in...
prefetch.paramsobjectnoSearch params for when there is no prefetch
prefetch.prefetchobjectnoSub-requests to perform first. If present, the query will be performed on the results of the prefetches.
prefetch.queryarraynoQuery to perform. If missing without prefetches, returns points ordered by their IDs.
prefetch.score_thresholdnumber (float)noReturn points with scores better than this threshold.
prefetch.usingstringnoDefine which vector name to use for querying. If missing, the default vector is used.
queryarray of numbernoQuery to perform. If missing without prefetches, returns points ordered by their IDs.
score_thresholdnumber (float)noReturn points with scores better than this threshold.
shard_keystringno
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.
usingstringnoDefine which vector name to use for querying. If missing, the default vector is used.
with_payloadbooleannoOptions for specifying which payload to include or not. Default is false.
with_vectorbooleannoOptions for specifying which vectors to include into the response. Default is false.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.pointsarray
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "closest matches for a vector", "rank a store by similarity with filters", "the general similarity query".

qdrant.query_batch_points

Query points in batch. Universally query points in batch. Calls POST /collections/{collection_name}/points/query/batch.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/query/batch.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to query
consistencyinteger (uint)noDefine read consistency guarantees for the operation
searchesarray of objectyes
searches[].filterobjectnoFilter conditions - return only those points that satisfy the specified conditions.
searches[].limitinteger (uint)noMax number of points to return. Default is 10.
searches[].lookup_fromobjectnoThe location to use for IDs lookup, if not specified - use the current collection and the 'using' vector Note: the other collection vectors should have the same vector size as the 'using' vector in...
searches[].offsetinteger (uint)noOffset of the result. Skip this many points. Default is 0
searches[].paramsobjectnoSearch params for when there is no prefetch
searches[].prefetchobjectnoSub-requests to perform first. If present, the query will be performed on the results of the prefetch(es).
searches[].queryarraynoQuery to perform. If missing without prefetches, returns points ordered by their IDs.
searches[].score_thresholdnumber (float)noReturn points with scores better than this threshold.
searches[].shard_keystringno
searches[].usingstringnoDefine which vector name to use for querying. If missing, the default vector is used.
searches[].with_payloadbooleannoOptions for specifying which payload to include or not. Default is false.
searches[].with_vectorbooleannoOptions for specifying which vectors to include into the response. Default is false.
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultarray of object
result[].pointsarray
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "run several searches in one request", "many vector lookups at once", "batched queries over an index".

qdrant.query_points_groups

Query points, grouped by a given payload field. Universally query points, grouped by a given payload field. Calls POST /collections/{collection_name}/points/query/groups.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/query/groups.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to query
consistencyinteger (uint)noDefine read consistency guarantees for the operation
filterobjectnoFilter conditions - return only those points that satisfy the specified conditions.
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
group_bystringyesPayload field to group by, must be a string or number field. If the field contains more than 1 value, all values will be used for grouping. One point can be in multiple groups.
group_sizeinteger (uint)noMaximum amount of points to return per group. Default is 3.
limitinteger (uint)noMaximum amount of groups to return. Default is 10.
lookup_fromobjectnoThe location to use for IDs lookup, if not specified - use the current collection and the 'using' vector Note: the other collection vectors should have the same vector size as the 'using' vector in...
lookup_from.collectionstringyesName of the collection used for lookup
lookup_from.shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
lookup_from.vectorstringnoOptional name of the vector field within the collection. If not provided, the default vector field will be used.
paramsobjectnoSearch params for when there is no prefetch
params.acornobjectnoACORN search params
params.exactbooleannoSearch without approximation. If set to true, search may run long but with exact results. Defaults to false.
params.hnsw_efinteger (uint)noParams relevant to HNSW index Size of the beam in a beam-search. Larger the value - more accurate the result, more time required for search.
params.indexed_onlybooleannoIf enabled, the engine will only perform search among indexed or small segments. Using this option prevents slow searches in case of delayed index, but does not guarantee that all uploaded vectors... Defaults to false.
params.quantizationobjectnoQuantization params
prefetchobjectnoSub-requests to perform first. If present, the query will be performed on the results of the prefetch(es).
prefetch.filterobjectnoFilter conditions - return only those points that satisfy the specified conditions.
prefetch.limitinteger (uint)noMax number of points to return. Default is 10.
prefetch.lookup_fromobjectnoThe location to use for IDs lookup, if not specified - use the current collection and the 'using' vector Note: the other collection vectors should have the same vector size as the 'using' vector in...
prefetch.paramsobjectnoSearch params for when there is no prefetch
prefetch.prefetchobjectnoSub-requests to perform first. If present, the query will be performed on the results of the prefetches.
prefetch.queryarraynoQuery to perform. If missing without prefetches, returns points ordered by their IDs.
prefetch.score_thresholdnumber (float)noReturn points with scores better than this threshold.
prefetch.usingstringnoDefine which vector name to use for querying. If missing, the default vector is used.
queryarray of numbernoQuery to perform. If missing without prefetches, returns points ordered by their IDs.
score_thresholdnumber (float)noReturn points with scores better than this threshold.
shard_keystringno
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.
usingstringnoDefine which vector name to use for querying. If missing, the default vector is used.
with_lookupstringnoLook for points in another collection using the group ids
with_payloadbooleannoOptions for specifying which payload to include or not. Default is false.
with_vectorbooleannoOptions for specifying which vectors to include into the response. Default is false.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.groupsarray
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "search and group hits by a payload field", "best matches per category", "top results collapsed by one key".

qdrant.recommend_points

Recommend records from a Qdrant collection: find points like the positive examples given and unlike the negative ones, which is the more-like-this suggestion path. Calls POST /collections/{collection_name}/points/recommend.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/recommend.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to search in
consistencyinteger (uint)noDefine read consistency guarantees for the operation
filterobjectnoLook only for points which satisfies this conditions
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
limitinteger (uint)yesMax number of result to return
lookup_fromobjectnoThe location used to lookup vectors. If not specified - use current collection. Note: the other collection should have the same vector size as the current collection
lookup_from.collectionstringyesName of the collection used for lookup
lookup_from.shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
lookup_from.vectorstringnoOptional name of the vector field within the collection. If not provided, the default vector field will be used.
negativearray of integernoTry to avoid vectors like this. Defaults to [].
offsetinteger (uint)noOffset of the first result to return. May be used to paginate results. Note: large offset values may cause performance issues.
paramsobjectnoAdditional search params
params.acornobjectnoACORN search params
params.exactbooleannoSearch without approximation. If set to true, search may run long but with exact results. Defaults to false.
params.hnsw_efinteger (uint)noParams relevant to HNSW index Size of the beam in a beam-search. Larger the value - more accurate the result, more time required for search.
params.indexed_onlybooleannoIf enabled, the engine will only perform search among indexed or small segments. Using this option prevents slow searches in case of delayed index, but does not guarantee that all uploaded vectors... Defaults to false.
params.quantizationobjectnoQuantization params
positivearray of integernoLook for vectors closest to those. Defaults to [].
score_thresholdnumber (float)noDefine a minimal score threshold for the result. If defined, less similar results will not be returned. Score of the returned result might be higher or smaller than the threshold depending on the...
shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
strategystring, one of average_vector, best_score, sum_scoresnoHow to use positive and negative examples to find the results
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.
usingstringnoDefine which vector to use for recommendation, if not specified - try to use default vector
with_payloadbooleannoSelect which payload to return with the response. Default is false.
with_vectorbooleannoOptions for specifying which vectors to include into response. Default is false.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultarray of object
result[].idinteger (uint64)Type, used for specifying point ID in user interface
result[].order_valueinteger (int64)Order-by value
result[].payloadobjectPayload - values assigned to the point
result[].scorenumber (float)Points vector distance to the query vector
result[].shard_keystringShard Key
result[].vectorarrayVector of the point
result[].versioninteger (uint64)Point version
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "more like these examples", "suggestions from good and bad examples", "records resembling the ones I picked".

qdrant.recommend_batch_points

Recommend batch points. Look for the points which are closer to stored positive examples and at the same time further to negative examples. Calls POST /collections/{collection_name}/points/recommend/batch.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/recommend/batch.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to search in
consistencyinteger (uint)noDefine read consistency guarantees for the operation
searchesarray of objectyes
searches[].filterobjectnoLook only for points which satisfies this conditions
searches[].limitinteger (uint)yesMax number of result to return
searches[].lookup_fromobjectnoThe location used to lookup vectors. If not specified - use current collection. Note: the other collection should have the same vector size as the current collection
searches[].negativearraynoTry to avoid vectors like this. Defaults to [].
searches[].offsetinteger (uint)noOffset of the first result to return. May be used to paginate results. Note: large offset values may cause performance issues.
searches[].paramsobjectnoAdditional search params
searches[].positivearraynoLook for vectors closest to those. Defaults to [].
searches[].score_thresholdnumber (float)noDefine a minimal score threshold for the result. If defined, less similar results will not be returned. Score of the returned result might be higher or smaller than the threshold depending on the...
searches[].shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
searches[].strategystring, one of average_vector, best_score, sum_scoresnoHow to use positive and negative examples to find the results
searches[].usingstringnoDefine which vector to use for recommendation, if not specified - try to use default vector
searches[].with_payloadbooleannoSelect which payload to return with the response. Default is false.
searches[].with_vectorbooleannoOptions for specifying which vectors to include into response. Default is false.
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultarray of array
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "several recommendation requests together", "many liked-and-disliked lookups at once", "batched suggestions from example ids".

qdrant.recommend_point_groups

Recommend point groups. Look for the points which are closer to stored positive examples and at the same time further to negative examples, grouped by a given payload field. Calls POST /collections/{collection_name}/points/recommend/groups.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/recommend/groups.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to search in
consistencyinteger (uint)noDefine read consistency guarantees for the operation
filterobjectnoLook only for points which satisfies this conditions
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
group_bystringyesPayload field to group by, must be a string or number field. If the field contains more than 1 value, all values will be used for grouping. One point can be in multiple groups.
group_sizeinteger (uint32)yesMaximum amount of points to return per group
limitinteger (uint32)yesMaximum amount of groups to return
lookup_fromobjectnoThe location used to lookup vectors. If not specified - use current collection. Note: the other collection should have the same vector size as the current collection
lookup_from.collectionstringyesName of the collection used for lookup
lookup_from.shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
lookup_from.vectorstringnoOptional name of the vector field within the collection. If not provided, the default vector field will be used.
negativearray of integernoTry to avoid vectors like this. Defaults to [].
paramsobjectnoAdditional search params
params.acornobjectnoACORN search params
params.exactbooleannoSearch without approximation. If set to true, search may run long but with exact results. Defaults to false.
params.hnsw_efinteger (uint)noParams relevant to HNSW index Size of the beam in a beam-search. Larger the value - more accurate the result, more time required for search.
params.indexed_onlybooleannoIf enabled, the engine will only perform search among indexed or small segments. Using this option prevents slow searches in case of delayed index, but does not guarantee that all uploaded vectors... Defaults to false.
params.quantizationobjectnoQuantization params
positivearray of integernoLook for vectors closest to those. Defaults to [].
score_thresholdnumber (float)noDefine a minimal score threshold for the result. If defined, less similar results will not be returned. Score of the returned result might be higher or smaller than the threshold depending on the...
shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
strategystring, one of average_vector, best_score, sum_scoresnoHow to use positive and negative examples to find the results
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.
usingstringnoDefine which vector to use for recommendation, if not specified - try to use default vector
with_lookupstringnoLook for points in another collection using the group ids
with_payloadbooleannoSelect which payload to return with the response. Default is false.
with_vectorbooleannoOptions for specifying which vectors to include into response. Default is false.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.groupsarray
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "suggestions grouped by a payload field", "recommendations collapsed per category", "best matches to examples, one per key".

qdrant.scroll_points

Page through a Qdrant collection: walk every record in a vector store one batch at a time, optionally filtered, with no similarity ranking involved. Calls POST /collections/{collection_name}/points/scroll.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/scroll.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to retrieve from
consistencyinteger (uint)noDefine read consistency guarantees for the operation
filterobjectnoLook only for points which satisfies this conditions. If not provided - all points.
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
limitinteger (uint)noPage size. Default: 10
offsetinteger (uint64)noStart ID to read points from.
order_bystringnoOrder the records by a payload field.
shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.
with_payloadbooleannoSelect which payload to return with the response. Default is true.
with_vectorbooleannoOptions for specifying which vector to include

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobjectResult of the points read request
result.next_page_offsetinteger (uint64)Offset which should be used to retrieve a next page result
result.pointsarrayList of retrieved points
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "page through every record", "walk a store batch by batch", "iterate all rows with a cursor".

qdrant.search_points

Search a Qdrant collection by vector similarity: the nearest neighbours to an embedding, ranked by distance and narrowed by a metadata filter. Calls POST /collections/{collection_name}/points/search.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/search.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to search in
consistencyinteger (uint)noDefine read consistency guarantees for the operation
filterobjectnoLook only for points which satisfies this conditions
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
limitinteger (uint)yesMax number of result to return
offsetinteger (uint)noOffset of the first result to return. May be used to paginate results. Note: large offset values may cause performance issues.
paramsobjectnoAdditional search params
params.acornobjectnoACORN search params
params.exactbooleannoSearch without approximation. If set to true, search may run long but with exact results. Defaults to false.
params.hnsw_efinteger (uint)noParams relevant to HNSW index Size of the beam in a beam-search. Larger the value - more accurate the result, more time required for search.
params.indexed_onlybooleannoIf enabled, the engine will only perform search among indexed or small segments. Using this option prevents slow searches in case of delayed index, but does not guarantee that all uploaded vectors... Defaults to false.
params.quantizationobjectnoQuantization params
score_thresholdnumber (float)noDefine a minimal score threshold for the result. If defined, less similar results will not be returned. Score of the returned result might be higher or smaller than the threshold depending on the...
shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.
vectorarray of numberyesVector data separator for named and unnamed modes Unnamed mode: { "vector": [1.0, 2.0, 3.0] } or named mode: { "vector": { "vector": [1.0, 2.0, 3.0], "name": "image-embeddings" } }
with_payloadbooleannoSelect which payload to return with the response. Default is false.
with_vectorbooleannoOptions for specifying which vectors to include into response. Default is false.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultarray of object
result[].idinteger (uint64)Type, used for specifying point ID in user interface
result[].order_valueinteger (int64)Order-by value
result[].payloadobjectPayload - values assigned to the point
result[].scorenumber (float)Points vector distance to the query vector
result[].shard_keystringShard Key
result[].vectorarrayVector of the point
result[].versioninteger (uint64)Point version
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "nearest neighbours of an embedding", "which stored vectors are most alike", "similarity lookup with a metadata filter".

qdrant.search_batch_points

Search batch points. Retrieve by batch the closest points based on vector similarity and given filtering conditions. Calls POST /collections/{collection_name}/points/search/batch.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/search/batch.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to search in
consistencyinteger (uint)noDefine read consistency guarantees for the operation
searchesarray of objectyes
searches[].filterobjectnoLook only for points which satisfies this conditions
searches[].limitinteger (uint)yesMax number of result to return
searches[].offsetinteger (uint)noOffset of the first result to return. May be used to paginate results. Note: large offset values may cause performance issues.
searches[].paramsobjectnoAdditional search params
searches[].score_thresholdnumber (float)noDefine a minimal score threshold for the result. If defined, less similar results will not be returned. Score of the returned result might be higher or smaller than the threshold depending on the...
searches[].shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
searches[].vectorarrayyesVector data separator for named and unnamed modes Unnamed mode: { "vector": [1.0, 2.0, 3.0] } or named mode: { "vector": { "vector": [1.0, 2.0, 3.0], "name": "image-embeddings" } }
searches[].with_payloadbooleannoSelect which payload to return with the response. Default is false.
searches[].with_vectorbooleannoOptions for specifying which vectors to include into response. Default is false.
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultarray of array
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "several nearest-neighbour queries at once", "many similarity lookups in one request", "batched vector search with filters".

qdrant.search_point_groups

Search point groups. Retrieve closest points based on vector similarity and given filtering conditions, grouped by a given payload field. Calls POST /collections/{collection_name}/points/search/groups.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/search/groups.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to search in
consistencyinteger (uint)noDefine read consistency guarantees for the operation
filterobjectnoLook only for points which satisfies this conditions
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
group_bystringyesPayload field to group by, must be a string or number field. If the field contains more than 1 value, all values will be used for grouping. One point can be in multiple groups.
group_sizeinteger (uint32)yesMaximum amount of points to return per group
limitinteger (uint32)yesMaximum amount of groups to return
paramsobjectnoAdditional search params
params.acornobjectnoACORN search params
params.exactbooleannoSearch without approximation. If set to true, search may run long but with exact results. Defaults to false.
params.hnsw_efinteger (uint)noParams relevant to HNSW index Size of the beam in a beam-search. Larger the value - more accurate the result, more time required for search.
params.indexed_onlybooleannoIf enabled, the engine will only perform search among indexed or small segments. Using this option prevents slow searches in case of delayed index, but does not guarantee that all uploaded vectors... Defaults to false.
params.quantizationobjectnoQuantization params
score_thresholdnumber (float)noDefine a minimal score threshold for the result. If defined, less similar results will not be returned. Score of the returned result might be higher or smaller than the threshold depending on the...
shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.
vectorarray of numberyesVector data separator for named and unnamed modes Unnamed mode: { "vector": [1.0, 2.0, 3.0] } or named mode: { "vector": { "vector": [1.0, 2.0, 3.0], "name": "image-embeddings" } }
with_lookupstringnoLook for points in another collection using the group ids
with_payloadbooleannoSelect which payload to return with the response. Default is false.
with_vectorbooleannoOptions for specifying which vectors to include into response. Default is false.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.groupsarray
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "nearest matches grouped by a payload field", "one best hit per category", "similarity results collapsed by key".

qdrant.search_matrix_offsets

Search points matrix distance offsets. Compute distance matrix for sampled points with an offset based output format. Calls POST /collections/{collection_name}/points/search/matrix/offsets.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/search/matrix/offsets.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to search in
consistencyinteger (uint)noDefine read consistency guarantees for the operation
filterobjectnoLook only for points which satisfies this conditions
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
limitinteger (uint)noHow many neighbours per sample to find. Default is 3.
sampleinteger (uint)noHow many points to select and search within. Default is 10.
shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.
usingstringnoDefine which vector name to use for querying. If missing, the default vector is used.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.idsarrayIds of the points in order
result.offsets_colarrayColumn indices of the matrix
result.offsets_rowarrayRow indices of the matrix
result.scoresarrayScores associated with matrix coordinates
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "pairwise distances in offset form", "a similarity matrix over sampled points", "how close sampled records are, indexed by position".

qdrant.search_matrix_pairs

Search points matrix distance pairs. Compute distance matrix for sampled points with a pair based output format. Calls POST /collections/{collection_name}/points/search/matrix/pairs.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/search/matrix/pairs.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to search in
consistencyinteger (uint)noDefine read consistency guarantees for the operation
filterobjectnoLook only for points which satisfies this conditions
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
limitinteger (uint)noHow many neighbours per sample to find. Default is 3.
sampleinteger (uint)noHow many points to select and search within. Default is 10.
shard_keystringnoSpecify in which shards to look for the points, if not specified - look in all shards
timeoutintegernoIf set, overrides global timeout for this request. Unit is seconds.
usingstringnoDefine which vector name to use for querying. If missing, the default vector is used.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.pairsarrayList of pairs of points with scores
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "pairwise distances as explicit id pairs", "a similarity matrix listed pair by pair", "how close sampled records are, keyed by both ids".

qdrant.update_vectors

Update vectors. Update specified named vectors on points, keep unspecified vectors intact. Calls PUT /collections/{collection_name}/points/vectors.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /collections/{{params.collection_name}}/points/vectors.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to update from
orderingstring, one of weak, medium, strongnodefine ordering guarantees for the operation
pointsarray of objectyesPoints with named vectors
points[].idinteger (uint64)yesType, used for specifying point ID in user interface
points[].vectorarrayyesFull vector data per point separator with single and multiple vector modes
shard_keystringno
timeoutintegernoTimeout for the operation
update_filterobjectno
update_filter.min_shouldobjectnoAt least minimum amount of given conditions should match
update_filter.mustobjectnoAll conditions must match
update_filter.must_notobjectnoAll conditions must NOT match
update_filter.shouldobjectnoAt least one of those conditions should match
waitbooleannoIf true, wait for changes to actually happen

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.operation_idinteger (uint64)Sequential number of the operation
result.statusstring, one of acknowledged, completed, wait_timeoutAcknowledged - Request is saved to WAL and will be process in a queue. Completed - Request is completed, changes are actual. WaitTimeout - Request is waiting for timeout.
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "change vectors", "edit vectors", "adjust vectors".

qdrant.delete_vectors

Delete vectors. Delete named vectors from the given points. Calls POST /collections/{collection_name}/points/vectors/delete.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/points/vectors/delete.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to delete from
filterobjectnoDeletes values from points that satisfy this filter condition
filter.min_shouldobjectnoAt least minimum amount of given conditions should match
filter.mustobjectnoAll conditions must match
filter.must_notobjectnoAll conditions must NOT match
filter.shouldobjectnoAt least one of those conditions should match
orderingstring, one of weak, medium, strongnodefine ordering guarantees for the operation
pointsarray of integernoDeletes values from each point in this list
shard_keystringno
timeoutintegernoTimeout for the operation
vectorarray of stringyesVector names
waitbooleannoIf true, wait for changes to actually happen

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.operation_idinteger (uint64)Sequential number of the operation
result.statusstring, one of acknowledged, completed, wait_timeoutAcknowledged - Request is saved to WAL and will be process in a queue. Completed - Request is completed, changes are actual. WaitTimeout - Request is waiting for timeout.
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "get rid of vectors", "take down vectors", "clear out vectors".

qdrant.get_point

Get one Qdrant point by id: the vector and the metadata of a single stored record. Calls GET /collections/{collection_name}/points/{id}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /collections/{{params.collection_name}}/points/{{params.id}}.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to retrieve from
consistencyinteger (uint)noDefine read consistency guarantees for the operation
idinteger (uint64)yesId of the point

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobjectPoint data
result.idinteger (uint64)Type, used for specifying point ID in user interface
result.order_valueinteger (int64)
result.payloadobjectPayload - values assigned to the point
result.shard_keystringShard Key
result.vectorarrayVector of the point
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "fetch one record by its id", "read a single stored vector", "show one row out of the store".

qdrant.list_shard_keys

List shard keys. Calls GET /collections/{collection_name}/shards.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /collections/{{params.collection_name}}/shards.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to list shard keys for

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.shard_keysarrayThe existing shard keys. Only available when sharding method is custom
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "show me all shard keys", "what are the shard keys", "give me every shard keys".

qdrant.create_shard_key

Create shard key. Calls PUT /collections/{collection_name}/shards.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /collections/{{params.collection_name}}/shards.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to create shards for
initial_statestring, one of Active, Dead, Partial, Initializing, Listener, PartialSnapshot, Recovery, Resharding, ReshardingScaleDown, ActiveRead, ManualRecoverynoInitial state of the shards for this key If not specified, will be Initializing first and then Active Warning: do not change this unless you know what you are doing
placementarray of integernoPlacement of shards for this key List of peer ids, that can be used to place shards for this key If not specified, will be randomly placed among all peers
replication_factorinteger (uint32)noHow many replicas to create for each shard If not specified, will use the default value from config
shard_keystringyes
shards_numberinteger (uint32)noHow many shards to create for this key If not specified, will use the default value from config
timeoutintegernoWait for operation commit timeout in seconds. If timeout is reached - request will return with service error.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultboolean
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "add shard key", "set up shard key", "start shard key".

qdrant.delete_shard_key

Delete shard key. Calls POST /collections/{collection_name}/shards/delete.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/shards/delete.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection to create shards for
shard_keystringyes
timeoutintegernoWait for operation commit timeout in seconds. If timeout is reached - request will return with service error.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultboolean
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "get rid of shard key", "take down shard key", "clear out shard key".

qdrant.list_shard_snapshots

List shards snapshots for a collection. Get list of snapshots for a shard of a collection. Calls GET /collections/{collection_name}/shards/{shard_id}/snapshots.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /collections/{{params.collection_name}}/shards/{{params.shard_id}}/snapshots.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection
shard_idintegeryesId of the shard

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultarray of object
result[].checksumstring
result[].creation_timestring (partial-date-time)
result[].namestring
result[].sizeinteger (uint64)
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "backups taken of one partition", "restore points for a single shard", "which per-shard dumps exist".

qdrant.create_shard_snapshot

Create shard snapshot. Create new snapshot of a shard for a collection. Calls POST /collections/{collection_name}/shards/{shard_id}/snapshots.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/shards/{{params.shard_id}}/snapshots.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection for which to create a snapshot
shard_idintegeryesId of the shard
waitbooleannoIf true, wait for changes to actually happen. If false - let changes happen in background. Default is true.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.checksumstring
result.creation_timestring (partial-date-time)
result.namestring
result.sizeinteger (uint64)
statusstring
timenumber (float)Time spent to process this request

Also retrieved by: "back up one shard of a collection", "make a restore point for a single partition", "snapshot just part of an index".

qdrant.recover_shard_from_snapshot

Restore one shard of a Qdrant collection from a snapshot, rather than the whole store: recovery for a single shard of a sharded vector store. Calls PUT /collections/{collection_name}/shards/{shard_id}/snapshots/recover.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /collections/{{params.collection_name}}/shards/{{params.shard_id}}/snapshots/recover.

Arguments:

ArgumentTypeRequiredNotes
api_keystringnoOptional API key used when fetching the snapshot from a remote URL.
checksumstringnoOptional SHA256 checksum to verify snapshot integrity before recovery.
collection_namestringyesName of the collection
locationstring (uri)yes
prioritystring, one of no_sync, snapshot, replicanoDefines source of truth for snapshot recovery: NoSync means - restore snapshot without any additional synchronization. Snapshot means - prefer snapshot data over the current state. Replica...
shard_idintegeryesId of the shard to recover
waitbooleannoIf true, wait for changes to actually happen. If false - let changes happen in background. Default is true.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultboolean
statusstring
timenumber (float)Time spent to process this request

Also retrieved by: "restore one shard from its backup", "recover a single shard of a store", "roll back part of a sharded index".

qdrant.delete_shard_snapshot

Delete shard snapshot. Delete snapshot of a shard for a collection. Calls DELETE /collections/{collection_name}/shards/{shard_id}/snapshots/{snapshot_name}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /collections/{{params.collection_name}}/shards/{{params.shard_id}}/snapshots/{{params.snapshot_name}}.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection for which to delete a snapshot
shard_idintegeryesId of the shard
snapshot_namestringyesName of the snapshot to delete
waitbooleannoIf true, wait for changes to actually happen. If false - let changes happen in background. Default is true.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultboolean
statusstring
timenumber (float)Time spent to process this request

Also retrieved by: "remove a backup of one partition", "delete a shard-level restore point", "free space held by a per-shard dump".

qdrant.list_snapshots

List collection snapshots. Get list of snapshots for a collection. Calls GET /collections/{collection_name}/snapshots.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /collections/{{params.collection_name}}/snapshots.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultarray of object
result[].checksumstring
result[].creation_timestring (partial-date-time)
result[].namestring
result[].sizeinteger (uint64)
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "every backup of one collection", "restore points for an index", "which dumps of this data exist".

qdrant.create_snapshot

Take a snapshot of a Qdrant collection: a backup copy of one vector store, kept on the server, that a later recover call can restore from. Calls POST /collections/{collection_name}/snapshots.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /collections/{{params.collection_name}}/snapshots.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection for which to create a snapshot
waitbooleannoIf true, wait for changes to actually happen. If false - let changes happen in background. Default is true.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.checksumstring
result.creation_timestring (partial-date-time)
result.namestring
result.sizeinteger (uint64)
statusstring
timenumber (float)Time spent to process this request

Also retrieved by: "back up a vector store", "take a restore point for one store", "keep a copy I can roll back to".

qdrant.recover_from_snapshot

Restore a whole Qdrant collection from a snapshot: bring a vector store back from an earlier backup, replacing what it holds now. Calls PUT /collections/{collection_name}/snapshots/recover.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /collections/{{params.collection_name}}/snapshots/recover.

Arguments:

ArgumentTypeRequiredNotes
api_keystringnoOptional API key used when fetching the snapshot from a remote URL.
checksumstringnoOptional SHA256 checksum to verify snapshot integrity before recovery.
collection_namestringyesName of the collection
locationstring (uri)yesExamples: - URL http://localhost:8080/collections/my_collection/snapshots/my_snapshot - Local path file:///qdrant/snapshots/test_collection-2022-08-04-10-49-10.snapshot
prioritystring, one of no_sync, snapshot, replicanoDefines which data should be used as a source of truth if there are other replicas in the cluster. If set to Snapshot, the snapshot will be used as a source of truth, and the current state will be...
waitbooleannoIf true, wait for changes to actually happen. If false - let changes happen in background. Default is true.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultboolean
statusstring
timenumber (float)Time spent to process this request

Also retrieved by: "restore a store from its backup", "roll a whole index back", "bring back an earlier copy of the data".

qdrant.delete_snapshot

Delete collection snapshot. Delete snapshot for a collection. Calls DELETE /collections/{collection_name}/snapshots/{snapshot_name}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /collections/{{params.collection_name}}/snapshots/{{params.snapshot_name}}.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection for which to delete a snapshot
snapshot_namestringyesName of the snapshot to delete
waitbooleannoIf true, wait for changes to actually happen. If false - let changes happen in background. Default is true.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultboolean
statusstring
timenumber (float)Time spent to process this request

Also retrieved by: "remove a backup of one collection", "delete a restore point for an index", "free the disk a collection dump uses".

qdrant.create_vector_name

Create named vector. Create a new named vector on an existing collection. Calls PUT /collections/{collection_name}/vectors/{vector_name}.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /collections/{{params.collection_name}}/vectors/{{params.vector_name}}.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection
denseobjectyesConfiguration for creating a new dense named vector. Only includes properties that define the vector space and cannot be changed after creation. Storage type, index type, and quantization are...
dense.datatypestring, one of float32, float16, uint8, turbo4noElement storage type (Float32, Float16, Uint8, Turbo4)
dense.distancestring, one of Cosine, Euclid, Dot, ManhattanyesType of internal tags, build from payload Distance function types used to compare vectors
dense.multivector_configobjectnoConfiguration for multi-vector points (e.g., ColBERT)
dense.sizeinteger (uint)yesDimensionality of the vectors
orderingstring, one of weak, medium, strongnodefine ordering guarantees for the operation
timeoutintegernoTimeout for the operation
vector_namestringyesName of the vector to create
waitbooleannoIf true, wait for changes to actually happen

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.operation_idinteger (uint64)Sequential number of the operation
result.statusstring, one of acknowledged, completed, wait_timeoutAcknowledged - Request is saved to WAL and will be process in a queue. Completed - Request is completed, changes are actual. WaitTimeout - Request is waiting for timeout.
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "add another named vector to an index", "give a collection a second embedding field", "define one more vector slot on existing points".

qdrant.delete_vector_name

Delete named vector. Delete a named vector from a collection. Calls DELETE /collections/{collection_name}/vectors/{vector_name}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /collections/{{params.collection_name}}/vectors/{{params.vector_name}}.

Arguments:

ArgumentTypeRequiredNotes
collection_namestringyesName of the collection
orderingstring, one of weak, medium, strongnodefine ordering guarantees for the operation
timeoutintegernoTimeout for the operation
vector_namestringyesName of the vector to delete
waitbooleannoIf true, wait for changes to actually happen

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.operation_idinteger (uint64)Sequential number of the operation
result.statusstring, one of acknowledged, completed, wait_timeoutAcknowledged - Request is saved to WAL and will be process in a queue. Completed - Request is completed, changes are actual. WaitTimeout - Request is waiting for timeout.
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "drop a named vector from an index", "remove one embedding field and its data", "stop storing a second vector per point".

qdrant.get_issues

Report the problems Qdrant sees in itself: detected performance issues and configuration suggestions, such as a filter running without a payload index. Calls GET /issues.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /issues.

Takes no arguments.

Also retrieved by: "is anything misconfigured", "what slowdowns has the server noticed", "suggestions for making this faster".

qdrant.clear_issues

Clear issues. Removes all issues reported so far. Calls DELETE /issues.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /issues.

Takes no arguments.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultboolean
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "get rid of issues", "take down issues", "clear out issues".

qdrant.list_full_snapshots

List of storage snapshots. Get list of snapshots of the whole storage. Calls GET /snapshots.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /snapshots.

Takes no arguments.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultarray of object
result[].checksumstring
result[].creation_timestring (partial-date-time)
result[].namestring
result[].sizeinteger (uint64)
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "every whole-storage backup on disk", "which global restore points exist", "all dumps covering all collections".

qdrant.create_full_snapshot

Create storage snapshot. Create new snapshot of the whole storage. Calls POST /snapshots.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /snapshots.

Arguments:

ArgumentTypeRequiredNotes
waitbooleannoIf true, wait for changes to actually happen. If false - let changes happen in background. Default is true.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.checksumstring
result.creation_timestring (partial-date-time)
result.namestring
result.sizeinteger (uint64)
statusstring
timenumber (float)Time spent to process this request

Also retrieved by: "back up the entire storage", "make a restore point for every collection", "dump all data to a snapshot file".

qdrant.delete_full_snapshot

Delete storage snapshot. Delete snapshot of the whole storage. Calls DELETE /snapshots/{snapshot_name}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /snapshots/{{params.snapshot_name}}.

Arguments:

ArgumentTypeRequiredNotes
snapshot_namestringyesName of the full snapshot to delete
waitbooleannoIf true, wait for changes to actually happen. If false - let changes happen in background. Default is true.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultboolean
statusstring
timenumber (float)Time spent to process this request

Also retrieved by: "remove a whole-storage backup file", "free the disk a global restore point uses", "delete one dump of everything".

qdrant.telemetry

Collect telemetry data. Collect telemetry data including app info, system info, collections info, cluster info, configs and statistics. Calls GET /telemetry.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /telemetry.

Arguments:

ArgumentTypeRequiredNotes
anonymizebooleannoIf true, anonymize result
details_levelintegernoLevel of details in telemetry data. Minimal level is 0, maximal is infinity
per_collectionbooleannoIf true, include per-collection request statistics in the response
timeoutintegernoTimeout for this request. Defaults to 60.

Result fields (the payload is trimmed to these before it reaches the model):

FieldTypeNotes
resultobject
result.appobject
result.clusterobject
result.collectionsobject
result.hardwareobject
result.idstring
result.memoryobject
result.requestsobject
result.search_poolobjectLive snapshot of the adaptive search routing. mode is the runtime currently selected by [SearchMode]; high_cpu_threads and high_io_threads are the blocking-thread budgets of the two...
statusstring
timenumber (float)Time spent to process this request
usageobjectUsage of the hardware resources, spent to process the request
usage.hardwareobjectUsage of the hardware resources, spent to process the request
usage.inferenceobject

Also retrieved by: "internal stats for this node", "app, system and collection counters", "diagnostics about the running process".