Project: Qdrant (App Definition and Development / Database)
File: docs.md

<a name="top"></a> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - <a name="collections-proto"></a> <p

href="#top">Top</a></p> <a name="qdrant-AbortShardTransfer"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | shard_id | | | Local shard id | | frompeerid | | | | | topeerid | | | | <a name="qdrant-AliasDescription"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | alias_name | | | Name of the alias | | collection_name | | | Name of the collection | <a name="qdrant-AliasOperations"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | create_alias | | | | | rename_alias | | | | | delete_alias | | | | <a name="qdrant-BinaryQuantization"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | always_ram | | optional | If true - quantized vectors always will be stored in RAM, ignoring the config of main storage | <a name="qdrant-ChangeAliases"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | actions | | repeated | List of actions | | timeout | | optional | Wait timeout for operation commit in seconds, if not specified - default value will be supplied | <a name="qdrant-CollectionClusterInfoRequest"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | <a name="qdrant-CollectionClusterInfoResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | peer_id | | | ID of this peer | | shard_count | | | Total number of shards | | local_shards | | repeated | Local shards | | remote_shards | | repeated | Remote shards | | shard_transfers | | repeated | Shard transfers | <a name="qdrant-CollectionConfig"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | params | | | Collection parameters | | hnsw_config | | | Configuration of vector index | | optimizer_config | | | Configuration of the optimizers | | wal_config | | | Configuration of the Write-Ahead-Log | | quantization_config | | optional | Configuration of the vector quantization | <a name="qdrant-CollectionDescription"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | name | | | Name of the collection | <a name="qdrant-CollectionExists"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | exists | | | | <a name="qdrant-CollectionExistsRequest"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | | <a name="qdrant-CollectionExistsResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | | | | time | | | Time spent to process | <a name="qdrant-CollectionInfo"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | status | | | operating condition of the collection | | optimizer_status | | | status of collection optimizers | | vectors_count | | optional | Approximate number of vectors in the collection | | segments_count | | | Number of independent segments | | config | | | Configuration | | payload_schema | | repeated | Collection data types | | points_count | | optional | Approximate number of points in the collection | | indexedvectorscount | | optional | Approximate number of indexed vectors in the collection. | <a name="qdrant-CollectionInfo-PayloadSchemaEntry"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | | | value | | | | <a name="qdrant-CollectionOperationResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | | if operation made changes | | time | | | Time spent to process | <a name="qdrant-CollectionParams"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | shard_number | | | Number of shards in collection | | ondiskpayload | | | If true - point&#39;s payload will not be stored in memory | | vectors_config | | optional | Configuration for vectors | | replication_factor | | optional | Number of replicas of each shard that network tries to maintain | | writeconsistencyfactor | | optional | How many replicas should apply the operation for us to consider it successful | | readfanout_factor | | optional | Fan-out every read request to these many additional remote nodes (and return first available response) | | sharding_method | | optional | Sharding method | | sparsevectorsconfig | | optional | Configuration for sparse vectors | <a name="qdrant-CollectionParamsDiff"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | replication_factor | | optional | Number of replicas of each shard that network tries to maintain | | writeconsistencyfactor | | optional | How many replicas should apply the operation for us to consider it successful | | ondiskpayload | | optional | If true - point&#39;s payload will not be stored in memory | | readfanout_factor | | optional | Fan-out every read request to these many additional remote nodes (and return first available response) | <a name="qdrant-CreateAlias"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | | alias_name | | | New name of the alias | <a name="qdrant-CreateCollection"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | | hnsw_config | | optional | Configuration of vector index | | wal_config | | optional | Configuration of the Write-Ahead-Log | | optimizers_config | | optional | Configuration of the optimizers | | shard_number | | optional | Number of shards in the collection, default is 1 for standalone, otherwise equal to the number of

Minimum is 1 | | ondiskpayload | | optional | If true - point&#39;s payload will not be stored in memory | | timeout | | optional | Wait timeout for operation commit in seconds, if not specified - default value will be supplied | | vectors_config | | optional | Configuration for vectors | | replication_factor | | optional | Number of replicas of each shard that network tries to maintain, default = 1 | | writeconsistencyfactor | | optional | How many replicas should apply the operation for us to consider it successful, default = 1 | | initfromcollection | | optional | Specify name of the other collection to copy data from | | quantization_config | | optional | Quantization configuration of vector | | sharding_method | | optional | Sharding method | | sparsevectorsconfig | | optional | Configuration for sparse vectors | <a name="qdrant-CreateShardKey"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | shard_key | | | User-defined shard key | | shards_number | | optional | Number of shards to create per shard key | | replication_factor | | optional | Number of replicas of each shard to create | | placement | | repeated | List of peer ids, allowed to create

If empty - all peers are allowed | <a name="qdrant-CreateShardKeyRequest"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | | request | | | Request to create shard key | | timeout | | optional | Wait timeout for operation commit in seconds, if not specified - default value will be supplied | <a name="qdrant-CreateShardKeyResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | | | <a name="qdrant-DeleteAlias"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | alias_name | | | Name of the alias | <a name="qdrant-DeleteCollection"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | | timeout | | optional | Wait timeout for operation commit in seconds, if not specified - default value will be supplied | <a name="qdrant-DeleteShardKey"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | shard_key | | | Shard key to delete | <a name="qdrant-DeleteShardKeyRequest"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | | request | | | Request to delete shard key | | timeout | | optional | Wait timeout for operation commit in seconds, if not specified - default value will be supplied | <a name="qdrant-DeleteShardKeyResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | | | <a name="qdrant-Disabled"></a> <a name="qdrant-GetCollectionInfoRequest"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | <a name="qdrant-GetCollectionInfoResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | | | | time | | | Time spent to process | <a name="qdrant-HnswConfigDiff"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | m | | optional | Number of edges per node in the index graph. Larger the value - more accurate the search, more space required. | | ef_construct | | optional | Number of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build the index. | | fullscanthreshold | | optional | Minimal size (in KiloBytes) of vectors for additional payload-based indexing. If the payload chunk is smaller than `fullscanthreshold` additional indexing won&#39;t be used - in this case full-scan search should be preferred by query planner and additional indexing is not required. Note: 1 Kb = 1 vector of size 256 | | maxindexingthreads | | optional | Number 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 graphs. On small CPUs, less threads are used. | | on_disk | | optional | Store HNSW index on disk. If set to false, the index will be stored in RAM. | | payload_m | | optional | Number of additional payload-aware links per node in the index graph. If not set - regular M parameter will be used. | <a name="qdrant-IntegerIndexParams"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | lookup | | | If true - support direct lookups. | | range | | | If true - support ranges

