Generate Deluge Scripts Using Zia Assistance

Generate Deluge Scripts Using Zia Assistance

Notes
Note: 
Generated scripts may not always be accurate, as is common with any AI. However, we are constantly refining it to maximize its reliability.
Generated scripts are adaptive. The same prompt may generate different scripts at different times based on how much the machine has learned.
Info
In a nutshell
Zia Assistance can generate Deluge scripts directly from the Deluge editor by understanding your requirements through conversational prompts. Zia Assistance leverages advanced technologies like Natural Language Processing (NLP) and machine learning, powered by GenAI, to make complex scripting more accessible and efficient. By following best practices in Deluge, it reduces potential errors and enhances the overall development process, providing optimized and reliable scripts to boost faster implementation.
Availability
  1. Available for paid plans of Creator
  2. Available across United States (.com), Europe (.eu), India (.in), Australia (.au), and Canada (.ca) data centers

1. Overview

Zia Assistance, powered by GenAI an advanced, reliable and cost efficient model that leverages Natural Language Processing (NLP). It generates Deluge scripts in Zoho Creator by interpreting your requirements through conversational prompts. Zia can be accessed directly from the Deluge editor within workflows or functions, offering real-time assistance for writing Deluge scripts. This accelerates and streamlines the scripting process. By analyzing the application's metadata, Zia generates optimized scripts that consider the existing relationships between forms. It also eliminates the unsupported tasks in the associated workflows or functions, making Deluge coding more user-friendly and error-free. 

To access Zia Deluge Assistance in your Creator's Deluge editor, you'll need to complete a one-time setup, which includes:
  1. Creating a API key - Since Zia operates on the multiple different APIs, you must create an API key from your desired GenAI account except when using Zoho GenAI as the LLM vendor.
  2. Configue Zia and enable Deluge Assistance - Zia must be configured with the generated API key to enable Deluge Assistance within Zoho Creator.
NotesNote: You can also use Zia's Build Agent to generate Deluge scripts for workflows, functions and other application components. Build Agent is an AI-powered development assistant that helps you create and modify application components using natural language prompts. 

2. Prerequisite

Configure Zia
To generate Deluge scripts using AI you should configure Zia, which is a one-time process that grants you access to all Zia features in your Creator account. Zia is configured with the Zoho GenAI LLM provider by default, so no additional setup is required. If you prefer a different provider, you can integrate Zia with any of the supported LLM providers (OpenAI and Anthropic). Learn how to configure Zia.

Enable Deluge Assistant feature
1. Navigate to Operations > Zia > Features. The Features tab displays a list of all available Zia features.


2. Toggle the Access button beside Deluge Assistance in the Feature access section to enabled it. Choose a configured LLM provider for the feature.
This button will be disabled by default. Enabling it will allow you to use the combined capabilities of Zia and GenAI to generate scripts.
Notes
Note: Only a super admin can enable or disable, and configure an LLM provider for Create Form feature in Zia.

3. See How it Works


4. Business use cases

Case 1: Generate script to send invite mail

Consider a Zoho Creator Sales application used by an organization to manage sales activities. To enhance customer engagement, you can automatically send an invitation email whenever a new customer is added. Traditionally, this would involve configuring a workflow with an 'on success' action and writing a script using the send mail task. However, with Zia Assistance, this process is streamlined. By providing a natural language prompt, Zia generates the required script by analyzing the workflow and application metadata.
As you can see, Zia smartly accesses form fields using the input keyword, as the script is written in the 'on success' workflow action. It also includes sample email content within the generated script.
  1. Whenever new customer data is added to the form, send an invitation email to the customer's address.

Case 2: Calculate the number of days between two date fields

Assume a Creator Project Management application with a Project Details form used to store relevant project information for planning and allocating tasks across your organization. To ensure the project stays on schedule, it's crucial to calculate the number of available business days between the start and end dates in the Project Details form, excluding weekends and public holidays. For this, a Deluge script is needed to determine the exact number of working days for a particular task. With Zia AI Assistant, you can easily generate this script by providing a prompt, as shown below.
  1. Write a script to calculate the number of working days between Start_date and End_date.
