AI Input Assistant

Found in: Settings > AI Input Assistant

The AI Input Assistant feature is currently available to super admin users in your organization. This feature requires the AI & Analytics Package subscription.

Overview

AI Input Assistant is an intelligent enhancement that adds AI-powered dropdown buttons to input fields and textareas throughout the application. Users can select from pre-configured AI prompts that process field data along with optional file attachments through AI agents and populate results back into the input.

How It Works for users

  1. Automatic Detection: The system automatically detects input fields and textareas on the page
  2. Smart Dropdown: A dropdown button appears when you hover or focus on compatible fields if it was configured for that field Input
  3. Prompt Selection: The user can choose from available AI prompts configured
  4. File Attachment: Optionally attach files that will be processed by the AI
  5. Intelligent Processing: The AI processes your input and attached files
  6. Result Population: Select preferred response from the AI to inject into the field

Configuration

An admin user can configure the feature by creating AI Inputs.

  1. Navigate to Settings -> AI Inputs
  2. Click on Create AI Input button
  3. Fill in the details

1. Basic Information Tab

Purpose: Configure the fundamental properties and targeting rules for the AI input.

  • Title (Required) - Descriptive name for the AI input assistant
  • Description - Detailed explanation of what the AI input does and when to use it
  • CSS Selector (Required) - CSS selector to target specific input fields or textareas. Use html inspector to find out which selector can be used. Preferred methods are targetting inputs by id or by name. I.e. #result or [name="result"]
  • URL Pattern - URL pattern where this AI input should be available. I.e. bookings/* to show it on booking page

2. Prompt Tab

Purpose: Define the AI prompt that will be used to generate content.

It is the main prompt template for the AI assistant. This text will be passed to the assistant along with page contents to obtain the response. Supports variable substitution using double curly braces

Variable Substitution Help

The interface provides comprehensive help for variable substitution:

Lodash Dot Notation:

  • {{context.model.id}} - Model ID
  • {{context.model.client.acronym}} - Nested property access

JSONPath Syntax:

Refer to: https://jsonpath.com/

  • {{$.context.model.id}} - Same as dot notation
  • {{$..name}} - Find all “name” properties
  • {{$.files[0].data}} - First file’s data
  • {{$.context.model[?(@.status=="active")]}} - Filter by condition

Examples

  • {{context.model.booking_uuid}} Booking UUID
  • {{context.model.client}} Booking Client
  • {{$.context.model.products.length}} Products count
  • {{$.context.model.products[*].product_name}} Product names
  • {{$.context.model.products[?(@.product_type=="other")].id}} - Product IDs that have product type other

Note: Variables that don’t exist will be left as-is in the output. Objects and arrays are automatically JSON-formatted.

3. Preview Tab (Conditional)

Purpose: Preview the AI prompt with actual context data substitution. Preview tab is only available when opening AI Input from a target page. Click on “pencil” icon from the dropdown to open such a page and experiment with variable substitution

Edit

You can preview how your prompt will be sent to an AI agent. Do edits in Prompt tab and return to Preview tab to fine-tune the prompt

Additionally, you can see the context which is available to the prompt. It contains page contents along with files that match the input configuration.

You can:

  • Copy Context & Help: Copies context data and variable substitution help to clipboard. Useful to paste instructions to a third-party AI agent and ask them to help with the prompt
  • Copy Context: Copies only the context data to clipboard

4. Access Control Tab

Purpose: Configure permissions and access rights for the AI input. Controls which user role will have access to use the prompt.

5. Files Tab

Purpose: Configure file filtering rules to determine which files should be included in the AI context. Create one or more groups to include files from different sections of the page.

For example, this filter combination will include all files that have .docx extension and are in documents subfolder. Filter

Best Practices

Writing Effective Prompts

  1. Be Specific: Use clear, detailed instructions for the AI
  2. Include Context: Reference relevant field names and data structures
  3. Set Expectations: Specify the desired output format and length
  4. Test Thoroughly: Validate prompts with various input scenarios

File Management

  1. Optimize File Sizes: Keep files under configured limits for faster processing
  2. Use Appropriate Formats: Prefer text-based formats when possible
  3. Organize Files: Use consistent folder structures for auto-attachment
  4. Monitor Usage: Track file processing costs and optimize accordingly

Performance Optimization

  1. Cache Responses: Enable caching for frequently used prompts
  2. Batch Operations: Process multiple files together when possible
  3. Monitor Queues: Ensure queue workers are running efficiently
  4. Review Logs: Regularly check for errors and performance issues

Summary

The AI Input Assistant provides a powerful, flexible system for enhancing user input fields with AI capabilities. By leveraging intelligent content generation and file processing, it significantly improves productivity and content quality while maintaining security and performance standards.

Key Benefits:

  • Enhanced Productivity: Faster, more accurate data entry with AI assistance
  • Content Quality: AI-enhanced content with automatic improvements and suggestions
  • File Processing: Automatic OCR and content extraction from documents
  • Flexibility: Highly configurable for different use cases and contexts
  • Integration: Seamless integration with existing systems and workflows
  • Security: Comprehensive access control and data protection measures