Struct WorkflowBlock

pub struct WorkflowBlock {
    pub messages: Option<Vec<ConversationBlockMessagesInner>>,
    pub input_schema: Option<JsonSchema>,
    pub output_schema: Option<JsonSchema>,
    pub type: Type,
    pub steps: Option<Vec<VapiModelStepsInner>>,
    pub id: String,
    pub org_id: String,
    pub created_at: String,
    pub updated_at: String,
    pub name: Option<String>,
}

Fields

messages: Option<Vec<ConversationBlockMessagesInner>>

These are the pre-configured messages that will be spoken to the user while the block is running.

input_schema: Option<JsonSchema>

This is the input schema for the block. This is the input the block needs to run. It’s given to the block as steps[0].input These are accessible as variables: - ({{input.propertyName}}) in context of the block execution (step) - ({{stepName.input.propertyName}}) in context of the workflow

output_schema: Option<JsonSchema>

This is the output schema for the block. This is the output the block will return to the workflow ({{stepName.output}}). These are accessible as variables: - ({{output.propertyName}}) in context of the block execution (step) - ({{stepName.output.propertyName}}) in context of the workflow (read caveat #1) - ({{blockName.output.propertyName}}) in context of the workflow (read caveat #2) Caveats: 1. a workflow can execute a step multiple times. example, if a loop is used in the graph. {{stepName.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.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 with steps.

type: Type

This creates a workflow which can contain any number of steps (block executions).

steps: Option<Vec<VapiModelStepsInner>>

These are the steps in the workflow.

id: String

This is the unique identifier for the block.

org_id: String

This is the unique identifier for the organization that this block belongs to.

created_at: String

This is the ISO 8601 date-time string of when the block was created.

updated_at: String

This is the ISO 8601 date-time string of when the block was last updated.

name: Option<String>

This is the name of the block. This is just for your reference.

Implementations

impl WorkflowBlock

pub fn new( type: Type, id: String, org_id: String, created_at: String, updated_at: String, ) -> WorkflowBlock

Trait Implementations

impl Clone for WorkflowBlock

fn clone(&self) -> WorkflowBlock

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for WorkflowBlock

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

impl Debug for WorkflowBlock

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

Formats the value using the given formatter.

impl Default for WorkflowBlock

fn default() -> WorkflowBlock

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WorkflowBlock

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WorkflowBlock

fn eq(&self, other: &WorkflowBlock) -> 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 WorkflowBlock

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 WorkflowBlock

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 WorkflowBlock