Variables

Learn how to properly leverage variables in your AI Workflows

Variables in MindStudio are dynamic placeholders that store data during workflow execution. They allow you to pass information between blocks and workflows seamlessly.

Example:

• Variable Name: userName

• Usage: "Hello, {{userName}}! Welcome to our app."

---

Creating Variables

Variables are created automatically in MindStudio whenever:

• A User Input collects data.

• A block generates an output (e.g., Generate Text Block, Analyze Image Block).

• You manually define them in the Start Block.

---

Types of Variables

Launch Variables

These are defined in the Start Block of your workflow. Values for these variables are passed in as arguments when a workflow is run via API or via the Run Workflow block.

Runtime Variables

Some blocks, such as Generate Text Blocks or User Input Blocks, assign values for the variable while the workflow is running. For Example, after performing a Google Search, the block can store the results in a variable called google_result.

---

Calling Variables

To use a variable in any block or prompt, reference it by enclosing the variable name in double curly braces: {{variable_name}}.

Example Calling Variables in a Generate Text Block:

Summarize the article titled "{{articleTitle}}". 

In the summary, make sure to write about the following topic: 
{{topic}}

---

Extracting a Value from a JSON Structure

MindStudio provides tools for extracting specific values from JSON objects using the JSON Path syntax and the get helper. This allows workflows to handle and manipulate structured data with precision, making them more dynamic and adaptable.

---

get Helper - Query JSON Variables

The get helper allows you to query JSON variables for specific values using JSON Path expressions. This feature is especially useful when working with nested or complex JSON structures.

Syntax:

{{get myVariable "$.path.to.value"}}

---

Example 1: Extract a Nested Value:

Given the following JSON assigned to myJsonVariable:

{
    "user": {
        "name": "Alice",
        "details": {
            "email": "[e-mail]"
        }
    }
}

Use this to extract the email address:

{{get myJsonVariable "$.user.details.email"}}

Output: [e-mail]

---

Example 2: Extract the First Item in an Array:

Given the following JSON:

{
    "items": [
        {"id": 1, "name": "Foo"},
        {"id": 2, "name": "Bar"}
    ]
}

Use this to extract the name of the first item:

{{get myJsonVariable "$.items[0].name"}}

Output: Foo

---

Example 3: Extract Multiple Values:

JSON Path also allows for querying multiple elements. Given the following JSON:

{
    "items": [
        {"id": 1, "name": "Foo"},
        {"id": 2, "name": "Bar"}
    ]
}

{{get myJsonVariable "$.items[*].name"}}

Output: ["Foo", "Bar"]

---

Best Practices When Extracting JSON

1. Use a JSON Path Tester: Tools like JSONPath Online Evaluator can help you refine and test your JSON Path queries.
2. Validate JSON Structure: Ensure your variable contains valid JSON data before attempting to extract values.

3. Handle Missing Values: Include fallback logic in your workflow to handle cases where the expected path does not exist in the JSON.

---

Using Handlebars Templating

MindStudio leverages the Handlebars templating language to make working with variables intuitive and powerful. Handlebars allows you to include, manipulate, and conditionally render data directly in your prompts, outputs, and logic.

---

Conditional Logic

Handlebars supports if-else logic for dynamic outputs:

