Skip to main content

Module model

Module model 

Source
Expand description

Public request, response, configuration, filtering, and mutation types.

Structs§

CollectionConfig
Collection-wide vector and index configuration.
CollectionInfo
Metadata for a named or historical collection view.
CountResult
A count and the immutable root from which it was read.
DeleteSelector
Selects the union of typed IDs and filter matches for deletion.
DiffResult
Logical point and structural-sharing differences between two roots.
Filter
A Boolean point filter.
GetRequest
A deterministic point-retrieval request.
GetResult
Canonically ordered point-retrieval results.
HistoryEntry
One named-collection commit in newest-first history order.
IndexConfig
Deterministic approximate-query defaults.
MatchValue
A JSON scalar value required by a field-match condition.
MutationResult
The outcome of one atomic mixed-mutation batch.
ObjectId
A hexadecimal Git object ID that identifies a tree or commit.
ObjectStats
Count and logical size of a set of reachable Git objects.
Point
A vector and its optional JSON payload, identified by a typed ID.
Query
A vector similarity query.
QueryParams
Exact or approximate query execution parameters.
QueryResult
Ordered similarity-search results and execution statistics.
QueryStats
Work counters for a completed query.
Range
Inclusive or exclusive numeric bounds for a payload field.
Record
A point returned without similarity scoring.
ScoredPoint
A scored query winner.
SnapshotInfo
Metadata for an immutable root snapshot.
ValidationReport
Result of basic or full canonical-root validation.
WriteResult
The outcome of a named collection write.

Enums§

Condition
A predicate used inside a Filter.
Distance
The vector distance used for ranking.
PointId
A typed point identifier.
QueryMode
Query algorithm selected after applying collection defaults.
SnapshotMutation
One operation in an ordered immutable-root mutation batch.

Type Aliases§

JsonObject
A JSON object used for point payloads.