Expand description
§Orchestral
Facade crate that re-exports orchestral_core and orchestral_runtime
for convenient single-dependency access.
ⓘ
use orchestral::prelude::*;Re-exports§
pub use orchestral_core as core;pub use orchestral_runtime as runtime;
Structs§
- Action
Context - Execution context for actions
- Action
Execution Options - Action
Input - Input data for action execution
- Action
Meta - Action metadata for planner
- Action
Registry - Action registry for looking up actions by name
- Blob
Head - Blob metadata fetched from physical backend.
- BlobId
- Strongly-typed blob id.
- Blob
Meta - Blob metadata.
- Blob
Read - Read result.
- Blob
Write Request - Write request.
- Cancellation
Token - A token which can be used to signal a cancellation request to one or more tasks.
- Continuation
State - Structured stage exit state consumed by runtime.
- DagNode
- A node in the execution DAG
- Execution
Dag - Execution DAG - supports dynamic modification
- Execution
Progress Event - Realtime execution progress event.
- Executor
- The executor - orchestrates DAG execution
- Executor
Context - Executor context
- History
Item - A single item in the conversation history
- Intent
- User intent - the first-class input of the system
- Intent
Context - Additional context for an intent
- Interpret
Request - Input payload for result interpretation.
- Interpret
Result - Output payload from interpreter.
- Noop
Result Interpreter - Deterministic fallback interpreter.
- Normalized
Plan - Normalized plan ready for execution
- Orchestral
- Entry point for the SDK.
- Orchestral
App - The running Orchestral application.
- Orchestral
Builder - Builder for constructing an OrchestralApp without YAML config.
- Plan
- Execution plan - the primary asset of the system
- Plan
Normalizer - Plan normalizer - the stability core
- Planner
Context - Context provided to the planner
- Planner
Loop Context - Agent-loop execution state surfaced back into the planner.
- Planner
Runtime Info - Runtime host info visible to planner prompt.
- RunResult
- Result of a single
run()call. - Single
Action - Planner single-action output.
- Step
- A single step in the execution plan
- StepId
- Strongly-typed Step ID.
- Task
- Task - the stateful execution context
- TaskId
- Strongly-typed Task ID.
- Verify
Decision - Structured verify result. This is the only terminal done gate.
- Working
Set - Working set - weakly-typed KV data container for inter-step communication
Enums§
- Action
Result - Action execution result with retry semantics
- Blob
IoError - Storage-neutral blob errors.
- Continuation
Status - Explicit continuation decision emitted by a completed stage.
- Event
- Event - append-only fact record
- Execution
Result - Execution result
- FixError
- Fix errors
- Interpret
Error - Result interpreter errors.
- Node
State - Node state in the execution DAG
- Normalize
Error - Normalization errors
- Plan
Error - Planner errors
- Planner
Output - Scope
- Data scope for WorkingSet Avoids naming conflicts and data pollution
- SdkError
- SDK errors.
- Step
Kind - Step type - distinguishes control semantics
- Store
Error - Store error types
- Task
State - Task state machine - production-ready states
- Validation
Error - Validation errors
- Verify
Status - Final verification verdict.
Traits§
- Action
- Action trait - the core abstraction for atomic execution units
- Blob
Store - Blob store abstraction.
- Event
Store - EventStore trait - async interface for event storage
- Execution
Progress Reporter - Sink interface for execution progress reporting.
- Interpret
Delta Sink - Plan
Fixer - Plan fixer trait
- Plan
Validator - Plan validator trait
- Planner
- Planner trait - generates execution plans from user intent
- Result
Interpreter - Interpreter trait.
- Task
Store - TaskStore trait - async interface for task persistence
Type Aliases§
- Action
Call - Legacy alias preserved while call sites migrate.
- Action
Preflight Hook - Blob
Stream - Streaming blob body.