Expand description
Core types for the lance-context storage layer.
Modules§
Structs§
- AbReport
- Result of comparing the same query set across two dataset versions.
- Compaction
Config - Configuration for background compaction.
- Compaction
Metrics - Metrics returned by compact_files.
- Compaction
Stats - Statistics about compaction status and history.
- Context
- Context
Entry - Context
Namespace - Thin resolver for scoped context partitions under one namespace root.
- Context
Record - User-facing representation of a context entry written to storage.
- Context
Store - Persistent Lance-backed context store.
- Context
Store Options - Additional configuration when opening a
ContextStore. - Distribution
- Numeric distribution summary.
- Eval
Config - Runtime configuration for an evaluation run.
- Eval
Query - One labeled query: a vector and/or text channel plus its relevant records.
- Eval
Query Set - A labeled query set, referenced by a stable
idfor reproducible reports. - Eval
Report - A reproducible evaluation report: a manifest (query-set id, version, config) plus aggregate and per-query scores.
- Excluded
Counts - Source records excluded during curation, by reason.
- Export
Config - Curation + export configuration.
- Export
Counts - Record counts at each curation stage.
- Export
Manifest - Reproducible description of an export, written next to the JSONL output.
- Export
Stats - Auditable dataset statistics for one export output, written to
<output_path>.stats.json. - Lifecycle
Query Options - Query-time controls for lifecycle-aware retrieval.
- Message
- A single chat message in a training example.
- Metric
Scores - Aggregate or per-query retrieval-quality metrics, all in
0.0..=1.0. - Partition
Info - Manifest row describing one resolved context partition.
- Partition
Spec - Phase-1 partition specification for a context namespace.
- Provenance
- Where an exported example came from, for auditability.
- Query
Eval - Metrics and retrieved ids for a single query.
- Ranked
Candidate - One ranked candidate in an N-way preference example.
- Record
Filters - Filters applied to records before list pagination or search ranking.
- Record
Patch - Mutable fields that can be patched without resupplying the payload.
- Relationship
- Directed relationship from this record to another graph node.
- Relevance
Label - A single relevance judgment: a relevant
external_idand its grade. - Retrieve
Result - Result returned from hybrid retrieval over context records.
- Rollout
Example - RL rollout example: a prompt plus one or more rewarded responses, with an
optional
group_idlinking the N samples for one prompt. - Rollout
Response - One response within a rollout example.
- Search
Result - Result returned from a vector similarity search.
- SftExample
- SFT example: an ordered message list (doubles as the rejection-sampling /
Best-of-N target when filtered by
min_reward). - Snapshot
- Split
Config - Reproducible train/eval split configuration.
- Split
Manifest - Records which side of a train/eval split an output is, and the parameters needed to reproduce the partition.
- State
Metadata - Structured metadata captured alongside each context entry.
- Token
Stats - Token-length statistics and which source produced them.
- Update
Result - Result returned from partial record update operations.
- Upsert
Result - Result returned from insert-or-replace operations.
Enums§
- Distance
Metric - Distance metric used to rank candidates during vector search.
- Export
Task - Which training shape to export.
- GroupBy
- How records are grouped into one training example.
- IdIndex
Type - Type of scalar index on the
idcolumn. - Metadata
Filter - Metadata matching operation for filtered retrieval.
- Preference
Example - Preference example in one of three forms, tagged by
form. - Preference
Form - Shape of a preference export (selected by the caller to match their labels).
- Retrieval
Mode - Which retrieval API to evaluate.
Constants§
- EXPORT_
SCHEMA_ VERSION - Schema version stamped into every export manifest.
- LIFECYCLE_
ACTIVE - LIFECYCLE_
CONTRADICTED
Type Aliases§
- Partition
Selector - Complete selector values for one context partition.