vox-research-shim API Reference (generated)
Crate: vox-research-shim · Version: 0.6.0 · Target: Library (lib.rs)
DEI research pipeline and model-selection sub-systems (extracted from vox-orchestrator as an A-12 wedge crate).
Crate Overview
Section titled “Crate Overview”DEI research pipeline and model-selection sub-systems.
Extracted from vox-orchestrator/src/dei_shim/ as a wedge crate (A-12).
The public surface is intentionally identical to the old vox_orchestrator::dei_shim::*
path — consumers need only update their import root.
Features
Section titled “Features”| Feature | Default / Enables |
|---|---|
gamify | dep:vox-gamify |
news-publish | dep:vox-publisher |
runtime | scientia-claims |
scientia-claims | dep:vox-scientia |
Workspace Dependencies
Section titled “Workspace Dependencies”| Dependency | Kind |
|---|---|
vox-actor-runtime | Normal |
vox-compiler | Normal |
vox-config | Normal |
vox-db | Normal |
vox-gamify | Normal |
vox-orchestrator | Normal |
vox-orchestrator-types | Normal |
vox-publisher | Normal |
vox-research-events | Normal |
vox-scientia | Normal |
vox-search | Normal |
vox-secrets | Normal |
vox-scientia | Development |
Public API Surface
Section titled “Public API Surface”Modules
Section titled “Modules”| Module | Description |
|---|---|
agent_frontmatter | — |
research | — |
route_telemetry | — |
selection | Model-selection sub-system: task→strength mapping, pluggable scoring, free-tier routing. Previously deferred (WIP) because it required ModelTier::Fast/Free and RoutingProfile which are now available (added 2026-05-24, F-F track). |
research_policy | — |
Functions
Section titled “Functions”| Function | Description |
|---|---|
persist_min_confidence | — |
training_pair_min_confidence | — |
Constants
Section titled “Constants”| Constant | Description |
|---|---|
LLM_RUNTIME_ENABLED | Whether this build makes live LLM calls (the runtime feature). Without it every research LLM stage fails with “research runtime feature is disabled”, so callers (e.g. live-model tests in downstream crates) can skip instead of failing. |
Dependency Topology
Section titled “Dependency Topology”Diagram source
graph { direction: right node vox_research_shim: "vox-research-shim" node vox_actor_runtime: "vox-actor-runtime" vox_research_shim -> vox_actor_runtime node vox_compiler: "vox-compiler" vox_research_shim -> vox_compiler node vox_config: "vox-config" vox_research_shim -> vox_config node vox_db: "vox-db" vox_research_shim -> vox_db node vox_gamify: "vox-gamify" vox_research_shim -> vox_gamify node vox_orchestrator: "vox-orchestrator" vox_research_shim -> vox_orchestrator node vox_orchestrator_types: "vox-orchestrator-types" vox_research_shim -> vox_orchestrator_types node vox_publisher: "vox-publisher" vox_research_shim -> vox_publisher node vox_research_events: "vox-research-events" vox_research_shim -> vox_research_events node vox_scientia: "vox-scientia" vox_research_shim -> vox_scientia node vox_search: "vox-search" vox_research_shim -> vox_search node vox_secrets: "vox-secrets" vox_research_shim -> vox_secrets node vox_cli: "vox-cli" vox_cli -> vox_research_shim node vox_cli_research: "vox-cli-research" vox_cli_research -> vox_research_shim node vox_gui: "vox-gui" vox_gui -> vox_research_shim node vox_orchestrator_mcp: "vox-orchestrator-mcp" vox_orchestrator_mcp -> vox_research_shim}Reverse Dependents (Used By)
Section titled “Reverse Dependents (Used By)”| Consumer Crate | Role |
|---|---|
vox-cli | Direct workspace dependent |
vox-cli-research | Direct workspace dependent |
vox-gui | Direct workspace dependent |
vox-orchestrator-mcp | Direct workspace dependent |
Deep Public Symbols (Source-Anchored)
Section titled “Deep Public Symbols (Source-Anchored)”| Kind | Symbol | Signature | Source | Description |
|---|---|---|---|---|
fn | persist_min_confidence | pub const fn persist_min_confidence() -> f64 | crates/vox-research-shim/src/lib.rs#L29-L31 | — |
fn | training_pair_min_confidence | pub const fn training_pair_min_confidence() -> f64 | crates/vox-research-shim/src/lib.rs#L34-L36 | — |
struct | agent_frontmatter::AgentFrontmatter | pub struct AgentFrontmatter | crates/vox-research-shim/src/agent_frontmatter.rs#L24-L29 | Parsed agent frontmatter fields used by Dei and MCP tools. |
fn | agent_frontmatter::parse_agent_file_path | pub fn parse_agent_file_path(path: &Path) -> std::io::Result<AgentFrontmatter> | crates/vox-research-shim/src/agent_frontmatter.rs#L32-L45 | Parse scope: and model: from a file if it exists and has YAML frontmatter. |
fn | agent_frontmatter::parse_agent_frontmatter | pub fn parse_agent_frontmatter(content: &str) -> Option<AgentFrontmatter> | crates/vox-research-shim/src/agent_frontmatter.rs#L50-L125 | Parse frontmatter from raw file contents. Returns None if there is no --- block; otherwise returns parsed fields (possibly empty). |
struct | route_telemetry::ModelRouteEvent | pub struct ModelRouteEvent | crates/vox-research-shim/src/route_telemetry.rs#L9-L31 | One model-routing event for observability and tuning. |
fn | route_telemetry::emit_model_route | pub fn emit_model_route(ev: &ModelRouteEvent) | crates/vox-research-shim/src/route_telemetry.rs#L36-L50 | Emit a structured tracing event consumable by log aggregators. Target vox_orchestrator::model_route can be filtered in RUST_LOG. |