Struct SessionSpec 

pub struct SessionSpec {

    pub name: String,
    pub version: String,
    pub description: String,
    pub instruction: String,
    pub greeting: Option<String>,
    pub modality: SpecModality,
    pub voice: Option<String>,
    pub tools: Vec<ToolSpec>,
    pub mcp: Vec<String>,
    pub extract: Vec<ExtractSpec>,
    pub state: BTreeMap<String, StateFieldSpec>,
    pub computed: Vec<ComputedSpec>,
    pub memory: Option<MemorySpec>,
    pub runtime: Option<RuntimeSpec>,
    pub phases: Vec<PhaseSpec>,
    pub initial_phase: Option<String>,
    pub watch: Vec<WatchSpec>,
    pub patterns: Vec<PatternSpec>,
    pub fragments: BTreeMap<String, Flow>,
    pub use_fragments: Vec<UseFragment>,
    pub flow: Option<Flow>,
    pub tests: Vec<SpecTest>,
}

A complete Live session as one JSON document. See the module docs.

Fields

name: String

App name (display and registry identity).

version: String

Spec version tag (freeform, e.g. “1” or “2025-08-24”).

description: String

Human-readable description.

instruction: String

Base system instruction.

greeting: Option<String>

Optional greeting prompt — the model speaks first on connect.

modality: SpecModality

Output modality. Defaults to text.

voice: Option<String>

Voice name for audio sessions (e.g. “Puck”).

tools: Vec<ToolSpec>

Declared tools (mock or HTTP-bound).

mcp: Vec<String>

MCP toolset connection strings — the whole MCP ecosystem as this app’s tool library. Resolved at connect time.

extract: Vec<ExtractSpec>

Out-of-band extraction pipelines.

state: BTreeMap<String, StateFieldSpec>

Declared state keys — the session’s data dictionary.

computed: Vec<ComputedSpec>

Computed (derived) state variables.

memory: Option<MemorySpec>

Durable memory: slots projected into state, remember effects, and the ambient recall/manage tools. Requires a MemoryBinding in SpecResources at apply time.

runtime: Option<RuntimeSpec>

Control-plane and voice tuning.

phases: Vec<PhaseSpec>

Conversation phases.

initial_phase: Option<String>

Initial phase name (required when phases is non-empty).

watch: Vec<WatchSpec>

State watchers.

patterns: Vec<PatternSpec>

Temporal patterns (sustained / consecutive-turn conditions).

fragments: BTreeMap<String, Flow>

Reusable flow fragments, spliced via use_fragments.

use_fragments: Vec<UseFragment>

Fragment splice directives.

flow: Option<Flow>

The governed flow DAG (optional — a spec may be phases-only).

tests: Vec<SpecTest>

Embedded conformance tests, replayed offline by SessionSpec::run_tests.

Implementations

impl SessionSpec

pub fn to_rust(&self) -> String

The complete main.rs this spec is equivalent to.

pub fn to_cargo_toml(&self) -> String

A Cargo.toml to pair with to_rust.

impl SessionSpec

pub fn from_value(value: Value) -> Result<Self, String>

Parse a spec from a JSON value. Accepts a full document or a bare flow ({"steps": [...]}), which is wrapped in a default spec.

pub fn json_schema() -> Value

The JSON Schema of the spec document itself — for editor autocomplete and for validating machine-authored specs at generation time.

pub fn tool_names(&self) -> Vec<String>

Declared tool names (mock/HTTP; MCP names resolve at connect).

pub fn effective_flow(&self) -> Result<Flow, Vec<String>>

The flow with every use_fragments directive spliced in.

pub fn state_keys_written(&self) -> BTreeSet<String>

Every state key the session declares a writer for: tool set_state and save_response_as, extraction names and promotion targets, phase and watcher set effects.

pub fn validate(&self) -> SpecValidation

Validate the whole document: flow compilation (with the declared tool registry), fragment splicing, phase-guard restrictions, HTTP-binding support, and the read/write state-key diff.

pub fn build_dispatcher(&self, state: &State) -> ToolDispatcher

Build the dispatcher of declared tools bound to state.

pub fn run_tests(&self) -> Vec<TestReport>

Run the embedded test suite offline (no model, no network) — scripted events replayed through the real FlowMonitor.

pub fn apply( &self, live: Live, state: &State, resources: &SpecResources, ) -> Result<Live, String>

Configure a Live builder from this spec.

state is the session state the declared tools bind to — pass the same one via .state (this method does). Returns an error when the spec fails validation or requires a resource resources lacks. Everything code-only (callbacks, custom guards, middleware) is added on the returned builder afterwards.

Trait Implementations

impl Clone for SessionSpec

fn clone(&self) -> SessionSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SessionSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SessionSpec

fn default() -> SessionSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SessionSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SessionSpec

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for SessionSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.