{{#if userName}}
Hello, {{userName}}! How can we assist you today?
{{else}}
Hello! Please log in to get started.
{{/if}}

For a full list of expressions, see Handlebars Documentation.

---

Special Handlebars Methods in MindStudio

In addition to standard Handlebars features, MindStudio introduces special methods for advanced functionality:

{{json varName}}

Converts a JSON object into a string format.

Example:

If userProfile contains:

{
    "name": "John",
    "age": 30
}

Usage:

{{json userProfile}}

Output:

{"name":"John","age":30}

---

{{sample varName number token}}

Extracts a portion of the variable's content based on specified parameters.

• Parameters:

  • varName: The variable to sample.

  • number: The number of items (e.g., lines, words, or letters). If negative, starts from the end.

  • token: The type of unit to extract (line, word, or letter).

• Examples:

  • Extract the first 5 words:

    {{sample textVar 5 "word"}}

  • Extract the last 3 lines:

    {{sample textVar -3 "line"}}

  • Extract the first 10 letters:

    {{sample textVar 10 "letter"}}

---

{{#if condition}}

Converts a conditional block that renders content only when the condition is true.

Example:

If isLoggedIn is true

Usage:

{{#if isLoggedIn}}
  Welcome back!
{{/if}}

Output:

Welcome back!

---

{{#unless condition}}

Converts a conditional block that renders content only when the condition is false.

Example:

If isLoggedIn is false

Usage:

{{#unless isLoggedIn}}
  Please sign in.
{{/unless}}

Output:

Please sign in.

---

{{#each array}}

Iterates over an array or object and renders the block for every item.

Example:

If items contains:

["Apple", "Banana", "Cherry"]

Usage:

{{#each items}}
  {{this}}
{{/each}}

Output:

opyApple
Banana
Cherry

---

{{#with object}}

Changes the evaluation context to the provided object for the enclosed block.

Example:

If user contains:

{ "name": "Alice", "age": 25 }

Usage:

{{#with user}}
  {{name}} is {{age}} years old.
{{/with}}

Output:

Alice is 25 years old.

---

{{lookup object key}}

Dynamically looks up a property from an object using a key.

Example:

If user contains:

{ "name": "Alice", "role": "admin" }

Usage:

{{lookup user "role"}}

Output:

admin

---

{{log value}}

Logs a value to the console for debugging purposes.

Example:

If debugData contains:

{"error": "Not Found"}

Usage:

{{log debugData}}

Output:

(Check the browser console for the logged value)

---

{{get varName "property"}}

Retrieves a nested property using a JSONPath expression from a JSON object.

Example:

If userDatacontains:

{
  "name": "Alice",
  "contact": { "email": "[e-mail]" }
}

Usage:

{{get userData "$.contact.email"}}

Output:

[e-mail]

---

{{add num increment}}

Adds a numeric increment to a given number.

Example:

If num is:

5

Usage:

{{add 5 3}}

Output:

8

---

{{subtract num decrement}}

Subtracts a numeric value from a given number.

Example:

If num is:

10

Usage:

{{subtract 10 4}}

Output:

6

---

{{multiply value multiplier}}

Multiplies two numbers.

Example:

If value is:

2

Usage:

{{multiply 2 5}}

Output:

10

---

{{divide dividend divisor}}

Divides one number by another.

Example:

If dividend is:

10

Usage:

{{divide 10 2}}

Output:

5

---

{{eq var1 var2}}

Checks if two values are equal using the double-equals operator.

Example:

If var1 contains:

5

and var2 contains:

"5"

Usage:

{{eq 5 "5"}}

Output:

true

---

{{gt value1 value2}}

Checks if the first value is greater than the second value.

Example:

If value1 is:

10

and value2 is:

5

Usage:

{{gt 10 5}}

Output:

true

---

{{gte value1 value2}}

Checks if the first value is greater than or equal to the second value.

Example:

If value1 is:

10

and value2 is:

10

Usage:

{{gte 10 10}}

Output:

true

---

{{lt value1 value2}}

Checks if the first value is less than the second value.

Example:

If value1 is:

5

and value2 is:

10

Usage:

{{lt 5 10}}

Output:

true

---

{{lte value1 value2}}

Checks if the first value is less than or equal to the second value.

Example:

If value1 is:

5

and value2 is:

5

Usage:

{{lte 5 5}}

Output:

true

---

{{isEmpty varName}}

Evaluates whether a variable is empty (null, undefined, an empty string, an empty array, or an empty object).

Example:

If data contains:

""

Usage:

{{isEmpty data}}

Output:

true

---

{{length varName}}

Returns the length of an array or a string. Returns "NaN" if the variable is not an array or string.

Example:

If list contains:

["a", "b", "c"]

Usage:

{{length list}}

Output:

3

---

{{markdown varName}}

Converts a Markdown-formatted string into HTML.

Example:

If markdownText contains:

# Hello World
This is **bold** text.

Usage:

{{markdown markdownText}}

Output:

<h1>Hello World</h1>
<p>This is <strong>bold</strong> text.</p>

---

{{formattedNumber number fractionDigits}}

Formats a number using locale‑specific formatting with a fixed number of fractional digits.

Example:

If amount is:

1234.567

Usage:

{{formattedNumber 1234.567 2}}

Output:

1,234.57

---

{{abbreviatedNumber number fractionDigits}}

Formats a number into a compact, abbreviated notation (e.g., 1K, 1M) with a specified number of fractional digits.

Example:

If amount is:

1500

Usage:

{{abbreviatedNumber 1500 1}}

Output:

1.5k

---

{{date varName format}}

Formats a date string according to the specified format. Supports both custom formats (e.g., "YYYY-MM-DD") and relative keywords like "fromNow" or "toNow".

Example:

If dateString contains:

2020-01-01T00:00:00Z

Usage:

{{date dateString "YYYY-MM-DD"}}

Output:

2020-01-01