| <a name="qdrant-ListAliasesRequest"></a> <a name="qdrant-ListAliasesResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | aliases | | repeated | | | time | | | Time spent to process | <a name="qdrant-ListCollectionAliasesRequest"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | <a name="qdrant-ListCollectionsRequest"></a> <a name="qdrant-ListCollectionsResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collections | | repeated | | | time | | | Time spent to process | <a name="qdrant-LocalShardInfo"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | shard_id | | | Local shard id | | points_count | | | Number of points in the shard | | state | | | Is replica active | | shard_key | | optional | User-defined shard key | <a name="qdrant-MoveShard"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | shard_id | | | Local shard id | | frompeerid | | | | | topeerid | | | | | method | | optional | | <a name="qdrant-MultiVectorConfig"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | comparator | | | Comparator for multi-vector search | <a name="qdrant-OptimizerStatus"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | ok | | | | | error | | | | <a name="qdrant-OptimizersConfigDiff"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | deleted_threshold | | optional | The minimal fraction of deleted vectors in a segment, required to perform segment optimization | | vacuumminvector_number | | optional | The minimal number of vectors in a segment, required to perform segment optimization | | defaultsegmentnumber | | optional | Target amount of segments the 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 the default number of segments as a factor of the number of search threads, so that each segment would be handled evenly by one of the threads. | | maxsegmentsize | | optional | Do 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 indexing speed is more important - make this parameter lower. If search speed is more important - make this parameter higher. Note: 1Kb = 1 vector of size 256 If not set, will be automatically selected considering the number of available CPUs. | | memmap_threshold | | optional | Maximum size (in kilobytes) of vectors to store in-memory per segment. Segments larger than this threshold will be stored as read-only memmaped file. Memmap storage is disabled by default, to enable it, set this threshold to a reasonable value. To disable memmap storage, set this to `0`. Note: 1Kb = 1 vector of size 256 | | indexing_threshold | | optional | Maximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing Default value is 20,000, based on &lt;https://github.com/google-research/google-research/blob/master/scann/docs/algorithms.md&gt;. To disable vector indexing, set to `0`. Note: 1kB = 1 vector of size 256. | | flushintervalsec | | optional | Interval between forced flushes. | | maxoptimizationthreads | | optional | Max number of threads (jobs) for running optimizations per shard. Note: each optimization job will also use `maxindexingthreads` threads by itself for index building. If null - have no limit and choose dynamically to saturate CPU. If 0 - no optimization threads, optimizations will be

| <a name="qdrant-PayloadIndexParams"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | textindexparams | | | Parameters for text index | | integerindexparams | | | Parameters for integer index | <a name="qdrant-PayloadSchemaInfo"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | data_type | | | Field data type | | params | | optional | Field index parameters | | points | | optional | Number of points indexed within this field indexed | <a name="qdrant-ProductQuantization"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | compression | | | Compression ratio | | always_ram | | optional | If true - quantized vectors always will be stored in RAM, ignoring the config of main storage | <a name="qdrant-QuantizationConfig"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | scalar | | | | | product | | | | | binary | | | | <a name="qdrant-QuantizationConfigDiff"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | scalar | | | | | product | | | | | disabled | | | | | binary | | | | <a name="qdrant-RemoteShardInfo"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | shard_id | | | Local shard id | | peer_id | | | Remote peer id | | state | | | Is replica active | | shard_key | | optional | User-defined shard key | <a name="qdrant-RenameAlias"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | oldaliasname | | | Name of the alias to rename | | newaliasname | | | Name of the alias | <a name="qdrant-Replica"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | shard_id | | | | | peer_id | | | | <a name="qdrant-ReplicateShard"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | shard_id | | | Local shard id | | frompeerid | | | | | topeerid | | | | | method | | optional | | <a name="qdrant-RestartTransfer"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | shard_id | | | Local shard id | | frompeerid | | | | | topeerid | | | | | method | | | | <a name="qdrant-ScalarQuantization"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | type | | | Type of quantization | | quantile | | optional | Number of bits to use for quantization | | always_ram | | optional | If true - quantized vectors always will be stored in RAM, ignoring the config of main storage | <a name="qdrant-ShardKey"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | keyword | | | String key | | number | | | Number key | <a name="qdrant-ShardTransferInfo"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | shard_id | | | Local shard id | | from | | | | | to | | | | | sync | | | If `true` transfer is a synchronization of a replicas; If `false` transfer is a moving of a shard from one peer to another | <a name="qdrant-SparseIndexConfig"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | fullscanthreshold | | optional | Prefer a full scan search upto (excluding) this number of vectors. Note: this is number of vectors, not KiloBytes. | | on_disk | | optional | Store inverted index on disk. If set to false, the index will be stored in

