behest 0.5.9

A Rust-native cloud agent runtime with typed tools, pluggable memory, queues, and observability.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

#![forbid(unsafe_code)]
//! behest runtime kernel (facade re-exports).
//! temporarily allow during migration
#![warn(missing_docs)]
// Temporarily allow during migration
#![warn(unreachable_pub)]
#![warn(rust_2018_idioms)]

//! Building blocks for Rust-native AI agent runtimes.
//!
//! # Architecture
//!
//! behest has two complementary surfaces:
//!
//! **The invocation surface** — a Socket.IO-inspired `emit` / `on` model
//! for interacting with an agent. Emit a user message, receive streaming
//! events back through typed handlers. This is the _caller-facing_ API,
//! built on [`RuntimeInvocation`].
//!
//! **The assembly surface** — pluggable components (providers, tools,
//! stores, transports) wired together via [`ComponentRegistry`]
//! and driven by a coordinated lifecycle. This is the _operator-facing_ API
//! for composing a runtime from parts, built on [`ManagedRuntime`].
//!
//! ```text
//!                   emit("question")       on(TextDelta, handler)
//!   Caller ──────────►  RuntimeInvocation  ──────────►  Caller
//!                          │
//!                          ▼
//!                    AgentRuntime  ◄──  ComponentRegistry
//!                          │              │
//!                          ▼              ▼
//!                 run_loop (FSM)      provider / tool / store / transport
//! ```
//!
//! The two surfaces are independent: you can use `RuntimeInvocation` with
//! a hand-assembled `AgentRuntime`, or drive the `ManagedRuntime` lifecycle
//! from your own invocation layer. They meet at `AgentRuntime` — the shared
//! kernel that both paths produce.
//!
//! # Quick start
//!
//! ```ignore
//! use behest::prelude::*;
//! use behest::runtime::RuntimeInvocation;
//!
//! // 1. Build config & runtime
//! let config = AgentConfigBuilder::default()
//!     .with_env("BEHEST")?
//!     .with_provider(ProviderId::new("openai"), ProviderConfig::new("https://api.openai.com/v1")
//!         .with_provider_type(ProviderType::OpenAi)
//!         .with_api_key("env:OPENAI_API_KEY")
//!         .with_model("gpt-4o"))
//!     .build()?;
//! let runtime = Arc::new(config.into_runtime().await?);
//!
//! // 2. Wrap in the invocation facade
//! let inv = RuntimeInvocation::new(runtime);
//!
//! // 3. Subscribe to text deltas
//! let handle = inv.on(EventKind::TextDelta, |envelope, _session, _control| async move {
//!     if let AgentEvent::TextDelta(td) = &envelope.event {
//!         print!("{}", td.delta);
//!     }
//! }).await?;
//!
//! // 4. Emit a request
//! let output = inv.emit(|_session, _control| async move {
//!     EmitRequest::new(provider_id, model, "Hello, world!")
//! }).await?;
//!
//! drop(handle);
//! ```
//!
//! # Modules
//!
//! - [`runtime`]: Runtime kernel, invocation facade, component system, policy
//! - [`provider`]: Provider traits, request/response types, and registry
//! - [`tool`]: Tool trait, registry, scoping
//! - [`context`]: Multi-adapter context factory for composing chat requests
//! - [`store`]: Persistence traits and backends for sessions, embeddings, artifacts
//! - [`config`]: Centralized configuration with file, env, and builder support
//! - [`adapt`]: Concrete provider adapters (OpenAI, Anthropic)
//! - [`error`]: Error types and result aliases
//! - [`rag`]: Retrieval-Augmented Generation context adapter (feature = `rag`)
//! - [`queue`]: External event publishing to message brokers (feature = `queue`)

pub mod adapt;
pub mod agent;
pub mod config;
pub mod context;
pub mod error;
pub mod health;
pub mod prelude;
pub mod provider;
pub mod runtime;
pub mod store;
pub mod token;
pub mod tool;
/// Tool output configuration (re-exported from behest_runtime).
pub mod tool_output;
pub mod tool_scope;

#[cfg(feature = "rag")]
pub mod rag;

#[cfg(feature = "queue")]
pub mod queue;

pub use crate::error::{ContextError, Error, ProviderError, Result, StorageError, ToolError};
pub use crate::health::HealthStatus;
pub use crate::runtime::{
    AgentEvent, AgentRuntime, AnyComponent, AnyComponentError, CacheStats, CompactionResult,
    CompactionService, Component, ComponentContext, ComponentDescriptor, ComponentError,
    ComponentFactory, ComponentRegistry, ComponentState, ContextPipelineComponent,
    ContextPipelineConfig, Control, EmitRequest, EventKind, ExtensionError, ExtensionPoint,
    Extensions, FactoryError, FactoryFn, FactoryRegistry, FileSessionDataStore, FileSnapshotStore,
    InvocationError, InvocationEvent, InvocationHandle, InvocationSession, ManagedError,
    ManagedRuntime, MemoryArtifactStoreComponent, MemoryEmbeddingStoreComponent,
    MemoryExecutionStoreComponent, MemoryRunStoreComponent, MemorySessionDataStore,
    MemorySessionStoreComponent, ModelRouter, PromptCacheConfig, ProviderHttpComponentConfig,
    RegistryError, RunId, RunOutput, RunRequest, RunStatus, RuntimeError, RuntimeEventBridge,
    RuntimeEventBridgeError, RuntimeEventBridgeHandle, RuntimeEventEnvelope, RuntimeEventId,
    RuntimeEventStore, RuntimeEventStoreError, RuntimeInvocation, RuntimePolicy, RuntimeRoom,
    RuntimeStreamAdapter, RuntimeStreamError, RuntimeSubscription, RuntimeSubscriptionError,
    RuntimeSubscriptionHub, SessionDataError, SessionDataStore, ShutdownToken, Snapshot,
    SnapshotStore, TypedAnyComponent, TypedFactory, default_factory_registry,
    register_context_pipeline, register_memory_stores, register_providers,
};

#[cfg(feature = "openai")]
pub use crate::runtime::{OpenAiChatComponent, OpenAiEmbeddingComponent};

#[cfg(feature = "anthropic")]
pub use crate::runtime::AnthropicChatComponent;
pub use crate::tool_output::{ToolOutputConfig, TruncationResult};

#[cfg(feature = "redis")]
pub use crate::runtime::RedisSessionDataStore;