Expand description
Public request, response, configuration, filtering, and mutation types.
Structs§
- Collection
Config - Collection-wide vector and index configuration.
- Collection
Info - Metadata for a named or historical collection view.
- Count
Result - A count and the immutable root from which it was read.
- Delete
Selector - Selects the union of typed IDs and filter matches for deletion.
- Diff
Result - 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.
- History
Entry - One named-collection commit in newest-first history order.
- Index
Config - Deterministic approximate-query defaults.
- Match
Value - A JSON scalar value required by a field-match condition.
- Mutation
Result - The outcome of one atomic mixed-mutation batch.
- Object
Id - A hexadecimal Git object ID that identifies a tree or commit.
- Object
Stats - 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.
- Query
Params - Exact or approximate query execution parameters.
- Query
Result - Ordered similarity-search results and execution statistics.
- Query
Stats - Work counters for a completed query.
- Range
- Inclusive or exclusive numeric bounds for a payload field.
- Record
- A point returned without similarity scoring.
- Scored
Point - A scored query winner.
- Snapshot
Info - Metadata for an immutable root snapshot.
- Validation
Report - Result of basic or full canonical-root validation.
- Write
Result - 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.
- Query
Mode - Query algorithm selected after applying collection defaults.
- Snapshot
Mutation - One operation in an ordered immutable-root mutation batch.
Type Aliases§
- Json
Object - A JSON object used for point payloads.