| <a name="qdrant-SparseVectorConfig"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | map | | repeated | | <a name="qdrant-SparseVectorConfig-MapEntry"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | | | value | | | | <a name="qdrant-SparseVectorParams"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | index | | optional | Configuration of sparse index | | modifier | | optional | If set - apply modifier to the vector values | <a name="qdrant-TextIndexParams"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | tokenizer | | | Tokenizer type | | lowercase | | optional | If true - all tokens will be lowercase | | mintokenlen | | optional | Minimal token length | | maxtokenlen | | optional | Maximal token length | <a name="qdrant-UpdateCollection"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | | optimizers_config | | optional | New configuration parameters for the collection. This operation is blocking, it will only proceed once all current optimizations are complete | | timeout | | optional | Wait timeout for operation commit in seconds if blocking, if not specified - default value will be supplied | | params | | optional | New configuration parameters for the collection | | hnsw_config | | optional | New HNSW parameters for the collection index | | vectors_config | | optional | New vector parameters | | quantization_config | | optional | Quantization configuration of vector | | sparsevectorsconfig | | optional | New sparse vector parameters | <a name="qdrant-UpdateCollectionClusterSetupRequest"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | | move_shard | | | | | replicate_shard | | | | | abort_transfer | | | | | drop_replica | | | | | createshardkey | | | | | deleteshardkey | | | | | restart_transfer | | | | | timeout | | optional | Wait timeout for operation commit in seconds, if not specified - default value will be supplied | <a name="qdrant-UpdateCollectionClusterSetupResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | | | <a name="qdrant-VectorParams"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | size | | | Size of the vectors | | distance | | | Distance function used for comparing vectors | | hnsw_config | | optional | Configuration of vector HNSW graph. If omitted - the collection configuration will be used | | quantization_config | | optional | Configuration of vector quantization config. If omitted - the collection configuration will be used | | on_disk | | optional | If true - serve vectors from disk. If set to false, the vectors will be loaded in RAM. | | datatype | | optional | Data type of the vectors | | multivector_config | | optional | Configuration for multi-vector search | <a name="qdrant-VectorParamsDiff"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | hnsw_config | | optional | Update params for HNSW index. If empty object - it will be unset | | quantization_config | | optional | Update quantization params. If none - it is left unchanged. | | on_disk | | optional | If true - serve vectors from disk. If set to false, the vectors will be loaded in

| <a name="qdrant-VectorParamsDiffMap"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | map | | repeated | | <a name="qdrant-VectorParamsDiffMap-MapEntry"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | | | value | | | | <a name="qdrant-VectorParamsMap"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | map | | repeated | | <a name="qdrant-VectorParamsMap-MapEntry"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | | | value | | | | <a name="qdrant-VectorsConfig"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | params | | | | | params_map | | | | <a name="qdrant-VectorsConfigDiff"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | params | | | | | params_map | | | | <a name="qdrant-WalConfigDiff"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | walcapacitymb | | optional | Size of a single WAL block file | | walsegmentsahead | | optional | Number of segments to create in advance | <a name="qdrant-CollectionStatus"></a> | Name | Number | Description | | - | | -- | | UnknownCollectionStatus | 0 | | | Green | 1 | All segments are ready | | Yellow | 2 | Optimization in process | | Red | 3 | Something went wrong | | Grey | 4 | Optimization is pending | <a name="qdrant-CompressionRatio"></a> | Name | Number | Description | | - | | -- | | x4 | 0 | | | x8 | 1 | | | x16 | 2 | | | x32 | 3 | | | x64 | 4 | | <a name="qdrant-Datatype"></a> | Name | Number | Description | | - | | -- | | Default | 0 | | | Float32 | 1 | | | Uint8 | 2 | | <a name="qdrant-Distance"></a> | Name | Number | Description | | - | | -- | | UnknownDistance | 0 | | | Cosine | 1 | | | Euclid | 2 | | | Dot | 3 | | | Manhattan | 4 | | <a name="qdrant-Modifier"></a> | Name | Number | Description | | - | | -- | | None | 0 | | | Idf | 1 | Apply Inverse Document Frequency | <a name="qdrant-MultiVectorComparator"></a> | Name | Number | Description | | - | | -- | | MaxSim | 0 | | <a name="qdrant-PayloadSchemaType"></a> | Name | Number | Description | | - | | -- | | UnknownType | 0 | | | Keyword | 1 | | | Integer | 2 | | | Float | 3 | | | Geo | 4 | | | Text | 5 | | | Bool | 6 | | | Datetime | 7 | | <a name="qdrant-QuantizationType"></a> | Name | Number | Description | | - | | -- | | UnknownQuantization | 0 | | | Int8 | 1 | | <a name="qdrant-ReplicaState"></a> | Name | Number | Description | | - | | -- | | Active | 0 | Active and sound | | Dead | 1 | Failed for some reason | | Partial | 2 | The shard is partially loaded and is currently receiving data from other shards | | Initializing | 3 | Collection is being created | | Listener | 4 | A shard which receives data, but is not used for search; Useful for backup shards | | PartialSnapshot | 5 | Deprecated: snapshot shard transfer is in progress; Updates should not be sent to (and are ignored by) the shard | | Recovery | 6 | Shard is undergoing recovered by an external node; Normally rejects updates, accepts updates if force is true | <a name="qdrant-ShardTransferMethod"></a> | Name | Number | Description | | - | | -- | | StreamRecords | 0 | Stream shard records in batches | | Snapshot | 1 | Snapshot the shard and recover it on the target peer | | WalDelta | 2 | Resolve WAL delta between peers and transfer the difference | <a name="qdrant-ShardingMethod"></a> | Name | Number | Description | | - | | -- | | Auto | 0 | Auto-sharding based on record ids | | Custom | 1 | Shard by user-defined key | <a name="qdrant-TokenizerType"></a> | Name | Number | Description | | - | | -- | | Unknown | 0 | | | Prefix | 1 | | | Whitespace | 2 | | | Word | 3 | | | Multilingual | 4 | | <a name="collections_service-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="qdrant-Collections"></a> | Method Name | Request Type | Response Type | Description | | -- | | - | | | Get | | | Get detailed information about specified existing collection | | List | | | Get list name of all existing collections | | Create | | | Create new collection with given parameters | | Update | | | Update parameters of the existing collection | | Delete | | | Drop collection and all associated data | | UpdateAliases | | | Update Aliases of the existing collection | | ListCollectionAliases | | | Get list of all aliases for a collection | | ListAliases | | | Get list of all aliases for all existing collections | | CollectionClusterInfo | | | Get cluster information for a collection | | CollectionExists | | | Check the existence of a collection | | UpdateCollectionClusterSetup | | | Update cluster setup for a collection | | CreateShardKey | | | Create shard key | | DeleteShardKey | | | Delete shard key | <a name="health_check-proto"></a> <p align="right"><a href="#top">Top</a></p> source: https://github.com/grpc/grpc/blob/master/doc/health-checking.md#service-definition <a name="grpc-health-v1-HealthCheckRequest"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | service | | | | <a name="grpc-health-v1-HealthCheckResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | status | | | | <a name="grpc-health-v1-HealthCheckResponse-ServingStatus"></a> | Name | Number | Description | | - | | -- | | UNKNOWN | 0 | | | SERVING | 1 | | | NOT_SERVING | 2 | | | SERVICE_UNKNOWN | 3 | Used only by the Watch method. | <a name="grpc-health-v1-Health"></a> | Method Name | Request Type | Response Type | Description | | -- | | - | | | Check | | | | <a name="jsonwithint-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="qdrant-ListValue"></a> `ListValue` is a wrapper around a repeated field of values. The JSON representation for `ListValue` is a JSON array. | Field | Type | Label | Description | | -- | - | -- | -- | | values | | repeated | Repeated field of dynamically typed values. | <a name="qdrant-Struct"></a> `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, `Struct` might be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language. The JSON representation for `Struct` is a JSON

