Skip to content

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).

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.

FeatureDefault / Enables
gamifydep:vox-gamify
news-publishdep:vox-publisher
runtimescientia-claims
scientia-claimsdep:vox-scientia
DependencyKind
vox-actor-runtimeNormal
vox-compilerNormal
vox-configNormal
vox-dbNormal
vox-gamifyNormal
vox-orchestratorNormal
vox-orchestrator-typesNormal
vox-publisherNormal
vox-research-eventsNormal
vox-scientiaNormal
vox-searchNormal
vox-secretsNormal
vox-scientiaDevelopment
ModuleDescription
agent_frontmatter—
research—
route_telemetry—
selectionModel-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—
FunctionDescription
persist_min_confidence—
training_pair_min_confidence—
ConstantDescription
LLM_RUNTIME_ENABLEDWhether 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, diagram 117 nodes, 16 edges: vox-research-shim → vox-actor-runtime; vox-research-shim → vox-compiler; vox-research-shim → vox-config; vox-research-shim → vox-db; vox-research-shim → vox-gamify; vox-research-shim → vox-orchestrator; vox-research-shim → vox-orchestrator-types; vox-research-shim → vox-publishe…vox-research-shimvox-actor-runtimevox-compilervox-configvox-dbvox-gamifyvox-orchestratorvox-orchestrator-typesvox-publishervox-research-eventsvox-scientiavox-searchvox-secretsvox-clivox-cli-researchvox-guivox-orchestrator-mcp
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
}
Consumer CrateRole
vox-cliDirect workspace dependent
vox-cli-researchDirect workspace dependent
vox-guiDirect workspace dependent
vox-orchestrator-mcpDirect workspace dependent
KindSymbolSignatureSourceDescription
fnpersist_min_confidencepub const fn persist_min_confidence() -> f64crates/vox-research-shim/src/lib.rs#L29-L31—
fntraining_pair_min_confidencepub const fn training_pair_min_confidence() -> f64crates/vox-research-shim/src/lib.rs#L34-L36—
structagent_frontmatter::AgentFrontmatterpub struct AgentFrontmattercrates/vox-research-shim/src/agent_frontmatter.rs#L24-L29Parsed agent frontmatter fields used by Dei and MCP tools.
fnagent_frontmatter::parse_agent_file_pathpub fn parse_agent_file_path(path: &Path) -> std::io::Result<AgentFrontmatter>crates/vox-research-shim/src/agent_frontmatter.rs#L32-L45Parse scope: and model: from a file if it exists and has YAML frontmatter.
fnagent_frontmatter::parse_agent_frontmatterpub fn parse_agent_frontmatter(content: &str) -> Option<AgentFrontmatter>crates/vox-research-shim/src/agent_frontmatter.rs#L50-L125Parse frontmatter from raw file contents. Returns None if there is no --- block; otherwise returns parsed fields (possibly empty).
structroute_telemetry::ModelRouteEventpub struct ModelRouteEventcrates/vox-research-shim/src/route_telemetry.rs#L9-L31One model-routing event for observability and tuning.
fnroute_telemetry::emit_model_routepub fn emit_model_route(ev: &ModelRouteEvent)crates/vox-research-shim/src/route_telemetry.rs#L36-L50Emit a structured tracing event consumable by log aggregators. Target vox_orchestrator::model_route can be filtered in RUST_LOG.