Struct CallbackStep

pub struct CallbackStep {
    pub block: Option<HandoffStepBlock>,
    pub type: Type,
    pub mutations: Option<Vec<CallbackStepMutationsInner>>,
    pub name: String,
    pub block_id: Option<String>,
    pub input: Option<Value>,
}

Fields

block: Option<HandoffStepBlock>

type: Type

This is a step that calls back to the previous step after it’s done. This effectively means we’re spawning a new conversation thread. The previous conversation thread will resume where it left off once this step is done. Use case: - You are collecting a customer’s order and while they were on one item, they start a new item or try to modify a previous one. You would make a OrderUpdate block which calls the same block repeatedly when a new update starts.

mutations: Option<Vec<CallbackStepMutationsInner>>

This is the mutations to apply to the context after the step is done.

name: String

This is the name of the step.

block_id: Option<String>

This is the id of the block to use. To use a transient block, use block.

input: Option<Value>

This is the input to the block. You can use any key-value map as input to the block. Example: { "name": "John Doe", "age": 20 } You can reference any variable in the context of the current block: - "{{your-step-name.output.your-property-name}}" for another step’s output (in the same workflow; read caveat #1) - "{{your-step-name.input.your-property-name}}" for another step’s input (in the same workflow; read caveat #1) - "{{your-block-name.output.your-property-name}}" for another block’s output (in the same workflow; read caveat #2) - "{{your-block-name.input.your-property-name}}" for another block’s input (in the same workflow; read caveat #2) - "{{workflow.input.your-property-name}}" for the current workflow’s input - "{{global.your-property-name}}" for the global context Example: { "name": "{{my-tool-call-step.output.name}}", "age": "{{my-tool-call-step.input.age}}", "date": "{{workflow.input.date}}" } You can dynamically change the key name. Example: { "{{my-tool-call-step.output.key-name-for-name}}": "{{name}}", "{{my-tool-call-step.input.key-name-for-age}}": "{{age}}", "{{workflow.input.key-name-for-date}}": "{{date}}" } You can represent the value as a string, number, boolean, array, or object. Example: { "name": "john", "age": 20, "date": "2021-01-01", "metadata": { "unique-key": "{{my-tool-call-step.output.unique-key}}" }, "array": ["A", "B", "C"], } Caveats: 1. a workflow can execute a step multiple times. example, if a loop is used in the graph. {{stepName.input/output.propertyName}} will reference the latest usage of the step. 2. a workflow can execute a block multiple times. example, if a step is called multiple times or if a block is used in multiple steps. {{blockName.input/output.propertyName}} will reference the latest usage of the block. this liquid variable is just provided for convenience when creating blocks outside of a workflow.

Implementations

impl CallbackStep

pub fn new(type: Type, name: String) -> CallbackStep

Trait Implementations

impl Clone for CallbackStep

fn clone(&self) -> CallbackStep

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for CallbackStep

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for CallbackStep

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

Formats the value using the given formatter.

impl Default for CallbackStep

fn default() -> CallbackStep

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CallbackStep

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CallbackStep

fn eq(&self, other: &CallbackStep) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CallbackStep

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for CallbackStep

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

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl StructuralPartialEq for CallbackStep