| Field | Type | Label | Description | | -- | - | -- | -- | | fields | | repeated | Unordered map of dynamically typed values. | <a name="qdrant-Struct-FieldsEntry"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | | | value | | | | <a name="qdrant-Value"></a> `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of those variants, absence of any variant indicates an error. The JSON representation for `Value` is a JSON value. | Field | Type | Label | Description | | -- | - | -- | -- | | null_value | | | Represents a null value. | | double_value | | | Represents a double value. | | integer_value | | | Represents an integer value | | string_value | | | Represents a string value. | | bool_value | | | Represents a boolean value. | | struct_value | | | Represents a structured value. | | list_value | | | Represents a repeated `Value`. | <a name="qdrant-NullValue"></a> `NullValue` is a singleton enumeration to represent the null value for the `Value` type union. The JSON representation for `NullValue` is JSON `null`. | Name | Number | Description | | - | | -- | | NULL_VALUE | 0 | Null value. | <a name="points-proto"></a> <p

href="#top">Top</a></p> <a name="qdrant-BatchResult"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | repeated | | <a name="qdrant-ClearPayloadPoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | name of the collection | | wait | | optional | Wait until the changes have been applied? | | points | | | Affected points | | ordering | | optional | Write ordering guarantees | | shardkeyselector | | optional | Option for custom sharding to specify used shard keys | <a name="qdrant-Condition"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | field | | | | | is_empty | | | | | has_id | | | | | filter | | | | | is_null | | | | | nested | | | | <a name="qdrant-ContextExamplePair"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | positive | | | | | negative | | | | <a name="qdrant-CountPoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | name of the collection | | filter | | | Filter conditions - return only those points that satisfy the specified conditions | | exact | | optional | If `true` - return exact count, if `false` - return approximate count | | read_consistency | | optional | Options for specifying read consistency guarantees | | shardkeyselector | | optional | Specify in which shards to look for the points, if not specified - look in all shards | <a name="qdrant-CountResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | | | | time | | | Time spent to process | <a name="qdrant-CountResult"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | count | | | | <a name="qdrant-CreateFieldIndexCollection"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | name of the collection | | wait | | optional | Wait until the changes have been applied? | | field_name | | | Field name to index | | field_type | | optional | Field type. | | fieldindexparams | | optional | Payload index params. | | ordering | | optional | Write ordering guarantees | <a name="qdrant-DatetimeRange"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | lt | | optional | | | gt | | optional | | | gte | | optional | | | lte | | optional | | <a name="qdrant-DeleteFieldIndexCollection"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | name of the collection | | wait | | optional | Wait until the changes have been applied? | | field_name | | | Field name to delete | | ordering | | optional | Write ordering guarantees | <a name="qdrant-DeletePayloadPoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | name of the collection | | wait | | optional | Wait until the changes have been applied? | | keys | | repeated | List of keys to delete | | points_selector | | optional | Affected points | | ordering | | optional | Write ordering guarantees | | shardkeyselector | | optional | Option for custom sharding to specify used shard keys | <a name="qdrant-DeletePointVectors"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | name of the collection | | wait | | optional | Wait until the changes have been applied? | | points_selector | | | Affected points | | vectors | | | List of vector names to delete | | ordering | | optional | Write ordering guarantees | | shardkeyselector | | optional | Option for custom sharding to specify used shard keys | <a name="qdrant-DeletePoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | name of the collection | | wait | | optional | Wait until the changes have been applied? | | points | | | Affected points | | ordering | | optional | Write ordering guarantees | | shardkeyselector | | optional | Option for custom sharding to specify used shard keys | <a name="qdrant-DiscoverBatchPoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | | discover_points | | repeated | | | read_consistency | | optional | Options for specifying read consistency guarantees | | timeout | | optional | If set, overrides global timeout setting for this request. Unit is

| <a name="qdrant-DiscoverBatchResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | repeated | | | time | | | Time spent to process | <a name="qdrant-DiscoverPoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | name of the collection | | target | | | Use this as the primary search objective | | context | | repeated | Search will be constrained by these pairs of examples | | filter | | | Filter conditions - return only those points that satisfy the specified conditions | | limit | | | Max number of result | | with_payload | | | Options for specifying which payload to include or not | | params | | | Search config | | offset | | optional | Offset of the result | | using | | optional | Define which vector to use for recommendation, if not specified - default vector | | with_vectors | | optional | Options for specifying which vectors to include into response | | lookup_from | | optional | Name of the collection to use for points lookup, if not specified - use current collection | | read_consistency | | optional | Options for specifying read consistency guarantees | | timeout | | optional | If set, overrides global timeout setting for this request. Unit is seconds. | | shardkeyselector | | optional | Specify in which shards to look for the points, if not specified - look in all shards | <a name="qdrant-DiscoverResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | repeated | | | time | | | Time spent to process | <a name="qdrant-FieldCondition"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | | | match | | | Check if point has field with a given value | | range | | | Check if points value lies in a given range | | geoboundingbox | | | Check if points geolocation lies in a given area | | geo_radius | | | Check if geo point is within a given radius | | values_count | | | Check number of values for a specific field | | geo_polygon | | | Check if geo point is within a given polygon | | datetime_range | | | Check if datetime is within a given range | <a name="qdrant-Filter"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | should | | repeated | At least one of those conditions should match | | must | | repeated | All conditions must match | | must_not | | repeated | All conditions must NOT match | | min_should | | optional | At least minimum amount of given conditions should match | <a name="qdrant-GeoBoundingBox"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | top_left | | | north-west corner | | bottom_right | | | south-east corner | <a name="qdrant-GeoLineString"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | points | | repeated | Ordered sequence of GeoPoints representing the line | <a name="qdrant-GeoPoint"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | lon | | | | | lat | | | | <a name="qdrant-GeoPolygon"></a> For a valid GeoPolygon, both the exterior and interior GeoLineStrings must consist of a minimum of 4

Additionally, the first and last points of each GeoLineString must be the same. | Field | Type | Label | Description | | -- | - | -- | -- | | exterior | | | The exterior line bounds the surface | | interiors | | repeated | Interior lines (if present) bound holes within the surface | <a name="qdrant-GeoRadius"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | center | | | Center of the circle | | radius | | | In meters | <a name="qdrant-GetPoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | name of the collection | | ids | | repeated | List of points to retrieve | | with_payload | | | Options for specifying which payload to include or not | | with_vectors | | optional | Options for specifying which vectors to include into response | | read_consistency | | optional | Options for specifying read consistency guarantees | | shardkeyselector | | optional | Specify in which shards to look for the points, if not specified - look in all shards | <a name="qdrant-GetResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | repeated | | | time | | | Time spent to process | <a name="qdrant-GroupId"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | unsigned_value | | | Represents a double value. | | integer_value | | | Represents an integer value | | string_value | | | Represents a string

| <a name="qdrant-GroupsResult"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | groups | | repeated | Groups | <a name="qdrant-HasIdCondition"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | has_id | | repeated | | <a name="qdrant-IsEmptyCondition"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | | <a name="qdrant-IsNullCondition"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | | <a name="qdrant-LookupLocation"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | | | vector_name | | optional | Which vector to use for search, if not specified - use default vector | | shardkeyselector | | optional | Specify in which shards to look for the points, if not specified - look in all shards | <a name="qdrant-Match"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | keyword | | | Match string keyword | | integer | | | Match integer | | boolean | | | Match boolean | | text | | | Match text | | keywords | | | Match multiple keywords | | integers | | | Match multiple integers | | except_integers | | | Match any other value except those integers | | except_keywords | | | Match any other value except those keywords | <a name="qdrant-MinShould"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | conditions | | repeated | | | min_count | | | | <a name="qdrant-NamedVectors"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | vectors | | repeated | | <a name="qdrant-NamedVectors-VectorsEntry"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | | | value | | | | <a name="qdrant-NestedCondition"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | Path to nested object | | filter | | | Filter condition | <a name="qdrant-OrderBy"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | Payload key to order by | | direction | | optional | Ascending or descending order | | start_from | | optional | Start from this value | <a name="qdrant-PayloadExcludeSelector"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | fields | | repeated | List of payload keys to exclude from the result | <a name="qdrant-PayloadIncludeSelector"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | fields | | repeated | List of payload keys to include into result | <a name="qdrant-PointGroup"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | id | | | Group id | | hits | | repeated | Points in the group | | lookup | | | Point(s) from the lookup collection that matches the group id | <a name="qdrant-PointId"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | num | | | Numerical ID of the point | | uuid | | | UUID | <a name="qdrant-PointStruct"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | id | | | | | payload | | repeated | | | vectors | | optional | | <a name="qdrant-PointStruct-PayloadEntry"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | | | value | | | | <a name="qdrant-PointVectors"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | id | | | ID to update vectors for | | vectors | | | Named vectors to update, leave others intact | <a name="qdrant-PointsIdsList"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | ids | | repeated | | <a name="qdrant-PointsOperationResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | | | | time | | | Time spent to process | <a name="qdrant-PointsSelector"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | points | | | | | filter | | | | <a name="qdrant-PointsUpdateOperation"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | upsert | | | | | delete_deprecated | | |

| | set_payload | | | | | overwrite_payload | | | | | delete_payload | | | | | clearpayloaddeprecated | | | Deprecated. | | update_vectors | | | | | delete_vectors | | | | | delete_points | | | | | clear_payload | | | | <a name="qdrant-PointsUpdateOperation-ClearPayload"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | points | | | Affected points | | shardkeyselector | | optional | Option for custom sharding to specify used shard keys | <a name="qdrant-PointsUpdateOperation-DeletePayload"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | keys | | repeated | | | points_selector | | optional | Affected points | | shardkeyselector | | optional | Option for custom sharding to specify used shard keys | <a name="qdrant-PointsUpdateOperation-DeletePoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | points | | | Affected points | | shardkeyselector | | optional | Option for custom sharding to specify used shard keys | <a name="qdrant-PointsUpdateOperation-DeleteVectors"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | points_selector | | | Affected points | | vectors | | | List of vector names to delete | | shardkeyselector | | optional | Option for custom sharding to specify used shard keys | <a name="qdrant-PointsUpdateOperation-OverwritePayload"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | payload | | repeated | | | points_selector | | optional | Affected points | | shardkeyselector | | optional | Option for custom sharding to specify used shard keys | | key | | optional | Option for indicate property of payload | <a name="qdrant-PointsUpdateOperation-OverwritePayload-PayloadEntry"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | | | value | | | | <a name="qdrant-PointsUpdateOperation-PointStructList"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | points | | repeated | | | shardkeyselector | | optional | Option for custom sharding to specify used shard keys | <a name="qdrant-PointsUpdateOperation-SetPayload"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | payload | | repeated | | | points_selector | | optional | Affected points | | shardkeyselector | | optional | Option for custom sharding to specify used shard keys | | key | | optional | Option for indicate property of payload | <a name="qdrant-PointsUpdateOperation-SetPayload-PayloadEntry"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | | | value | | | | <a name="qdrant-PointsUpdateOperation-UpdateVectors"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | points | | repeated | List of points and vectors to update | | shardkeyselector | | optional | Option for custom sharding to specify used shard keys | <a name="qdrant-QuantizationSearchParams"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | ignore | | optional | If set to true, search will ignore quantized vector data | | rescore | | optional | If true, use original vectors to re-score top-k results. If ignored, qdrant decides automatically does rescore enabled or not. | | oversampling | | optional | Oversampling factor for

Defines how many extra vectors should be pre-selected using quantized index, and then re-scored using original vectors. For example, if `oversampling` is 2.4 and `limit` is 100, then 240 vectors will be pre-selected using quantized index, and then top-100 will be returned after re-scoring. | <a name="qdrant-Range"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | lt | | optional | | | gt | | optional | | | gte | | optional | | | lte | | optional | | <a name="qdrant-ReadConsistency"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | type | | | Common read consistency configurations | | factor | | | Send request to a specified number of nodes, and return points which are present on all of them | <a name="qdrant-RecommendBatchPoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | | recommend_points | | repeated | | | read_consistency | | optional | Options for specifying read consistency guarantees | | timeout | | optional | If set, overrides global timeout setting for this request. Unit is seconds. | <a name="qdrant-RecommendBatchResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | repeated | | | time | | | Time spent to process | <a name="qdrant-RecommendGroupsResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | | | | time | | | Time spent to process | <a name="qdrant-RecommendPointGroups"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | | positive | | repeated | Look for vectors closest to the vectors from these points | | negative | | repeated | Try to avoid vectors like the vector from these points | | filter | | | Filter conditions - return only those points that satisfy the specified conditions | | limit | | | Max number of groups in result | | with_payload | | | Options for specifying which payload to include or not | | params | | | Search config | | score_threshold | | optional | If provided - cut off results with worse scores | | using | | optional | Define which vector to use for recommendation, if not specified - default vector | | with_vectors | | optional | Options for specifying which vectors to include into response | | lookup_from | | optional | Name of the collection to use for points lookup, if not specified - use current collection | | group_by | | | Payload field to group by, must be a string or number field. If there are multiple values for the field, all of them will be used. One point can be in multiple

| | group_size | | | Maximum amount of points to return per group | | read_consistency | | optional | Options for specifying read consistency guarantees | | with_lookup | | optional | Options for specifying how to use the group id to lookup points in another collection | | strategy | | optional | How to use the example vectors to find the results | | positive_vectors | | repeated | Look for vectors closest to those | | negative_vectors | | repeated | Try to avoid vectors like this | | timeout | | optional | If set, overrides global timeout setting for this request. Unit is seconds. | | shardkeyselector | | optional | Specify in which shards to look for the points, if not specified - look in all shards | <a name="qdrant-RecommendPoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | name of the collection | | positive | | repeated | Look for vectors closest to the vectors from these points | | negative | | repeated | Try to avoid vectors like the vector from these points | | filter | | | Filter conditions - return only those points that satisfy the specified conditions | | limit | | | Max number of result | | with_payload | | | Options for specifying which payload to include or not | | params | | | Search config | | score_threshold | | optional | If provided - cut off results with worse scores | | offset | | optional | Offset of the result | | using | | optional | Define which vector to use for recommendation, if not specified - default vector | | with_vectors | | optional | Options for specifying which vectors to include into response | | lookup_from | | optional | Name of the collection to use for points lookup, if not specified - use current collection | | read_consistency | | optional | Options for specifying read consistency guarantees | | strategy | | optional | How to use the example vectors to find the results | | positive_vectors | | repeated | Look for vectors closest to those | | negative_vectors | | repeated | Try to avoid vectors like this | | timeout | | optional | If set, overrides global timeout setting for this request. Unit is

| | shardkeyselector | | optional | Specify in which shards to look for the points, if not specified - look in all shards | <a name="qdrant-RecommendResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | repeated | | | time | | | Time spent to process | <a name="qdrant-RepeatedIntegers"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | integers | | repeated | | <a name="qdrant-RepeatedStrings"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | strings | | repeated | | <a name="qdrant-RetrievedPoint"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | id | | | | | payload | | repeated | | | vectors | | optional | | | shard_key | | optional | Shard key | <a name="qdrant-RetrievedPoint-PayloadEntry"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | | | value | | | | <a name="qdrant-ScoredPoint"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | id | | | Point id | | payload | | repeated | Payload | | score | | | Similarity score | | version | | | Last update operation applied to this point | | vectors | | optional | Vectors to search | | shard_key | | optional | Shard key | <a name="qdrant-ScoredPoint-PayloadEntry"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | | | value | | | | <a name="qdrant-ScrollPoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | | | filter | | | Filter conditions - return only those points that satisfy the specified conditions | | offset | | optional | Start with this ID | | limit | | optional | Max number of result | | with_payload | | | Options for specifying which payload to include or not | | with_vectors | | optional | Options for specifying which vectors to include into response | | read_consistency | | optional | Options for specifying read consistency guarantees | | shardkeyselector | | optional | Specify in which shards to look for the points, if not specified - look in all shards | | order_by | | optional | Order the records by a payload field | <a name="qdrant-ScrollResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | nextpageoffset | | optional | Use this offset for the next query | | result | | repeated | | | time | | | Time spent to process | <a name="qdrant-SearchBatchPoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | | search_points | | repeated | | | read_consistency | | optional | Options for specifying read consistency guarantees | | timeout | | optional | If set, overrides global timeout setting for this request. Unit is seconds. | <a name="qdrant-SearchBatchResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | repeated | | | time | | | Time spent to process | <a name="qdrant-SearchGroupsResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | | | | time | | | Time spent to process | <a name="qdrant-SearchParams"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | hnsw_ef | | optional | Params relevant to HNSW index. Size of the beam in a beam-search. Larger the value - more accurate the result, more time required for search. | | exact | | optional | Search without approximation. If set to true, search may run long but with exact results. | | quantization | | optional | If set to true, search will ignore quantized vector data | | indexed_only | | optional | If enabled, the engine will only perform search among indexed or small

Using this option prevents slow searches in case of delayed index, but does not guarantee that all uploaded vectors will be included in search results | <a name="qdrant-SearchPointGroups"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | | vector | | repeated | Vector to compare against | | filter | | | Filter conditions - return only those points that satisfy the specified conditions | | limit | | | Max number of result | | with_payload | | | Options for specifying which payload to include or not | | params | | | Search config | | score_threshold | | optional | If provided - cut off results with worse scores | | vector_name | | optional | Which vector to use for search, if not specified - use default vector | | with_vectors | | optional | Options for specifying which vectors to include into response | | group_by | | | Payload field to group by, must be a string or number field. If there are multiple values for the field, all of them will be used. One point can be in multiple groups. | | group_size | | | Maximum amount of points to return per group | | read_consistency | | optional | Options for specifying read consistency guarantees | | with_lookup | | optional | Options for specifying how to use the group id to lookup points in another collection | | timeout | | optional | If set, overrides global timeout setting for this request. Unit is seconds. | | shardkeyselector | | optional | Specify in which shards to look for the points, if not specified - look in all shards | | sparse_indices | | optional | | <a name="qdrant-SearchPoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | name of the collection | | vector | | repeated | vector | | filter | | | Filter conditions - return only those points that satisfy the specified conditions | | limit | | | Max number of result | | with_payload | | | Options for specifying which payload to include or not | | params | | | Search config | | score_threshold | | optional | If provided - cut off results with worse scores | | offset | | optional | Offset of the result | | vector_name | | optional | Which vector to use for search, if not specified - use default vector | | with_vectors | | optional | Options for specifying which vectors to include into response | | read_consistency | | optional | Options for specifying read consistency guarantees | | timeout | | optional | If set, overrides global timeout setting for this request. Unit is

| | shardkeyselector | | optional | Specify in which shards to look for the points, if not specified - look in all shards | | sparse_indices | | optional | | <a name="qdrant-SearchResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | repeated | | | time | | | Time spent to process | <a name="qdrant-SetPayloadPoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | name of the collection | | wait | | optional | Wait until the changes have been applied? | | payload | | repeated | New payload values | | points_selector | | optional | Affected points | | ordering | | optional | Write ordering guarantees | | shardkeyselector | | optional | Option for custom sharding to specify used shard keys | | key | | optional | Option for indicate property of payload | <a name="qdrant-SetPayloadPoints-PayloadEntry"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | key | | | | | value | | | | <a name="qdrant-ShardKeySelector"></a> -- ShardKeySelector - | Field | Type | Label | Description | | -- | - | -- | -- | | shard_keys | | repeated | List of shard keys which should be used in the request | <a name="qdrant-SparseIndices"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | data | | repeated | | <a name="qdrant-StartFrom"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | float | | | | | integer | | | | | timestamp | | | | | datetime | | | | <a name="qdrant-TargetVector"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | single | | | | <a name="qdrant-UpdateBatchPoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | name of the collection | | wait | | optional | Wait until the changes have been applied? | | operations | | repeated | | | ordering | | optional | Write ordering guarantees | <a name="qdrant-UpdateBatchResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | result | | repeated | | | time | | | Time spent to process | <a name="qdrant-UpdatePointVectors"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | name of the collection | | wait | | optional | Wait until the changes have been applied? | | points | | repeated | List of points and vectors to update | | ordering | | optional | Write ordering guarantees | | shardkeyselector | | optional | Option for custom sharding to specify used shard keys | <a name="qdrant-UpdateResult"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | operation_id | | optional | Number of operation | | status | | | Operation status | <a name="qdrant-UpsertPoints"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | name of the collection | | wait | | optional | Wait until the changes have been applied? | | points | | repeated | | | ordering | | optional | Write ordering guarantees | | shardkeyselector | | optional | Option for custom sharding to specify used shard keys | <a name="qdrant-ValuesCount"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | lt | | optional | | | gt | | optional | | | gte | | optional | | | lte | | optional | | <a name="qdrant-Vector"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | data | | repeated | Vector data (flatten for multi vectors) | | indices | | optional | Sparse indices for sparse vectors | | vectors_count | | optional | Number of vectors per multi vector | <a name="qdrant-VectorExample"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | id | | | | | vector | | | | <a name="qdrant-Vectors"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | vector | | | | | vectors | | | | <a name="qdrant-VectorsSelector"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | names | | repeated | List of vectors to include into result | <a name="qdrant-WithLookup"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection | | | Name of the collection to use for points lookup | | with_payload | | optional | Options for specifying which payload to include (or not) | | with_vectors | | optional | Options for specifying which vectors to include (or not) | <a name="qdrant-WithPayloadSelector"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | enable | | | If `true` - return all payload, if `false` - none | | include | | | | | exclude | | | | <a name="qdrant-WithVectorsSelector"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | enable | | | If `true` - return all vectors, if `false` - none | | include | | | List of payload keys to include into result | <a name="qdrant-WriteOrdering"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | type | | | Write ordering guarantees | <a name="qdrant-Direction"></a> | Name | Number | Description | | - | | -- | | Asc | 0 | | | Desc | 1 | | <a name="qdrant-FieldType"></a> | Name | Number | Description | | - | | -- | | FieldTypeKeyword | 0 | | | FieldTypeInteger | 1 | | | FieldTypeFloat | 2 | | | FieldTypeGeo | 3 | | | FieldTypeText | 4 | | | FieldTypeBool | 5 | | | FieldTypeDatetime | 6 | | <a name="qdrant-ReadConsistencyType"></a> | Name | Number | Description | | - | | -- | | All | 0 | Send request to all nodes and return points which are present on all of them | | Majority | 1 | Send requests to all nodes and return points which are present on majority of them | | Quorum | 2 | Send requests to half &#43; 1 nodes, return points which are present on all of them | <a name="qdrant-RecommendStrategy"></a> How to use positive and negative vectors to find the results, default is `AverageVector`: | Name | Number | Description | | - | | -- | | AverageVector | 0 | Average positive and negative vectors and create a single query with the formula `query = avgpos &#43; avgpos - avg_neg`. Then performs normal search. | | BestScore | 1 | Uses custom search objective. Each candidate is compared against all examples, its score is then chosen from the `max(maxposscore, maxnegscore)`. If the `maxnegscore` is chosen then it is squared and

