Struct FlowBuilder 

pub struct FlowBuilder { /* private fields */ }

Programmatically build a Flow definition.

Example

use stepflow_client::{FlowBuilder, ValueExpr};

let mut builder = FlowBuilder::new();
builder.add_step(
    "summarize",
    "/builtin/openai",
    ValueExpr::object(vec![
        ("model".to_string(), ValueExpr::literal(serde_json::json!("gpt-4o"))),
    ]),
);
let flow = builder
    .output(ValueExpr::step_output("summarize"))
    .build()
    .unwrap();

Implementations

impl FlowBuilder

pub fn new() -> Self

Create a new, empty builder.

pub fn name(self, name: impl Into<String>) -> Self

Set the flow name.

pub fn description(self, description: impl Into<String>) -> Self

Set the flow description.

pub fn version(self, version: impl Into<String>) -> Self

Set the flow version.

pub fn metadata(self, key: impl Into<String>, value: Value) -> Self

Add a metadata entry.

pub fn add_step( &mut self, id: impl Into<String>, component: impl Into<String>, input: impl Into<ValueExpr>, )

Add a step to the flow.

Panics

Panics if a step with the same ID already exists.

pub fn try_add_step( &mut self, id: impl Into<String>, component: impl Into<String>, input: impl Into<ValueExpr>, ) -> Result<(), BuilderError>

Add a step to the flow, returning an error on duplicate IDs.

pub fn output(self, expr: impl Into<ValueExpr>) -> Self

Set the flow output expression.

pub fn build(self) -> Result<Flow, BuilderError>

Build the Flow.

Trait Implementations

impl Debug for FlowBuilder

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

Formats the value using the given formatter.

impl Default for FlowBuilder

fn default() -> FlowBuilder

Returns the “default value” for a type.