Expand description
API types
Modules§
- alias_
operations - Nested message and enum types in
AliasOperations. - collections_
client - Generated client implementations.
- collections_
server - Generated server implementations.
- condition
- Nested message and enum types in
Condition. - count_
points_ builder - create_
collection_ builder - dense_
vector_ builder - expression
- Nested message and enum types in
Expression. - facet_
value - Nested message and enum types in
FacetValue. - group_
id - Nested message and enum types in
GroupId. - match
- Nested message and enum types in
Match. - max_
optimization_ threads - Nested message and enum types in
MaxOptimizationThreads. - multi_
dense_ vector_ builder - order_
value - Nested message and enum types in
OrderValue. - payload_
index_ params - Nested message and enum types in
PayloadIndexParams. - point_
id - Nested message and enum types in
PointId. - points_
client - Generated client implementations.
- points_
selector - Nested message and enum types in
PointsSelector. - points_
server - Generated server implementations.
- points_
update_ operation - Nested message and enum types in
PointsUpdateOperation. - qdrant_
client - Generated client implementations.
- qdrant_
server - Generated server implementations.
- quantization_
config - Nested message and enum types in
QuantizationConfig. - quantization_
config_ diff - Nested message and enum types in
QuantizationConfigDiff. - query
- Nested message and enum types in
Query. - read_
consistency - Nested message and enum types in
ReadConsistency. - shard_
key - Nested message and enum types in
ShardKey. - snapshots_
client - Generated client implementations.
- snapshots_
server - Generated server implementations.
- sparse_
vector_ builder - sparse_
vectors_ config - start_
from - Nested message and enum types in
StartFrom. - target_
vector - Nested message and enum types in
TargetVector. - update_
collection_ cluster_ setup_ request - Nested message and enum types in
UpdateCollectionClusterSetupRequest. - value
- Nested message and enum types in
Value. - vector
- Nested message and enum types in
Vector. - vector_
example - Nested message and enum types in
VectorExample. - vector_
input - Nested message and enum types in
VectorInput. - vector_
output - Nested message and enum types in
VectorOutput. - vectors
- Nested message and enum types in
Vectors. - vectors_
config - Nested message and enum types in
VectorsConfig. - vectors_
config_ diff - Nested message and enum types in
VectorsConfigDiff. - vectors_
output - Nested message and enum types in
VectorsOutput. - with_
payload_ selector - Nested message and enum types in
WithPayloadSelector. - with_
vectors_ selector - Nested message and enum types in
WithVectorsSelector.
Structs§
- Abort
Shard Transfer - Abort
Shard Transfer Builder - Alias
Description - Alias
Operations - Batch
Result - Binary
Quantization - Binary
Quantization Builder - Bool
Index Params - Bool
Index Params Builder - Change
Aliases - Clear
Payload Points - Clear
Payload Points Builder - Collection
Cluster Info Request - Collection
Cluster Info Response - Collection
Config - Collection
Description - Collection
Exists - Collection
Exists Request - Collection
Exists Response - Collection
Info - Collection
Operation Response - Collection
Params - Collection
Params Diff - Collection
Params Diff Builder - Condition
- Context
Example Pair - Context
Example Pair Builder - Context
Input - Context
Input Builder - Context
Input Pair - Context
Input Pair Builder - Count
Points - Count
Points Builder - Count
Response - Count
Result - Create
Alias - Create
Alias Builder - Create
Collection - Create
Collection Builder - Create
Field Index Collection - Create
Field Index Collection Builder - Create
Full Snapshot Request - Create
Shard Key - Create
Shard KeyBuilder - Create
Shard KeyRequest - Create
Shard KeyRequest Builder - Create
Shard KeyResponse - Create
Snapshot Request - Create
Snapshot Response - Datetime
Index Params - Datetime
Index Params Builder - Datetime
Range - Decay
Params Expression - Decay
Params Expression Builder - Builder for the DecayParamsExpression struct, which represents parameters for decay functions.
- Delete
Alias - Delete
Collection - Delete
Collection Builder - Delete
Field Index Collection - Delete
Field Index Collection Builder - Delete
Full Snapshot Request - Delete
Payload Points - Delete
Payload Points Builder - Delete
Point Vectors - Delete
Point Vectors Builder - Delete
Points - Delete
Points Builder - Delete
Shard Key - Delete
Shard KeyRequest - Delete
Shard KeyRequest Builder - Delete
Shard KeyResponse - Delete
Snapshot Request - Delete
Snapshot Request Builder - Delete
Snapshot Response - Dense
Vector - Dense
Vector Builder - Disabled
- Discover
Batch Points - Discover
Batch Points Builder - Discover
Batch Response - Discover
Input - Discover
Input Builder - Discover
Points - Discover
Points Builder - Discover
Response - DivExpression
- Document
- Expression
- Facet
Counts - Facet
Counts Builder - Facet
Hit - Facet
Response - Facet
Value - Field
Condition - Filter
- Float
Index Params - Float
Index Params Builder - Formula
- Formula
Builder - Builder for the Formula struct, which represents a scoring formula for points.
- GeoBounding
Box - GeoDistance
- GeoIndex
Params - GeoIndex
Params Builder - GeoLine
String - GeoPoint
- GeoPolygon
- For a valid GeoPolygon, both the exterior and interior GeoLineStrings must consist of a minimum of 4 points. Additionally, the first and last points of each GeoLineString must be the same.
- GeoRadius
- GetCollection
Info Request - GetCollection
Info Response - GetPoints
- GetPoints
Builder - GetResponse
- GroupId
- Groups
Result - Hardware
Usage - HasId
Condition - HasVector
Condition - Health
Check Reply - Health
Check Request - Hnsw
Config Diff - Hnsw
Config Diff Builder - Image
- Inference
Object - Integer
Index Params - Integer
Index Params Builder - IsEmpty
Condition - IsNull
Condition - Keyword
Index Params - Keyword
Index Params Builder - List
Aliases Request - List
Aliases Response - List
Collection Aliases Request - List
Collections Request - List
Collections Response - List
Full Snapshots Request - List
Snapshots Request - List
Snapshots Response - List
Value ListValueis a wrapper around a repeated field of values.- Local
Shard Info - Lookup
Location - Lookup
Location Builder - Match
- MaxOptimization
Threads - MaxOptimization
Threads Builder - Max number of threads (jobs) for running optimizations per shard.
Each optimization job will also use
max_indexing_threadsthreads by itself for index building. - MinShould
- Move
Shard - Move
Shard Builder - Mult
Expression - Multi
Dense Vector - Multi
Dense Vector Builder - Multi
Vector Config - Multi
Vector Config Builder - Named
Vectors - Named
Vectors Output - Nested
Condition - Optimizer
Status - Optimizers
Config Diff - Optimizers
Config Diff Builder - OrderBy
- Order
ByBuilder - Order
Value - Payload
Exclude Selector - Payload
Include Selector - Payload
Index Params - Payload
Schema Info - Point
Group - PointId
- Point
Struct - Point
Vectors - Points
IdsList - Points
Operation Response - Points
Selector - Points
Update Operation - PowExpression
- Prefetch
Query - Prefetch
Query Builder - Product
Quantization - Product
Quantization Builder - Quantization
Config - Quantization
Config Diff - Quantization
Search Params - Quantization
Search Params Builder - Query
- Query
Batch Points - Query
Batch Points Builder - Query
Batch Response - Query
Groups Response - Query
Point Groups - Query
Point Groups Builder - Query
Points - Query
Points Builder - Query
Response - Range
- Read
Consistency - Recommend
Batch Points - Recommend
Batch Points Builder - Recommend
Batch Response - Recommend
Groups Response - Recommend
Input - Recommend
Input Builder - Recommend
Point Groups - Recommend
Point Groups Builder - Recommend
Points - Recommend
Points Builder - Recommend
Response - Remote
Shard Info - Rename
Alias - Rename
Alias Builder - Repeated
Integers - Repeated
Strings - Replica
- Replica
Builder - Replicate
Shard - Replicate
Shard Builder - Resharding
Info - Restart
Transfer - Retrieved
Point - Scalar
Quantization - Scalar
Quantization Builder - Scored
Point - Scroll
Points - Scroll
Points Builder - Scroll
Response - Search
Batch Points - Search
Batch Points Builder - Search
Batch Response - Search
Groups Response - Search
Matrix Offsets - Search
Matrix Offsets Response - Search
Matrix Pair - Search
Matrix Pairs - Search
Matrix Pairs Response - Search
Matrix Points - Search
Matrix Points Builder - Search
Params - Search
Params Builder - Search
Point Groups - Search
Point Groups Builder - Search
Points - Search
Points Builder - Search
Response - SetPayload
Points - SetPayload
Points Builder - Shard
Key - Shard
KeySelector - Shard
Transfer Info - Snapshot
Description - Snapshot
Download - Snapshot
Download Builder - Builder for
SnapshotDownload. - Sparse
Index Config - Sparse
Index Config Builder - Sparse
Indices - Sparse
Vector - Sparse
Vector Builder - Sparse
Vector Config - Sparse
Vector Params - Sparse
Vector Params Builder - Sparse
Vectors Config Builder - Start
From - Strict
Mode Config - Strict
Mode Config Builder - Strict
Mode Multivector - Strict
Mode Multivector Config - Strict
Mode Multivector Config Builder - Builder for StrictModeMultivectorConfig, which defines multivector configuration for strict mode.
- Strict
Mode Sparse - Strict
Mode Sparse Config - Strict
Mode Sparse Config Builder - Builder for StrictModeSparseConfig, which defines sparse vector configuration for strict mode.
- Struct
Structrepresents a structured data value, consisting of fields which map to dynamically typed values. In some languages,Structmight 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.- SumExpression
- Target
Vector - Text
Index Params - Text
Index Params Builder - Timestamp
- A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.
- Update
Batch Points - Update
Batch Points Builder - Update
Batch Response - Update
Collection - Update
Collection Builder - Update
Collection Cluster Setup Request - Update
Collection Cluster Setup Request Builder - Update
Collection Cluster Setup Response - Update
Point Vectors - Update
Point Vectors Builder - Update
Result - Upsert
Points - Upsert
Points Builder - Uuid
Index Params - Uuid
Index Params Builder - Value
Valuerepresents 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.- Values
Count - Vector
- Legacy vector format, which determines the vector type by the configuration of its fields.
- Vector
Example - Vector
Input - Vector type to be used in queries. Ids will be substituted with their corresponding vectors from the collection.
- Vector
Output - Vector
Params - Vector
Params Builder - Vector
Params Diff - Vector
Params Diff Builder - Vector
Params Diff Map - Vector
Params Map - Vectors
- Vectors
Config - Vectors
Config Builder - Vectors
Config Diff - Vectors
Output - Vectors
Selector - WalConfig
Diff - WalConfig
Diff Builder - With
Lookup - With
Lookup Builder - With
Payload Selector - With
Vectors Selector - Write
Ordering
Enums§
- Collection
Status - Compression
Ratio - Count
Points Builder Error - Error type for CountPointsBuilder
- Datatype
- Direction
- Distance
- Field
Type - Fusion
- Modifier
- Multi
Vector Comparator - Null
Value NullValueis a singleton enumeration to represent the null value for theValuetype union.- Payload
Schema Type - Quantization
Type - Read
Consistency Type - Recommend
Example - Recommend
Strategy - How to use positive and negative vectors to find the results, default is
AverageVector. - Replica
State - Resharding
Direction - Resharding direction, scale up or down in number of shards
- Sample
- Sample points from the collection
- Shard
Transfer Method - Sharding
Method - Snapshot
Download Builder Error - Error type for SnapshotDownloadBuilder
- Tokenizer
Type - Update
Status - Write
Ordering Type