| <a name="qdrant-UpdateStatus"></a> | Name | Number | Description | | - | | -- | | UnknownUpdateStatus | 0 | | | Acknowledged | 1 | Update is received, but not processed yet | | Completed | 2 | Update is applied and ready for search | | ClockRejected | 3 | Internal: update is rejected due to an outdated clock | <a name="qdrant-WriteOrderingType"></a> | Name | Number | Description | | - | | -- | | Weak | 0 | Write operations may be reordered, works faster, default | | Medium | 1 | Write operations go through dynamically selected leader, may be inconsistent for a short period of time in case of leader change | | Strong | 2 | Write operations go through the permanent leader, consistent, but may be unavailable if leader is down | <a name="points_service-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="qdrant-Points"></a> | Method Name | Request Type | Response Type | Description | | -- | | - | | | Upsert | | | Perform insert &#43; updates on points. If a point with a given ID already exists - it will be overwritten. | | Delete | | | Delete points | | Get | | | Retrieve points | | UpdateVectors | | | Update named vectors for point | | DeleteVectors | | | Delete named vectors for points | | SetPayload | | | Set payload for points | | OverwritePayload | | | Overwrite payload for points | | DeletePayload | | | Delete specified key payload for points | | ClearPayload | | | Remove all payload for specified points | | CreateFieldIndex | | | Create index for field in collection | | DeleteFieldIndex | | | Delete field index for collection | | Search | | | Retrieve closest points based on vector similarity and given filtering conditions | | SearchBatch | | | Retrieve closest points based on vector similarity and given filtering conditions | | SearchGroups | | | Retrieve closest points based on vector similarity and given filtering conditions, grouped by a given field | | Scroll | | | Iterate over all or filtered points | | Recommend | | | Look for the points which are closer to stored positive examples and at the same time further to negative examples. | | RecommendBatch | | | Look for the points which are closer to stored positive examples and at the same time further to negative examples. | | RecommendGroups | | | Look for the points which are closer to stored positive examples and at the same time further to negative examples, grouped by a given field | | Discover | | | Use context and a target to find the most similar points to the target, constrained by the context. When using only the context (without a target), a special search - called context search - is performed where pairs of points are used to generate a loss that guides the search towards the zone where most positive examples overlap. This means that the score minimizes the scenario of finding a point closer to a negative than to a positive part of a pair. Since the score of a context relates to loss, the maximum score a point can get is 0.0, and it becomes normal that many points can have a score of 0.0. When using target (with or without context), the score behaves a little different: The integer part of the score represents the rank with respect to the context, while the decimal part of the score relates to the distance to the target. The context part of the score for each pair is calculated &#43;1 if the point is closer to a positive than to a negative part of a pair, and -1

