qdrant-client API reference
94 public APIs from qdrant-client (qdrant/qdrant-client) — 87 classes, 7 functions, 0 methods. Signatures extracted by static analysis of the actual source.
Repository: qdrant/qdrant-client
| Kind | Count |
|---|---|
| Classes | 87 |
| Functions | 7 |
| Methods | 0 |
API list
class
qdrant_client.common.client_exceptions.QdrantExceptionBase class
class
qdrant_client.embed.schema_parser.ModelSchemaParserModel schema parser.
func
qdrant_client.embed.utils.read_base64(file_path:str | Path) -> strConvert a file path to a base64 encoded string.
class
qdrant_client.grpc.qdrant_pb2_grpc.QdrantMissing associated documentation comment in .proto file.
class
qdrant_client.http.exceptions.ApiExceptionBase class
class
qdrant_client.http.models.models.AcornSearchParamsACORN-related search parameters
class
qdrant_client.http.models.models.Bm25ConfigConfiguration of the local bm25 models.
class
qdrant_client.http.models.models.ClusterStatusOneOf1Description of enabled cluster
class
qdrant_client.http.models.models.CollectionClusterInfoCurrent clustering distribution for the collection
class
qdrant_client.http.models.models.CollectionConfigInformation about the collection configuration
class
qdrant_client.http.models.models.CollectionInfoCurrent statistics and configuration of the collection
class
qdrant_client.http.models.models.CollectionStatusCurrent state of the collection.
class
qdrant_client.http.models.models.CreateAliasCreate alternative name for a collection.
class
qdrant_client.http.models.models.DatetimeRangeRange filter request
class
qdrant_client.http.models.models.DeleteAliasDelete alias if exists
class
qdrant_client.http.models.models.DeleteAliasOperationDelete alias if exists
class
qdrant_client.http.models.models.DenseVectorConfigConfiguration for creating a new dense named vector.
class
qdrant_client.http.models.models.DenseVectorNameConfigWrapper for dense vector creation config.
class
qdrant_client.http.models.models.FieldConditionAll possible payload filtering conditions
class
qdrant_client.http.models.models.GeoLineStringOrdered sequence of GeoPoints representing the line
class
qdrant_client.http.models.models.GeoPointGeo point payload schema
class
qdrant_client.http.models.models.HasIdConditionID-based filtering condition
class
qdrant_client.http.models.models.HasVectorConditionFilter points which have specific vector assigned
class
qdrant_client.http.models.models.HnswConfigConfig of HNSW index
class
qdrant_client.http.models.models.IdfScopeNamed IDF scope without a corpus filter.
class
qdrant_client.http.models.models.IndexesOneOf1Use filterable HNSW index for approximate search.
class
qdrant_client.http.models.models.IoBackendUniversal I/O backend that is used to read files.
class
qdrant_client.http.models.models.IsEmptyConditionSelect points with empty payload for a specified field
class
qdrant_client.http.models.models.IsNullConditionSelect points with null payload for a specified field
class
qdrant_client.http.models.models.LookupLocationDefines a location to use for looking up the vector.
class
qdrant_client.http.models.models.LowMemoryModeOneOfNo special handling.
class
qdrant_client.http.models.models.MatchAnyExact match on any of the given values
class
qdrant_client.http.models.models.MatchPhraseFull-text phrase match of the string.
class
qdrant_client.http.models.models.MatchPrefixMatch keyword values that start with the given string.
class
qdrant_client.http.models.models.MatchTextFull-text match of the strings.
class
qdrant_client.http.models.models.MatchTextAnyFull-text match of at least one token of the string.
class
qdrant_client.http.models.models.MatchValueExact match of the given value
class
qdrant_client.http.models.models.MemoryMemory placement of a component's data.
class
qdrant_client.http.models.models.MessageSendErrorsMessage send failures for a particular peer
class
qdrant_client.http.models.models.NestedSelect points with payload for a specified nested field
class
qdrant_client.http.models.models.NoStemmerTag selecting the explicit 'no stemming' algorithm.
class
qdrant_client.http.models.models.OptimizationsResponseOptimizations progress for the collection
class
qdrant_client.http.models.models.OptimizersStatusOneOfOptimizers are reporting as expected
class
qdrant_client.http.models.models.OptimizersStatusOneOf1Something wrong happened with optimizers
class
qdrant_client.http.models.models.PayloadFieldPayload field
class
qdrant_client.http.models.models.PayloadIndexInfoDisplay payload field type & index information
class
qdrant_client.http.models.models.PayloadSchemaTypeAll possible names of payload types
class
qdrant_client.http.models.models.PayloadStorageParamsParams of the payload storage
class
qdrant_client.http.models.models.PeerInfoInformation of a peer in the cluster
class
qdrant_client.http.models.models.PeerMetadataMetadata describing extra properties for each peer
class
qdrant_client.http.models.models.PeerQuotaUsageWhat one peer reports about the quota it is enforcing.
class
qdrant_client.http.models.models.QuantizationSearchParamsAdditional parameters of the search
class
qdrant_client.http.models.models.QuotaConfigCluster-wide limits on node resources.
class
qdrant_client.http.models.models.QuotaTelemetryWhat a node reports about the quota it is enforcing.
class
qdrant_client.http.models.models.RaftInfoSummary information about the current raft state
class
qdrant_client.http.models.models.RangeRange filter request
class
qdrant_client.http.models.models.RecordPoint data
class
qdrant_client.http.models.models.RenameAliasChange alias to a new one
class
qdrant_client.http.models.models.RenameAliasOperationChange alias to a new one
class
qdrant_client.http.models.models.ReplicaStateState of the single shard within a replica set.
class
qdrant_client.http.models.models.RrfParameters for Reciprocal Rank Fusion
class
qdrant_client.http.models.models.ScoredPointSearch result
class
qdrant_client.http.models.models.ScrollResultResult of the points read request
class
qdrant_client.http.models.models.SearchMatrixPairPair of points (a, b) with score
class
qdrant_client.http.models.models.SearchParamsAdditional parameters of the search
class
qdrant_client.http.models.models.SearchThreadPoolTelemetryLive snapshot of the adaptive search routing.
class
qdrant_client.http.models.models.SegmentInfoAggregated information about segment
class
qdrant_client.http.models.models.SegmentTypeType of segment
class
qdrant_client.http.models.models.SnowballLanguageLanguages supported by snowball stemmer.
class
qdrant_client.http.models.models.SparseIndexConfigConfiguration for sparse inverted index.
class
qdrant_client.http.models.models.SparseIndexParamsConfiguration for sparse inverted index.
class
qdrant_client.http.models.models.SparseIndexTypeOneOfMutable RAM sparse index
class
qdrant_client.http.models.models.SparseIndexTypeOneOf1Immutable RAM sparse index
class
qdrant_client.http.models.models.SparseIndexTypeOneOf2Mmap sparse index
class
qdrant_client.http.models.models.SparseVectorSparse vector structure
class
qdrant_client.http.models.models.SparseVectorConfigConfiguration for creating a new sparse named vector.
class
qdrant_client.http.models.models.SparseVectorDataConfigConfig of single sparse vector data storage
class
qdrant_client.http.models.models.SparseVectorNameConfigWrapper for sparse vector creation config.
class
qdrant_client.http.models.models.SparseVectorParamsParams of single sparse vector data storage
class
qdrant_client.http.models.models.SparseVectorStorageTypeOneOfStorage in memory maps (gridstore storage)
class
qdrant_client.http.models.models.StateRoleRole of the peer in the consensus
class
qdrant_client.http.models.models.TrackerTelemetryTracker object used in telemetry
class
qdrant_client.http.models.models.ValuesCountValues count filter request
class
qdrant_client.http.models.models.VectorDataConfigConfig of single vector data storage
class
qdrant_client.http.models.models.VectorParamsParams of single vector data storage
class
qdrant_client.http.models.models.VectorStorageDatatypeStorage types for vectors
class
qdrant_client.local.async_qdrant_local.AsyncQdrantLocalEverything Qdrant server can do, but locally.
func
qdrant_client.local.datetime_utils.parse(date_str:str) -> datetime | NoneParses one section of the date string at a time.
func
qdrant_client.local.payload_value_extractor.parse_uuid(value:Any) -> uuid.UUID | NoneParse UUID from value.
func
qdrant_client.local.payload_value_extractor.value_by_key(payload:dict[str, Any], key:str, flat:bool=True) -> list[Any] | NoneGet value from payload by key.
func
qdrant_client.local.payload_value_setter.set_value_by_key(payload:dict, keys:list[JsonPathItem], value:Any) -> NoneSet value in payload by key.
class
qdrant_client.local.qdrant_local.QdrantLocalEverything Qdrant server can do, but locally.
func
qdrant_client.local.siphash.siphash24(data:bytes, key0:int=0, key1:int=0) -> intSipHash-2-4 (2 compression rounds, 4 finalization rounds).
func
qdrant_client.uploader.uploader.iter_batch(iterable:Iterable | Generator, size:int) -> Iterable>>> list(iter_batch([1,2,3,4,5], 3)) [[1, 2, 3], [4, 5]]
About this data
These signatures were extracted from the public source of qdrant/qdrant-client
using Python's ast module. Argument names, default values,
type annotations and return types are taken verbatim from the code.
Implementation bodies are never stored. See
how it works for details.