Skip to main content Crate qdrant_edge Copy item path Source bm25_embed Edge-side BM25 wiring. config Configuration for crate::EdgeShard external Re-export from external crates used by Qdrant. internal AcornSearchParams ACORN-related search parameters BinaryQuantizationConfig BoolIndexParams ConditionalInsertOperation ContextPair ContextQuery CountRequest Count request — counts the number of points which match the given conditions.
If no filter is provided, the count of all points in the shard is returned. CountRequestBuilder Fluent builder for CountRequest CreateIndex CreateVectorName DateTimeWrapper Wraps DateTime<Utc> to allow more flexible deserialization DatetimeIndexParams DeletePayloadOp This data structure is used inside shard operations queue
and supposed to be written into WAL of individual shard. DeleteVectorName DenseVectorConfig Configuration for creating a new dense named vector. DiscoverQuery EdgeConfig Full configuration for an edge shard. EdgeConfigBuilder Fluent builder for EdgeConfig EdgeOptimizersConfig Optimizer-related parameters for the edge shard. EdgeShard EdgeSparseVectorParams User-facing sparse vector parameters. EdgeSparseVectorParamsBuilder Fluent builder for EdgeSparseVectorParams EdgeVectorParams User-facing dense vector parameters. EdgeVectorParamsBuilder Fluent builder for EdgeVectorParams FacetHit FacetRequest Facet request — counts the number of points for each unique value of a payload key. FacetRequestBuilder Fluent builder for FacetRequest FacetResponse FeedbackItem FeedbackNaiveQuery Akin to external representation of the query. Unoptimized for scoring. FieldCondition All possible payload filtering conditions Filter FloatIndexParams Formula FullyQualifiedPoint A point resolved to everything a segment needs in order to store it:
storing a fully qualified point reads nothing back. GeoBoundingBox Geo filter request GeoIndexParams GeoLineString Ordered sequence of GeoPoints representing the line GeoPoint Geo point payload schema GeoPolygon Geo filter request GeoRadius Geo filter request Group A group of points that share the same value of the group_by field. GroupRequest Group the results of a base query by a payload field. GroupRequestBuilder Fluent builder for GroupRequest HasIdCondition ID-based filtering condition HasVectorCondition Filter points which have specific vector assigned HnswIndexConfig Config of HNSW index IdfCorpusParams IDF statistics computed over the points matching a corpus filter. IntegerIndexParams IsEmptyCondition Select points with empty payload for a specified field IsNullCondition Select points with null payload for a specified field JsonPath KeywordIndexParams LoadProfile Which components of a read-only segment a specific request needs warmed. LocalSegmentEnumerator SegmentEnumeratorsegments/ directory. Wired
automatically by ReadOnlyEdgeShard::open_mmapManifestSegmentEnumerator SegmentEnumeratorsegments_manifest.json, sitting
next to the segments/ directory) and returns its readable segments — active, plus
optimizing ones which stay live until their rebuild’s swap. Errors if no manifest is present:
the manifest is the source of truth, so a follower using this enumerator requires the leader to
write one (the write_segment_manifest feature flag).MatchAny Exact match on any of the given values MatchExcept Should have at least one value not matching the any given values MatchPhrase Full-text phrase match of the string. MatchPrefix Match keyword values that start with the given string. MatchText Full-text match of the strings. MatchTextAny Full-text match of at least one token of the string. MatchValue Exact match of the given value MinShould Mmr Maximal Marginal Relevance configuration MultiVectorConfig NaiveFeedbackStrategy Trained coefficients for the formula. Specific to a triplet of dataset-smallmodel-bigmodel. NamedQuery NamedVectors Named vectors map. Nested Select points with payload for a specified nested field NestedCondition OrderBy Payload PayloadConfig Keeps information of which field should be index PayloadIndexInfo Display payload field type & index information PayloadSelectorExclude PayloadSelectorInclude PointCopy One stored copy of a point: which segment holds it, in which slot, at what
version. PointIdsList PointPreview What the batch does to one point. PointStruct PointStructPersisted PointSyncOperation PointUpdates Everything a batch does to one point, in operation order. PointVectorsPersisted Prefetch One prefetch stage of a QueryRequest PrefetchBuilder Fluent builder for Prefetch ProductQuantizationConfig QuantizationSearchParams Additional parameters of the search QueryRequest Universal query over an edge shard: a scoring query with optional prefetch stages. QueryRequestBuilder Fluent builder for QueryRequest Range Range filter request ReadOnlyEdgeShard Read-only follower view over an edge shard’s on-disk directory. RecommendQuery Record Point data RetrieveRequest Retrieve points by their ids. The response preserves the requested id order and skips
ids that do not exist in the shard. RetrieveRequestBuilder Fluent builder for RetrieveRequest ScalarQuantizationConfig ScoredPoint Search result ScrollRequest Scroll request — paginate over all points which match the given conditions. ScrollRequestBuilder Fluent builder for ScrollRequest SearchMatrixRequest A single-shard distance-matrix request: sample sample_size random points that
carry the using vector, then find each sample’s limit_per_sample nearest
neighbours restricted to the sampled set. SearchMatrixRequestBuilder Fluent builder for SearchMatrixRequest SearchMatrixResponse SearchParams Additional parameters of the search SearchRequest Single-query vector search over an edge shard. SearchRequestBuilder Fluent builder for SearchRequest SegmentConfig SegmentConfigInfo One segment’s schema, as reported by
UpdateOnlyEdgeShard::segment_configs SegmentState Persistable state of segment configuration SegmentsManifest Contents of segments_manifest.json: a flat map of segment UUID to its state, e.g.
{ "1b4e28ba-...": "active", "6ba7b810-...": "active" }. SetPayloadOp This data structure is used inside shard operations queue
and supposed to be written into WAL of individual shard. ShardInfo Slice One of total disjoint deterministic slices of the id space. SliceCondition Select points that fall into one of total disjoint deterministic slices
of the id space, for parallel scans and reproducible sampling. SnowballParams SparseVector Sparse vector structure SparseVectorConfig Configuration for creating a new sparse named vector. SparseVectorDataConfig Config of single sparse vector data storage StopwordsSet TextIndexParams TypedMultiDenseVector Type for multi dense vector UpdateBatchOutcome What a batch did, counted per point rather than per operation: a point
named by ten operations counts once. UpdateBatchPlan A batch of update operations, collapsed to one entry per touched point. UpdateBatchPreview A resolved batch: one entry per touched point, in first-touched order. UpdateOnlyEdgeShard A batch writer over the segments of one shard directory, generic over the
backend S. UpdateVectorsOp UuidIndexParams ValuesCount Values count filter request Vector Single vector. VectorDataConfig Config of single vector data storage Vectors Collection of vectors for a point. WalOptions Re-export WAL configuration for advanced/embedded use cases. AnyVariants BinaryQuantizationEncoding BinaryQuantizationQueryEncoding CompressionRatio Condition DecayKind Direction Distance Type of internal tags, build from payload
Distance function types used to compare vectors Expression FacetValue FieldIndexOperations Fusion IdfParams Population over which sparse vector IDF statistics are computed for scoring —
the IDF corpus . IdfScope Named IDF scope without a corpus filter. Language Match Match filter request Modifier If used, include weight modification, which will be applied to sparse vectors at query time:
None - no modification (default)
Idf - inverse document frequency, based on statistics of the collection MultiVectorComparator OperationError OrderByInterface OrderValue PayloadFieldSchema PayloadOps Define operations description for point payloads manipulation PayloadSchemaParams Payload type with parameters PayloadSchemaType All possible names of payload types PayloadSelector Specifies how to treat payload selector PointAction The write one point’s folded mutations resolved to. PointId Type, used for specifying point ID in user interface PointInsertOperations PointOperations QuantizationConfig QueryEnum Every kind of vector query that can be performed on segment level. RangeInterface Sample ScalarType ScoringQuery Same as Query, but with the resolved vector references. SegmentManifestState State of a segment in the manifest. SnowballLanguage Languages supported by snowball stemmer. StartFrom TokenizerType UpdateMode Defines the mode of the upsert operation UpdateOperation ValueVariants VectorInternal VectorNameConfig Configuration for creating a new named vector. VectorNameOperations Operations for creating and deleting named vectors at the shard level.
Serialized into WAL. VectorOperations VectorPersisted Single vector data, as it is persisted in WAL
Unlike [api::rest::Vector], this struct only stores raw vectors, inferenced or resolved.
Unlike VectorInternal VectorStorageDatatype Storage types for vectors VectorStructInternal Full vector data per point separator with single and multiple vector modes VectorStructPersisted Data structure for point vectors, as it is persisted in WAL WithPayloadInterface Options for specifying which payload to include or not WithVector Options for specifying which vector to include DEFAULT_VECTOR_NAME PAYLOAD_INDEX_CONFIG_FILE SEGMENT_STATE_FILE EdgeShardRead Read API shared by the read-write EdgeShard ReadSegmentHandle A handle to a single segment that can be read-locked to yield a [ReadSegmentEntry]. SegmentEnumerator Enumerates the segments that make up the shard, keyed by their UUID. get_payload_index_path FacetValueHit OperationResult