| | DiscoverBatch | | | Batch request points based on { positive, negative } pairs of examples, and/or a target | | Count | | | Count points in collection with given filtering conditions | | UpdateBatch | | | Perform multiple update operations in one request | <a name="qdrant-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="qdrant-HealthCheckReply"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | title | | | | | version | | | | | commit | | optional | | <a name="qdrant-HealthCheckRequest"></a> <a name="qdrant-Qdrant"></a> | Method Name | Request Type | Response Type | Description | | -- | | - | | | HealthCheck | | | | <a name="qdrantinternalservice-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="qdrant-GetConsensusCommitRequest"></a> <a name="qdrant-GetConsensusCommitResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | commit | | | Raft commit as u64 | | term | | | Raft term as u64 | <a name="qdrant-WaitOnConsensusCommitRequest"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | commit | | | Raft commit as u64 | | term | | | Raft term as u64 | | timeout | | | Timeout in seconds | <a name="qdrant-WaitOnConsensusCommitResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | ok | | | False if commit/term is diverged and never reached or if timed out. | <a name="qdrant-QdrantInternal"></a> | Method Name | Request Type | Response Type | Description | | -- | | - | | | GetConsensusCommit | | | Get current commit and term on the target node. | | WaitOnConsensusCommit | | | Wait until the target node reached the given commit ID. | <a name="snapshots_service-proto"></a> <p

