Skip to main content

What is AI Assistant?

AI Assistant is an integrated AI-powered tool that assists with content creation in pipeline nodes. Instead of manually writing complex prompts, code, or templates from scratch, you can:
  • Generate content from natural language instructions
  • Improve existing content by providing refinement prompts
  • Iterate quickly with split-view comparison between original and improved versions
  • Leverage AI reasoning to create better configurations
AI Assistant uses the pipeline’s configured LLM model and settings. Configure this at the pipeline level to control which model, Creativity, Max Completion Tokens and other parameters are used for content generation.

Key Benefits ✔️ Faster Configuration - Generate complex content quickly from simple instructions ✔️ Higher Quality - Leverage AI to improve prompts, code, and templates ✔️ Iterative Refinement - Compare original and improved versions side-by-side ✔️ Context-Aware - AI Assistant understands the node type and purpose ✔️ Consistent Style - Uses your pipeline’s LLM configuration

How AI Assistant Works

Access AI Assistant AI Assistant is available on text input fields that support it. Look for the AI Assistant icon (🪄) on the right side of the field: Click the icon to open the AI Assistant modal dialog. AI Assistant Modal The modal provides a full-screen editor with AI-powered content generation: AI Assistant Icon Modal Components:
  1. Editor Area - View and edit your content with syntax highlighting
  2. AI Prompt Input - Natural language instructions for content generation
  3. Language Selector - Choose syntax highlighting (auto-detected)
  4. Action Buttons - Copy, apply, and close controls
Single View Mode When you first open AI Assistant with empty content or request new content:
  • Editor displays your current content (or empty state)
  • Prompt Input accepts your instructions
  • Generate creates content based on your prompt
  • Result appears directly in the editor
AI Assistant Icon Split View Mode When improving existing content:
  • Left Panel - “Current Version” (read-only reference)
  • Right Panel - “Improved Version” (AI-generated result)
  • Compare - See differences side-by-side
  • Apply - Replace current content with improved version
  • Close - Discard improvements and return to single view
AI Assistant Icon

Supported Nodes and Fields

AI Assistant is available in the following pipeline nodes and their specific fields:

LLM Node

Use Cases:
  • Generate comprehensive system prompts for specialized agents
  • Create clear, structured task instructions
  • Build example conversations for testing
Prompt: “Create a system prompt for an AI assistant that helps developers write unit tests”Generated System Prompt:

Code Node

Use Cases:
  • Generate data transformation logic
  • Create calculations and business rules
  • Build API integration code
  • Improve code quality and error handling
Prompt: “Write Python code to calculate tiered discounts: 10% for orders 100500,15100-500, 15% for 500-1000, 20% for $1000+”Generated Code:

State Modifier Node

Use Cases:
  • Format output messages with state variables
  • Build reports and summaries
  • Build structured responses
Prompt: “Create a Jinja template that formats a user story with title, description, acceptance criteria, and metadata”Generated Template:

Router Node

Use Cases:
  • Create multi-path routing logic
  • Build approval workflows
  • Implement status-based routing
Prompt: “Create a router condition that routes to ‘Approved’ if status contains ‘approved’, ‘Rejected’ if ‘rejected’, ‘Pending’ if ‘review’, otherwise ‘Default’”Generated Condition:

Decision Node

Use Cases:
  • Describe decision criteria clearly
  • Provide context for intelligent routing
  • Document decision-making logic
Prompt: “Write a decision description for routing customer support tickets based on urgency and topic”Generated Description:

HITL Node

Use Cases:
  • Craft clear, context-aware approval request messages
  • Build F-String messages that embed state variable content for user review
  • Write actionable interrupt prompts that guide the user on what to do next
  • Create professional review messages for compliance or content approval workflows
Prompt: “Write an F-String user message asking the reviewer to read a generated article draft and choose an action. The message should show the article title and summary, and explain what each button does.”Generated User Message:

Printer Node

Use Cases:
  • Display static completion messages
  • Show formatted output combining text with variables
  • Pause pipeline for user inspection
  • Show progress updates during multi-step workflows
Create a comprehensive processing summary that combines multiple variables and includes conditional formatting.Prompt: “Create a detailed processing summary message that shows the project name, total items processed, success count, failure count, success rate percentage, processing time, and a status indicator (✓ if success rate > 90%, ⚠ if 70-90%, ✗ if < 70%)”Generated F-String:
Example Output:

Using AI Assistant: Step-by-Step

1. Generate New Content

Scenario: You need to create a system prompt for an LLM node but aren’t sure how to structure it. Steps:
  1. Open the LLM node configuration
  2. Click the AI Assistant icon (🪄) on the “Task” field
  3. Enter your instruction in the AI Prompt Input:
  4. Click “Generate” or press Enter
  5. Review the generated content in the editor and edit if needed
  6. Close the modal - content is now in the System field
Genarate

2. Improve Existing Content