Info
Info: Start_date and End_date are the two field link names of the date fields.

5. Generate a script with the help of AI

Notes
Note: You can generate scripts using Zia from the Deluge editor across any workflows or functions. For demonstration purposes, we've used the Deluge editor in the On Success workflow action to illustrate how to create scripts with Zia.
  1. Create a workflow to execute on a preferred event and click Add New Action > Deluge Script to open the Deluge Editor as shown in the video below.

  2. Click the Zia icon () in the editor to open the Zia Assistant chat window.
  3. Type your prompt in the window that slides up. The relevant script based on your prompt will be generated by the Zia Deluge Assistant.
  4. You can either copy the script by clicking the copy icon (), or drag and drop it into the editor from Zia.
You can review the generated script and either use it directly in your workflows or modify it to meet your specific requirements. It is recommended to test the script's functionality by triggering the workflow in the application's live mode. For more streamlined development, you can enable environments and test the script effectively using the live mode of the development or staging environment.
Notes
Note: 
- Once you exit the Deluge editor, the prompts and responses within the Zia Assistant chat window will be cleared.
- You can use the thumbs up or down buttons to provide feedback on the generated script. By doing so, your prompt and script are shared with us for improving Zia's performance.

5.1. Prompt guidelines

  1. It is recommended to use clear and appropriate language when entering prompts. The use of harsh or unclear language will result in inaccurate responses. For example, if you want to send an email to specific email addresses stored in a field of a form, it’s advisable to clearly mention the form name, the email field name, the criteria for selecting the emails, and the subject content in the prompt to generate a more precise and accurate script.
  2. You can specify the component name, link name, field name, or field link name along with the prompt to effectively utilize your created components for generating accurate scripts.
  3. Examples of well-structured prompts:
    1. “Create a script for sending email notifications to the address in the 'Email' field of the 'Orders' form to track the delivery of a product.”
    2.  “Write a script to update an element in the collection variable and return the updated variable.”

6. Manage API Usage

To view the monthly API usage of the selected LLM vendor:
  1. Navigate to Operations > Zia > Usage and click the button. You will be redirected to the selected GenAI developer platform login page. You can login and view the monthly usage of APIs in your organization from the GenAI vendor Dashboard.

7. Limitations

  1. The script generated may not be accurate, which is also the case with any GenAI. However, we are working on improving this.
  2. The generated scripts are adaptive, indicating the same prompt may yield different responses at various times based on how much the machine has learned.
  3. Based on your prompt and requirements, Deluge Zia assistance can generate scripts with capabilities like deleting records or modifying critical data. It is recommended to carefully review the generated code before execution to prevent unintended data loss or changes.
  4. Along with your prompts, our system will add supplementary prompts to enhance the accuracy of the script generation process. These system prompts will also contribute to your GenAI usage.
  5. A user can only give up to 20 prompts per minute.
  6. Zia Deluge Assistance is not available in page scripts and application IDE.
  7. The script generated by Zia will not include custom functions calls, App variables, Connections, and User details in your Zoho Creator Account.

8. Points to note

  1. Zoho GenAI processes all prompts within Zoho, while external LLM providers process data in their own systems. Avoid sharing sensitive or regulated information when using external providers.
  2. Deluge Assistance can be configured to use either Zoho GenAI or external LLM providers. Zoho GenAI does not consume AI calls or API calls from Creator. External LLM providers impose their own API rate limits, which vary based on the provider, usage tier, and model. Refer to the respective LLM provider's official documentation for details on their rate limits.
    1. OpenAI rate limits
    2. Google Gemini rate limits
    3. Anthropic rate limits
Notes
Note: Attempting to create multiple apps at once can result in rate limit errors. For instance, if you're creating multiple apps in quick succession, you may exceed the 15 RPM limit and cause an error.
While generous, these limits can still impact high-frequency operations, especially in rapid app creation scenarios.

9. Related Topics

  1. Understand Zia features in Creator
  2. Create forms using Zia assistance
  3. Generate field suggestions for AI assisted forms