href="#top">Top</a></p> <a name="qdrant-CreateFullSnapshotRequest"></a> <a name="qdrant-CreateSnapshotRequest"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | <a name="qdrant-CreateSnapshotResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | snapshot_description | | | | | time | | | Time spent to process | <a name="qdrant-DeleteFullSnapshotRequest"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | snapshot_name | | | Name of the full snapshot | <a name="qdrant-DeleteSnapshotRequest"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | | snapshot_name | | | Name of the collection snapshot | <a name="qdrant-DeleteSnapshotResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | time | | | Time spent to process | <a name="qdrant-ListFullSnapshotsRequest"></a> <a name="qdrant-ListSnapshotsRequest"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | collection_name | | | Name of the collection | <a name="qdrant-ListSnapshotsResponse"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | snapshot_descriptions | | repeated | | | time | | | Time spent to process | <a name="qdrant-SnapshotDescription"></a> | Field | Type | Label | Description | | -- | - | -- | -- | | name | | | Name of the snapshot | | creation_time | | | Creation time of the snapshot | | size | | | Size of the snapshot in bytes | | checksum | | optional | SHA256 digest of the snapshot file | <a name="qdrant-Snapshots"></a> | Method Name | Request Type | Response Type | Description | | -- | | - | | | Create | | | Create collection snapshot | | List | | | List collection snapshots | | Delete | | | Delete collection snapshot | | CreateFull | | | Create full storage snapshot | | ListFull | | | List full storage snapshots | | DeleteFull | | | Delete full storage snapshot | | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | | -- | -- | | - | | -- | -- | | - | | <a name="double" /> double | | double | double | float | float64 | double | float | Float | | <a name="float" /> float | | float | float | float | float32 | float | float | Float | | <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | | <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | | <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or