​
Purpose

Vector index model for metric points, vector entries, insert/search/delete flows, and similarity queries. This page follows the real source shape for Basis and explains the workflow a developer is likely to use first.

​
Developer workflow

Start from the smallest constructor or builder, perform one meaningful operation, inspect the returned state, then add the relevant policy, storage, or network integration. The examples below should be expanded whenever the crate API changes.

​
Primary types to know

  • Basis — models/basis/src/lib.rs
  • BasisError — models/basis/src/lib.rs
  • VectorEntry — models/basis/src/lib.rs

​
Example shape

use basis::*;

// Minimal example skeleton. Replace placeholders with the concrete constructor
// listed on the API Surface page for this library.
async fn example() -> Result<(), Box<dyn std::error::Error>> {
    // 1. Build config or open storage.
    // 2. Execute one operation from this page.
    // 3. Assert the observable result before wiring peers or persistence.
    Ok(())
}

​
Release-quality documentation checklist

  • Every public type on the API Surface page has at least one sentence of behavior documentation.
  • Every fallible operation lists errors and recovery guidance.
  • Every networked example names the peer/session/topic lifecycle.
  • Every storage example names durability, repair, and deletion semantics.