API Reference
The VEX API documentation is generated using Rustdoc.
Crate Documentation
| Crate | Description | Link |
|---|---|---|
| vex-core | Core types: Agent, Genome, MerkleTree, ContextPacket | View Docs |
| vex-adversarial | Red/Blue verification, Consensus, Debate | View Docs |
| vex-temporal | Episodic memory, TimeHorizon, Decay | View Docs |
| vex-llm | LLM providers, RateLimiter, Metrics | View Docs |
| vex-api | HTTP server, JWT auth, CircuitBreaker | View Docs |
| vex-persist | Storage backends, Audit logs | View Docs |
| vex-queue | Job queue, Worker pool | View Docs |
| vex-runtime | Agent orchestration, Execution | View Docs |
Quick Reference
Creating an Agent
use vex_core::{Agent, AgentConfig};
let agent = Agent::new(AgentConfig {
name: "MyAgent".to_string(),
role: "You are helpful".to_string(),
max_depth: 3,
spawn_shadow: true,
});
Using an LLM Provider
use vex_llm::{DeepSeekProvider, LlmProvider};
let llm = DeepSeekProvider::new(api_key);
let response = llm.ask("Hello!").await?;
Adversarial Verification
use vex_adversarial::{ShadowAgent, ShadowConfig};
let shadow = ShadowAgent::new(&agent, ShadowConfig::default());
let issues = shadow.detect_issues("This always works!");
Episodic Memory
use vex_temporal::{EpisodicMemory, HorizonConfig};
let mut memory = EpisodicMemory::new(HorizonConfig::default());
memory.remember("Important fact", 0.9);
Building Docs Locally
cd vex
cargo doc --workspace --no-deps --open