package qdrant
Get desktop application:
View/edit binary Protocol Buffers messages
Get cluster information for a collection
message
collections.proto:342string collection_name = 1
Name of the collection
message
collections.proto:373uint64 peer_id = 1
ID of this peer
uint64 shard_count = 2
Total number of shards
repeated local_shards = 3
Local shards
repeated remote_shards = 4
Remote shards
repeated shard_transfers = 5
Shard transfers
rpc Create (, )
collections_service.proto:21Create new collection with given parameters
message
collections.proto:202string collection_name = 1
Name of the collection
optional hnsw_config = 4
Configuration of vector index
optional wal_config = 5
Configuration of the Write-Ahead-Log
optional optimizers_config = 6
Configuration of the optimizers
optional uint32 shard_number = 7
Number of shards in the collection, default = 1
optional bool on_disk_payload = 8
If true - point's payload will not be stored in memory
optional uint64 timeout = 9
Wait timeout for operation commit in seconds, if not specified - default value will be supplied
optional vectors_config = 10
Configuration for vectors
optional uint32 replication_factor = 11
Number of replicas of each shard that network tries to maintain, default = 1
optional uint32 write_consistency_factor = 12
How many replicas should apply the operation for us to consider it successful, default = 1
optional string init_from_collection = 13
Specify name of the other collection to copy data from
optional quantization_config = 14
Quantization configuration of vector
rpc Delete (, )
collections_service.proto:29Drop collection and all associated data
message
collections.proto:226string collection_name = 1
Name of the collection
optional uint64 timeout = 2
Wait timeout for operation commit in seconds, if not specified - default value will be supplied
rpc Get (, )
collections_service.proto:13Get detailed information about specified existing collection
rpc List (, )
collections_service.proto:17Get list name of all existing collections
message
collections.proto:29(message has no fields)
message
collections.proto:41repeated collections = 1
double time = 2
Time spent to process
Get list of all aliases for all existing collections
message
collections.proto:325(message has no fields)
Get list of all aliases for a collection
message
collections.proto:328string collection_name = 1
Name of the collection
rpc Update (, )
collections_service.proto:25Update parameters of the existing collection
message
collections.proto:219string collection_name = 1
Name of the collection
optional optimizers_config = 2
New configuration parameters for the collection
optional uint64 timeout = 3
Wait timeout for operation commit in seconds, if not specified - default value will be supplied
optional params = 4
New configuration parameters for the collection
Update Aliases of the existing collection
message
collections.proto:298repeated actions = 1
List of actions
optional uint64 timeout = 2
Wait timeout for operation commit in seconds, if not specified - default value will be supplied
Update cluster setup for a collection
message
collections.proto:392string collection_name = 1
Name of the collection
oneof operation
move_shard = 2
replicate_shard = 3
abort_transfer = 4
drop_replica = 5
optional uint64 timeout = 6
Wait timeout for operation commit in seconds, if not specified - default value will be supplied
message
collections.proto:403bool result = 1
Get collection info
optional get_collectionInfoRequest = 1
uint32 shard_id = 2
Initiate shard transfer
string collection_name = 1
Name of the collection
uint32 shard_id = 2
Id of the temporary shard
service Points
points_service.proto:11rpc ClearPayload (, )
points_service.proto:47Remove all payload for specified points
rpc Count (, )
points_service.proto:87Count points in collection with given filtering conditions
Create index for field in collection
rpc Delete (, )
points_service.proto:19Delete points
Delete field index for collection
rpc DeletePayload (, )
points_service.proto:43Delete specified key payload for points
rpc DeleteVectors (, )
points_service.proto:31Delete named vectors for points
rpc Get (, )
points_service.proto:23Retrieve points
Overwrite payload for points
rpc Recommend (, )
points_service.proto:75Look for the points which are closer to stored positive examples and at the same time further to negative examples.
Look for the points which are closer to stored positive examples and at the same time further to negative examples.
message
points.proto:282string collection_name = 1
Name of the collection
repeated recommend_points = 2
optional read_consistency = 3
Options for specifying read consistency guarantees
message
points.proto:411repeated result = 1
double time = 2
Time spent to process
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
message
points.proto:288string collection_name = 1
Name of the collection
repeated positive = 2
Look for vectors closest to those
repeated negative = 3
Try to avoid vectors like this
optional filter = 4
Filter conditions - return only those points that satisfy the specified conditions
uint32 limit = 5
Max number of groups in result
optional with_payload = 6
Options for specifying which payload to include or not
optional params = 7
Search config
optional float score_threshold = 8
If provided - cut off results with worse scores
optional string using = 9
Define which vector to use for recommendation, if not specified - default vector
optional with_vectors = 10
Options for specifying which vectors to include into response
optional lookup_from = 11
Name of the collection to use for points lookup, if not specified - use current collection
string group_by = 12
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.
uint32 group_size = 13
Maximum amount of points to return per group
optional read_consistency = 14
Options for specifying read consistency guarantees
message
points.proto:416optional result = 1
double time = 2
Time spent to process
rpc Scroll (, )
points_service.proto:71Iterate over all or filtered points points
rpc Search (, )
points_service.proto:59Retrieve closest points based on vector similarity and given filtering conditions
rpc SearchBatch (, )
points_service.proto:63Retrieve closest points based on vector similarity and given filtering conditions
message
points.proto:228string collection_name = 1
Name of the collection
repeated search_points = 2
optional read_consistency = 3
Options for specifying read consistency guarantees
rpc SearchGroups (, )
points_service.proto:67Retrieve closest points based on vector similarity and given filtering conditions, grouped by a given field
message
points.proto:234string collection_name = 1
Name of the collection
repeated float vector = 2
Vector to compare against
optional filter = 3
Filter conditions - return only those points that satisfy the specified conditions
uint32 limit = 4
Max number of result
optional with_payload = 5
Options for specifying which payload to include or not
optional params = 6
Search config
optional float score_threshold = 7
If provided - cut off results with worse scores
optional string vector_name = 8
Which vector to use for search, if not specified - use default vector
optional with_vectors = 9
Options for specifying which vectors to include into response
string group_by = 10
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.
uint32 group_size = 11
Maximum amount of points to return per group
optional read_consistency = 12
Options for specifying read consistency guarantees
message
points.proto:374optional result = 1
double time = 2
Time spent to process
rpc SetPayload (, )
points_service.proto:35Set payload for points
rpc UpdateVectors (, )
points_service.proto:27Update named vectors for point
rpc Upsert (, )
points_service.proto:15Perform insert + updates on points. If a point with a given ID already exists - it will be overwritten.
message
points_internal_service.proto:76optional clear_payload_points = 1
optional uint32 shard_id = 2
optional count_points = 1
optional uint32 shard_id = 2
message
points_internal_service.proto:81optional create_field_index_collection = 1
optional uint32 shard_id = 2
message
points_internal_service.proto:51optional delete_points = 1
optional uint32 shard_id = 2
message
points_internal_service.proto:86optional delete_field_index_collection = 1
optional uint32 shard_id = 2
message
points_internal_service.proto:71optional delete_payload_points = 1
optional uint32 shard_id = 2
message
points_internal_service.proto:61optional delete_vectors = 1
optional uint32 shard_id = 2
rpc Get (, )
points_internal_service.proto:28optional get_points = 1
optional uint32 shard_id = 2
optional recommend_points = 1
optional uint32 shard_id = 2
optional scroll_points = 1
optional uint32 shard_id = 2
message
points_internal_service.proto:91optional search_points = 1
optional uint32 shard_id = 2
message
points_internal_service.proto:96string collection_name = 1
repeated search_points = 2
optional uint32 shard_id = 3
rpc Sync (, )
points_internal_service.proto:13message
points_internal_service.proto:41optional sync_points = 1
optional uint32 shard_id = 2
message
points_internal_service.proto:56optional update_vectors = 1
optional uint32 shard_id = 2
message
points_internal_service.proto:46optional upsert_points = 1
optional uint32 shard_id = 2
service Qdrant
qdrant.proto:14rpc HealthCheck (, )
qdrant.proto:15message
qdrant.proto:18(message has no fields)
message
qdrant.proto:21string title = 1
string version = 2
service Raft
raft_service.proto:9DEPRECATED Its functionality is now included in `AddPeerToKnown` Send to bootstrap peer Proposes to add this peer as participant of consensus
rpc AddPeerToKnown (, )
raft_service.proto:18Send to bootstrap peer Adds peer to the network Returns all peers
message
raft_service.proto:41optional string uri = 1
optional uint32 port = 2
uint64 id = 3
message
raft_service.proto:31repeated all_peers = 1
uint64 first_peer_id = 2
rpc Send (, )
raft_service.proto:11Send Raft message to another peer
message
raft_service.proto:27bytes message = 1
rpc WhoIs (, )
raft_service.proto:14Send to bootstrap peer Returns uri by id if bootstrap knows this peer
message
raft_service.proto:51string uri = 1
rpc Create (, )
snapshots_service.proto:14Create collection snapshot
message
snapshots_service.proto:46string collection_name = 1
Name of the collection
rpc CreateFull (, )
snapshots_service.proto:26Create full storage snapshot
message
snapshots_service.proto:38(message has no fields)
rpc Delete (, )
snapshots_service.proto:22Delete collection snapshots
message
snapshots_service.proto:54string collection_name = 1
Name of the collection
string snapshot_name = 2
Name of the collection snapshot
rpc DeleteFull (, )
snapshots_service.proto:34List full storage snapshots
message
snapshots_service.proto:42string snapshot_name = 1
Name of the full snapshot
rpc List (, )
snapshots_service.proto:18List collection snapshots
message
snapshots_service.proto:50string collection_name = 1
Name of the collection
rpc ListFull (, )
snapshots_service.proto:30List full storage snapshots
message
snapshots_service.proto:40(message has no fields)
message
collections.proto:332Used in:
string alias_name = 1
Name of the alias
string collection_name = 2
Name of the collection
message
collections.proto:303Used in:
oneof action
create_alias = 1
rename_alias = 2
delete_alias = 3
message
points.proto:365Used in: ,
repeated result = 1
message
points.proto:114Used as request type in: Points.ClearPayload
Used as field type in:
string collection_name = 1
name of the collection
optional bool wait = 2
Wait until the changes have been applied?
optional points = 3
Affected points
optional ordering = 4
Write ordering guarantees
message
collections.proto:251Used in:
optional params = 1
Collection parameters
optional hnsw_config = 2
Configuration of vector index
optional optimizer_config = 3
Configuration of the optimizers
optional wal_config = 4
Configuration of the Write-Ahead-Log
optional quantization_config = 5
Configuration of the vector quantization
message
collections.proto:32Used in:
string name = 1
Name of the collection
message
collections.proto:285Used in:
CollectionStatus status = 1
operating condition of the collection
optional optimizer_status = 2
status of collection optimizers
uint64 vectors_count = 3
number of vectors in the collection
uint64 segments_count = 4
Number of independent segments
optional config = 7
Configuration
map<string, > payload_schema = 8
Collection data types
uint64 points_count = 9
number of points in the collection
optional uint64 indexed_vectors_count = 10
number of indexed vectors in the collection.
message
collections.proto:231Used as response type in: Collections.Create, Collections.Delete, Collections.Update, Collections.UpdateAliases, CollectionsInternal.Initiate
bool result = 1
if operation made changes
double time = 2
Time spent to process
message
collections.proto:236Used in:
uint32 shard_number = 3
Number of shards in collection
bool on_disk_payload = 4
If true - point's payload will not be stored in memory
optional vectors_config = 5
Configuration for vectors
optional uint32 replication_factor = 6
Number of replicas of each shard that network tries to maintain
optional uint32 write_consistency_factor = 7
How many replicas should apply the operation for us to consider it successful
message
collections.proto:246Used in:
optional uint32 replication_factor = 1
Number of replicas of each shard that network tries to maintain
optional uint32 write_consistency_factor = 2
How many replicas should apply the operation for us to consider it successful
Used in:
UnknownCollectionStatus = 0
Green = 1
All segments are ready
Yellow = 2
Optimization in process
Red = 3
Something went wrong
Used in:
x4 = 0
x8 = 1
x16 = 2
x32 = 3
x64 = 4
message
points.proto:431Used in:
oneof condition_one_of
field = 1
is_empty = 2
has_id = 3
filter = 4
is_null = 5
nested = 6
message
points.proto:305Used as request type in: Points.Count
Used as field type in:
string collection_name = 1
name of the collection
optional filter = 2
Filter conditions - return only those points that satisfy the specified conditions
optional bool exact = 3
If `true` - return exact count, if `false` - return approximate count
message
points.proto:379Used as response type in: Points.Count, PointsInternal.Count
optional result = 1
double time = 2
Time spent to process
message
points.proto:390Used in:
uint64 count = 1
message
collections.proto:311Used in:
string collection_name = 1
Name of the collection
string alias_name = 2
New name of the alias
message
points.proto:129Used as request type in: Points.CreateFieldIndex
Used as field type in:
string collection_name = 1
name of the collection
optional bool wait = 2
Wait until the changes have been applied?
string field_name = 3
Field name to index
optional FieldType field_type = 4
Field type.
optional field_index_params = 5
Payload index params.
optional ordering = 6
Write ordering guarantees
message
snapshots_service.proto:65Used as response type in: Snapshots.Create, Snapshots.CreateFull
optional snapshot_description = 1
double time = 2
Time spent to process
message
collections.proto:321Used in:
string alias_name = 1
Name of the alias
message
points.proto:138Used as request type in: Points.DeleteFieldIndex
Used as field type in:
string collection_name = 1
name of the collection
optional bool wait = 2
Wait until the changes have been applied?
string field_name = 3
Field name to delete
optional ordering = 4
Write ordering guarantees
message
points.proto:105Used as request type in: Points.DeletePayload
Used as field type in:
string collection_name = 1
name of the collection
optional bool wait = 2
Wait until the changes have been applied?
repeated string keys = 3
List of keys to delete
optional points_selector = 5
Affected points
optional ordering = 6
Write ordering guarantees
message
points.proto:88Used as request type in: Points.DeleteVectors
Used as field type in:
string collection_name = 1
name of the collection
optional bool wait = 2
Wait until the changes have been applied?
optional points_selector = 3
Affected points
optional vectors = 4
List of vector names to delete
optional ordering = 5
Write ordering guarantees
message
points.proto:60Used as request type in: Points.Delete
Used as field type in:
string collection_name = 1
name of the collection
optional bool wait = 2
Wait until the changes have been applied?
optional points = 3
Affected points
optional ordering = 4
Write ordering guarantees
message
snapshots_service.proto:75Used as response type in: Snapshots.Delete, Snapshots.DeleteFull
double time = 1
Time spent to process
Used in:
UnknownDistance = 0
Cosine = 1
Euclid = 2
Dot = 3
message
points.proto:459Used in:
string key = 1
optional match = 2
Check if point has field with a given value
optional range = 3
Check if points value lies in a given range
optional geo_bounding_box = 4
Check if points geolocation lies in a given area
optional geo_radius = 5
Check if geo point is within a given radius
optional values_count = 6
Check number of values for a specific field
Used in:
FieldTypeKeyword = 0
FieldTypeInteger = 1
FieldTypeFloat = 2
FieldTypeGeo = 3
FieldTypeText = 4
message
points.proto:425Used in: , , , , , , , ,
repeated should = 1
At least one of those conditions should match
repeated must = 2
All conditions must match
repeated must_not = 3
All conditions must NOT match
message
points.proto:496Used in:
optional top_left = 1
north-west corner
optional bottom_right = 2
south-east corner
message
points.proto:541Used in: ,
double lon = 1
double lat = 2
message
points.proto:501Used in:
optional center = 1
Center of the circle
float radius = 2
In meters
message
collections.proto:25Used as request type in: Collections.Get
Used as field type in:
string collection_name = 1
Name of the collection
message
collections.proto:36Used as response type in: Collections.Get, CollectionsInternal.Get
optional result = 1
double time = 2
Time spent to process
message
points.proto:67Used as request type in: Points.Get
Used as field type in:
string collection_name = 1
name of the collection
repeated ids = 2
List of points to retrieve
optional with_payload = 4
Options for specifying which payload to include or not
optional with_vectors = 5
Options for specifying which vectors to include into response
optional read_consistency = 6
Options for specifying read consistency guarantees
message
points.proto:401Used as response type in: Points.Get, PointsInternal.Get
repeated result = 1
double time = 2
Time spent to process
message
points.proto:340Used in:
oneof kind
uint64 unsigned_value = 1
Represents a double value.
int64 integer_value = 2
Represents an integer value
string string_value = 3
Represents a string value.
message
points.proto:356Used in: ,
repeated groups = 1
Groups
message
points.proto:450Used in:
repeated has_id = 1
message
collections.proto:87Used in: , ,
optional uint64 m = 1
Number of edges per node in the index graph. Larger the value - more accurate the search, more space required.
optional uint64 ef_construct = 2
Number of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build the index.
optional uint64 full_scan_threshold = 3
Minimal size (in KiloBytes) of vectors for additional payload-based indexing. If the payload chunk is smaller than `full_scan_threshold` additional indexing won'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
optional uint64 max_indexing_threads = 4
Number of parallel threads used for background index building. If 0 - auto selection.
optional bool on_disk = 5
Store HNSW index on disk. If set to false, the index will be stored in RAM.
optional uint64 payload_m = 6
Number of additional payload-aware links per node in the index graph. If not set - regular M parameter will be used.
message
points.proto:442Used in:
string key = 1
message
points.proto:446Used in:
string key = 1
message
collections.proto:337Used as response type in: Collections.ListAliases, Collections.ListCollectionAliases
repeated aliases = 1
double time = 2
Time spent to process
message
snapshots_service.proto:70Used as response type in: Snapshots.List, Snapshots.ListFull
repeated snapshot_descriptions = 1
double time = 2
Time spent to process
message
json_with_int.proto:60`ListValue` is a wrapper around a repeated field of values. The JSON representation for `ListValue` is a JSON array.
Used in:
repeated values = 1
Repeated field of dynamically typed values.
message
collections.proto:354Used in:
uint32 shard_id = 1
Local shard id
uint64 points_count = 2
Number of points in the shard
ReplicaState state = 3
Is replica active
message
points.proto:260Used in: ,
string collection_name = 1
optional string vector_name = 2
Which vector to use for search, if not specified - use default vector
message
points.proto:468Used in:
oneof match_value
string keyword = 1
Match string keyword
int64 integer = 2
Match integer
bool boolean = 3
Match boolean
string text = 4
Match text
keywords = 5
Match multiple keywords
integers = 6
Match multiple integers
except_integers = 7
Match any other value except those integers
except_keywords = 8
Match any other value except those keywords
message
collections.proto:381Used in:
uint32 shard_id = 1
Local shard id
uint64 from_peer_id = 2
uint64 to_peer_id = 3
message
points.proto:161Used in:
map<string, > vectors = 1
message
points.proto:454Used in:
string key = 1
Path to nested object
optional filter = 2
Filter condition
`NullValue` is a singleton enumeration to represent the null value for the `Value` type union. The JSON representation for `NullValue` is JSON `null`.
Used in:
NULL_VALUE = 0
Null value.
message
collections.proto:82Used in:
bool ok = 1
string error = 2
message
collections.proto:122Used in: , ,
optional double deleted_threshold = 1
The minimal fraction of deleted vectors in a segment, required to perform segment optimization
optional uint64 vacuum_min_vector_number = 2
The minimal number of vectors in a segment, required to perform segment optimization
optional uint64 default_segment_number = 3
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.
optional uint64 max_segment_size = 4
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.
optional uint64 memmap_threshold = 5
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
optional uint64 indexing_threshold = 6
Maximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing Default value is 20,000, based on <https://github.com/google-research/google-research/blob/master/scann/docs/algorithms.md>. To disable vector indexing, set to `0`. Note: 1kB = 1 vector of size 256.
optional uint64 flush_interval_sec = 7
Interval between forced flushes.
optional uint64 max_optimization_threads = 8
Max number of threads, which can be used for optimization. If 0 - `NUM_CPU - 1` will be used
message
points.proto:149Used in:
repeated string fields = 1
List of payload keys to exclude from the result
message
points.proto:145Used in:
repeated string fields = 1
List of payload keys to include into result
message
collections.proto:273Used in: ,
oneof index_params
text_index_params = 1
Parameters for text index
message
collections.proto:279Used in:
PayloadSchemaType data_type = 1
Field data type
optional params = 2
Field index parameters
optional uint64 points = 3
Number of points indexed within this field indexed
Used in:
UnknownType = 0
Keyword = 1
Integer = 2
Float = 3
Geo = 4
Text = 5
message
raft_service.proto:36Used in:
string uri = 1
uint64 id = 2
message
raft_service.proto:47Used as request type in: Raft.AddPeerAsParticipant, Raft.WhoIs
uint64 id = 1
message
points.proto:351Used in:
optional id = 1
Group id
repeated hits = 2
Points in the group
message
points.proto:38Used in: , , , , , , , , , , ,
oneof point_id_options
uint64 num = 1
Numerical ID of the point
string uuid = 2
UUID
message
points.proto:533Used in: ,
optional id = 1
map<string, > payload = 3
optional vectors = 4
message
points.proto:83Used in:
optional id = 1
ID to update vectors for
optional vectors = 2
Named vectors to update, leave others intact
message
points.proto:524Used in:
repeated ids = 1
message
points.proto:315Used as response type in: Points.ClearPayload, Points.CreateFieldIndex, Points.Delete, Points.DeleteFieldIndex, Points.DeletePayload, Points.DeleteVectors, Points.OverwritePayload, Points.SetPayload, Points.UpdateVectors, Points.Upsert, PointsInternal.ClearPayload, PointsInternal.CreateFieldIndex, PointsInternal.Delete, PointsInternal.DeleteFieldIndex, PointsInternal.DeletePayload, PointsInternal.DeleteVectors, PointsInternal.OverwritePayload, PointsInternal.SetPayload, PointsInternal.Sync, PointsInternal.UpdateVectors, PointsInternal.Upsert
optional result = 1
double time = 2
Time spent to process
message
points.proto:517Used in: , , , ,
oneof points_selector_one_of
points = 1
filter = 2
message
collections.proto:190Used in:
CompressionRatio compression = 1
Compression ratio
optional bool always_ram = 2
If true - quantized vectors always will be stored in RAM, ignoring the config of main storage
message
collections.proto:195Used in: , ,
oneof quantization
scalar = 1
product = 2
message
points.proto:183Used in:
optional bool ignore = 1
If set to true, search will ignore quantized vector data
optional bool rescore = 2
If true, use original vectors to re-score top-k results. Default is true.
Used in:
UnknownQuantization = 0
Int8 = 1
message
points.proto:489Used in:
optional double lt = 1
optional double gt = 2
optional double gte = 3
optional double lte = 4
message
points.proto:27Used in: , , , , , , ,
oneof value
ReadConsistencyType type = 1
Common read consistency configurations
uint64 factor = 2
Send request to a specified number of nodes, and return points which are present on all of them
Used in:
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 + 1 nodes, return points which are present on all of them
message
points.proto:265Used as request type in: Points.Recommend
Used as field type in: ,
string collection_name = 1
name of the collection
repeated positive = 2
Look for vectors closest to those
repeated negative = 3
Try to avoid vectors like this
optional filter = 4
Filter conditions - return only those points that satisfy the specified conditions
uint64 limit = 5
Max number of result
optional with_payload = 7
Options for specifying which payload to include or not
optional params = 8
Search config
optional float score_threshold = 9
If provided - cut off results with worse scores
optional uint64 offset = 10
Offset of the result
optional string using = 11
Define which vector to use for recommendation, if not specified - default vector
optional with_vectors = 12
Options for specifying which vectors to include into response
optional lookup_from = 13
Name of the collection to use for points lookup, if not specified - use current collection
optional read_consistency = 14
Options for specifying read consistency guarantees
message
points.proto:406Used as response type in: Points.Recommend, PointsInternal.Recommend
repeated result = 1
double time = 2
Time spent to process
message
collections.proto:360Used in:
uint32 shard_id = 1
Local shard id
uint64 peer_id = 2
Remote peer id
ReplicaState state = 3
Is replica active
message
collections.proto:316Used in:
string old_alias_name = 1
Name of the alias to rename
string new_alias_name = 2
Name of the alias
message
points.proto:485Used in:
repeated int64 integers = 1
message
points.proto:481Used in:
repeated string strings = 1
message
collections.proto:387Used in:
uint32 shard_id = 1
uint64 peer_id = 2
Used in: ,
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
message
points.proto:394Used in: ,
optional id = 1
map<string, > payload = 2
optional vectors = 4
message
collections.proto:184Used in:
QuantizationType type = 1
Type of quantization
optional float quantile = 2
Number of bits to use for quantization
optional bool always_ram = 3
If true - quantized vectors always will be stored in RAM, ignoring the config of main storage
message
points.proto:331Used in: , , ,
optional id = 1
Point id
map<string, > payload = 2
Payload
float score = 3
Similarity score
uint64 version = 5
Last update operation applied to this point
optional vectors = 6
Vectors to search
message
points.proto:249Used as request type in: Points.Scroll
Used as field type in:
string collection_name = 1
optional filter = 2
Filter conditions - return only those points that satisfy the specified conditions
optional offset = 3
Start with this ID
optional uint32 limit = 4
Max number of result
optional with_payload = 6
Options for specifying which payload to include or not
optional with_vectors = 7
Options for specifying which vectors to include into response
optional read_consistency = 8
Options for specifying read consistency guarantees
message
points.proto:384Used as response type in: Points.Scroll, PointsInternal.Scroll
optional next_page_offset = 1
Use this offset for the next query
repeated result = 2
double time = 3
Time spent to process
message
points.proto:369Used as response type in: Points.SearchBatch, PointsInternal.SearchBatch
repeated result = 1
double time = 2
Time spent to process
message
points.proto:195Used in: , , ,
optional uint64 hnsw_ef = 1
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.
optional bool exact = 2
Search without approximation. If set to true, search may run long but with exact results.
optional quantization = 3
If set to true, search will ignore quantized vector data
message
points.proto:213Used as request type in: Points.Search
Used as field type in: , ,
string collection_name = 1
name of the collection
repeated float vector = 2
vector
optional filter = 3
Filter conditions - return only those points that satisfy the specified conditions
uint64 limit = 4
Max number of result
optional with_payload = 6
Options for specifying which payload to include or not
optional params = 7
Search config
optional float score_threshold = 8
If provided - cut off results with worse scores
optional uint64 offset = 9
Offset of the result
optional string vector_name = 10
Which vector to use for search, if not specified - use default vector
optional with_vectors = 11
Options for specifying which vectors to include into response
optional read_consistency = 12
Options for specifying read consistency guarantees
message
points.proto:360Used as response type in: Points.Search, PointsInternal.Search
repeated result = 1
double time = 2
Time spent to process
message
points.proto:96Used as request type in: Points.OverwritePayload, Points.SetPayload
Used as field type in:
string collection_name = 1
name of the collection
optional bool wait = 2
Wait until the changes have been applied?
map<string, > payload = 3
New payload values
optional points_selector = 5
Affected points
optional ordering = 6
Write ordering guarantees
message
points_internal_service.proto:66Used as request type in: PointsInternal.OverwritePayload, PointsInternal.SetPayload
optional set_payload_points = 1
optional uint32 shard_id = 2
message
collections.proto:366Used in:
uint32 shard_id = 1
Local shard id
uint64 from = 2
uint64 to = 3
bool sync = 4
If `true` transfer is a synchronization of a replicas; If `false` transfer is a moving of a shard from one peer to another
message
snapshots_service.proto:59Used in: ,
string name = 1
Name of the snapshot
optional creation_time = 2
Creation time of the snapshot
int64 size = 3
Size of the snapshot in bytes
message
json_with_int.proto:17`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 object.
Used in:
map<string, > fields = 1
Unordered map of dynamically typed values.
message
points_internal_service.proto:32Used in:
string collection_name = 1
name of the collection
optional bool wait = 2
Wait until the changes have been applied?
repeated points = 3
optional from_id = 4
Start of the sync range
optional to_id = 5
End of the sync range
optional ordering = 6
message
collections.proto:266Used in:
TokenizerType tokenizer = 1
Tokenizer type
optional bool lowercase = 2
If true - all tokens will be lowercase
optional uint64 min_token_len = 3
Minimal token length
optional uint64 max_token_len = 4
Maximal token length
Used in:
Unknown = 0
Prefix = 1
Whitespace = 2
Word = 3
message
points.proto:76Used as request type in: Points.UpdateVectors
Used as field type in:
string collection_name = 1
name of the collection
optional bool wait = 2
Wait until the changes have been applied?
repeated points = 3
List of points and vectors to update
optional ordering = 4
Write ordering guarantees
message
points.proto:320Used in:
uint64 operation_id = 1
Number of operation
UpdateStatus status = 2
Operation status
Used in:
UnknownUpdateStatus = 0
Acknowledged = 1
Update is received, but not processed yet
Completed = 2
Update is applied and ready for search
message
points.proto:53Used as request type in: Points.Upsert
Used as field type in:
string collection_name = 1
name of the collection
optional bool wait = 2
Wait until the changes have been applied?
repeated points = 3
optional ordering = 4
Write ordering guarantees
message
json_with_int.proto:28`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.
Used in: , , , , ,
oneof kind
The kind of value.
NullValue null_value = 1
Represents a null value.
double double_value = 2
Represents a double value.
int64 integer_value = 3
Represents an integer value
string string_value = 4
Represents a string value.
bool bool_value = 5
Represents a boolean value.
struct_value = 6
Represents a structured value.
list_value = 7
Represents a repeated `Value`.
message
points.proto:506Used in:
optional uint64 lt = 1
optional uint64 gt = 2
optional uint64 gte = 3
optional uint64 lte = 4
message
points.proto:45Used in: ,
repeated float data = 1
message
collections.proto:6Used in: ,
uint64 size = 1
Size of the vectors
Distance distance = 2
Distance function used for comparing vectors
optional hnsw_config = 3
Configuration of vector HNSW graph. If omitted - the collection configuration will be used
optional quantization_config = 4
Configuration of vector quantization config. If omitted - the collection configuration will be used
optional bool on_disk = 5
If true - serve vectors from disk. If set to false, the vectors will be loaded in RAM.
message
collections.proto:14Used in:
map<string, > map = 1
message
points.proto:165Used in: , , ,
oneof vectors_options
vector = 1
vectors = 2
message
collections.proto:18Used in: ,
oneof config
params = 1
params_map = 2
message
points.proto:172Used in: ,
repeated string names = 1
List of vectors to include into result
message
collections.proto:117Used in: ,
optional uint64 wal_capacity_mb = 1
Size of a single WAL block file
optional uint64 wal_segments_ahead = 2
Number of segments to create in advance
message
points.proto:153Used in: , , , , ,
oneof selector_options
bool enable = 1
If `true` - return all payload, if `false` - none
include = 2
exclude = 3
message
points.proto:176Used in: , , , , ,
oneof selector_options
bool enable = 1
If `true` - return all vectors, if `false` - none
include = 2
List of payload keys to include into result
message
points.proto:17Used in: , , , , , , , , ,
WriteOrderingType type = 1
Write ordering guarantees
Used in:
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