Scenario: You have a working prompt but want to make it more specific and detailed. Steps:
  1. Open AI Assistant on a field with existing content
  2. Review current version in the editor
  3. Enter improvement instruction in the AI Prompt Input:
  4. Click “Generate” - AI Assistant switches to split view
  5. Compare versions side-by-side:
    • Left: Original content
    • Right: Improved content
  6. Click “Apply” to use the improved version, or
  7. Click “Close” (X) to discard and keep original
Improve

3. Iterative Refinement

Scenario: The generated content is good but needs additional refinement. Steps:
  1. Generate initial content using AI Assistant
  2. Review the result in split view
  3. Enter a refinement prompt without applying:
  4. Click “Generate” again - improved content updates
  5. Continue refining with additional prompts:
  6. Apply when satisfied with the final result

4. Error Handling and Retry

Scenario: AI Assistant encountered an error during generation. What you’ll see:
  • Error message displayed in the editor
  • Prompt input remains filled with your instruction
  • Split view (if previously shown) stays open
Steps to retry:
  1. Review the error message (e.g., “Error: Rate limit exceeded”)
  2. Your prompt is preserved - no need to retype
  3. Click “Generate” again to retry
  4. AI Assistant retries with the same prompt
  5. Previous error is cleared if successful

Common Use Cases

Challenge: Creating effective system prompts that properly constrain LLM behavior.Solution with AI Assistant:
Challenge: Creating multi-condition routing in Router nodes.Solution with AI Assistant:
Challenge: Writing Python code for state transformations.Solution with AI Assistant:
Challenge: Creating readable, well-formatted output displays.Solution with AI Assistant:
Challenge: Writing clear, actionable interrupt messages that tell reviewers exactly what to do and what each button means.Solution with AI Assistant:

Best Practices

✔️ Be Specific
  • ✘ “Write a prompt”
  • ✔️ “Write a system prompt for an AI assistant that reviews Python code for PEP 8 compliance”
✔️ Provide Context
  • ✘ “Generate code”
  • ✔️ “Generate Python code that reads CSV files, filters rows where status=‘active’, and returns a list of user IDs”
✔️ Include Examples
  • ✘ “Create a template”
  • ✔️ “Create a Jinja template that displays user information in this format: ‘Name: John Doe, Email: john@example.com, Role: Admin’”
✔️ Specify Format Requirements
  • ✘ “Make routing logic”
  • ✔️ “Create router condition using Jinja2 syntax that routes based on ‘priority’ field: high→Urgent, medium→Normal, low→Backlog”
Start Simple, Refine
  1. Generate basic content first
  2. Review what AI created
  3. Add refinement prompts incrementally
  4. Apply when satisfied
Use Split View Effectively
  • Keep original on left as reference
  • Compare specific changes in improved version
  • Apply only when improvements are clear
  • Close split view to start over if needed
Always Review Generated Content
  • AI Assistant is powerful but not perfect
  • Verify logic, syntax, and requirements
  • Test generated code in safe environment
  • Validate templates with sample data
Understand Generated Code
  • Don’t blindly apply code you don’t understand
  • Review variable names and logic flow
  • Ensure error handling is appropriate
  • Check for security considerations
Use Appropriate Field Types
  • Use AI Assistant for complex, creative tasks
  • For simple static values, type directly
  • Reserve AI for prompts, code, templates
Leverage Pipeline LLM Configuration
  • AI Assistant uses your pipeline’s LLM settings
  • Configure appropriate model for your needs
  • Adjust temperature for creativity vs. consistency

Troubleshooting

Issue: AI Assistant icon not visible on a field.Possible Causes:
  • Field doesn’t support AI Assistant
  • Pipeline LLM configuration is missing
  • Node type doesn’t enable AI Assistant
Solution:
  1. Verify the field supports AI Assistant (see Supported Nodes)
  2. Check pipeline configuration → Ensure LLM model is configured
  3. Verify you’re using a supported node type
Issue: Clicking “Save” doesn’t update the node field.Possible Causes:
  • Modal closed without saving
  • Content validation failed
  • Browser cached old value
Solution:
  1. Re-open AI Assistant modal
  2. Verify content is still in editor
  3. Click “Save” button explicitly
  4. Check node field updates after closing modal
Issue: AI Assistant displays error message instead of content.Common Errors:
  • “Rate limit exceeded” - Too many requests to LLM
  • “Invalid API key” - LLM credentials issue
  • “Timeout” - Request took too long
Solution:
  1. Wait a moment and click “Generate” again (prompt preserved)
  2. Simplify your prompt if too complex
  3. Check pipeline LLM configuration and credentials
  4. Contact administrator if persistent API errors
Issue: Expected split view comparison but seeing single view.Possible Causes:
  • Current content is empty
  • Current content starts with “Error”
  • First-time generation
Expected Behavior:
  • Empty content + Generate → Single view (new content)
  • Existing content + Generate → Split view (comparison)
  • Error content + Generate → Single view (retry)