Note: 

1. Generated scripts may not always be accurate, as is common with any AI. However, we are constantly refining it to maximize its reliability.
2. Generated scripts are adaptive. The same prompt may generate different scripts at different times based on how much the machine has learned.

1. Deluge Zia Assistance in a Nutshell

2. 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

3. Overview

1. ​Creating an OpenAI API key - Since Zia operates on the OpenAI API, you must create an API key from your OpenAI account.
2. Configue Zia and enable Deluge Assistance - Zia must be configured with the generated OpenAI API key to enable Deluge Assistance within Zoho Creator.

4. See How it Works

5. Business use cases

Case 1: Generate script to send invite mail

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

1. Write a script to calculate the number of working days between Start_date and End_date.

Info:
- Start_date and End_date are the two field link names of the date fields.

6. Set up Zia AI Assistant

6.1. Prerequisites

Note: Ensure that your are in paid plan of OpenAI with sufficient API credits for OpenAI API key to work.

1. Navigate to Settings in your OpenAI account and select the Billing section.
   
2. Click the Add Payment Details button in the Settings page and add your required details.
3. Navigate to the API keys section and click Create new secret key.
   
4. Enter a name (optional) and choose the required project. Click Create secret key. 
   

6.2. Configure Zia - OpenAI Integration

Note: Only the super admin and admins can configure Zia in Creator.

1. Navigate to Operations in your Creator account.
   
2. Click Zia in the Applications card. The Settings screen will appear.
   
Note: If you have already added an API key, then proceed to step 6.

3. Ensure the OpenAI model is selected from the drop-down in the Configuration tab and click the Add API Key button. A popup will appear.
   
Note: Currently, Zia Deluge assistance is only supported with the OpenAI language model integration.
4. Enter your OpenAI API Key and click Add. 
   
5. To edit or update the key after adding it, click Edit. update the key in the pop-up that appears, and click Save.
   
Refer to this page to know more about OpenAI's authentication.
6. Toggle the Access button beside Deluge Assistance in the Enable Features section. This button will be disabled by default. Enabling it will allow you to use the combined capabilities of Zia and OpenAI to generate scripts.
   

7. Generate a script with the help of AI

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.

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.

7.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.”

8. Manage OpenAI API Usage

1. Navigate to Operations > Zia > Usage and click the Visit OpenAI button. You will be redirected to the OpenAI developer platform login page.
   
2. Log in to your OpenAI account that contains the API key used for this integration and click Usage from your OpenAI Dashboard to view the monthly usage of APIs in your OpenAI organization. Learn more about OpenAI Usage Dashboard

9. Limitations

1. The script generated may not be accurate, which is also the case with any AI. 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. OpenAI API Rate limits: Rate limits are restrictions that OpenAI's API imposes on the number of times a user or client can access their services within a specified period of time and vary based on their usage tier and the model consumed. Since Zia operates with the OpenAI API key, the rate limits are applicable to it as well. To check the rate limit for your account associated with the API key used in this integration, visit https://platform.openai.com/account/limits.
5. 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 OpenAI token usage.
6. A user can only give up to 20 prompts per minute.
7. Zia Deluge Assistance is not available in page scripts and application IDE.
8. The script generated by Zia will not include custom functions calls, App variables, Connections, and User details in your Zoho Creator Account.

10. Related Topics

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