Auto generate rule description using AI

The auto-generate rule description feature enhances the rule reuse and clarity by providing meaningful explanations for rules created within the application. This feature allows users to automatically generate descriptions for rules using the defined rule parameters, making it easier for other users to understand the purpose and logic behind each rule.

Benefits

• Promotes rule reuse: Provides clear and detailed explanations to help others understand your rules easily. When rules are well-explained, they’re easier to apply across different contexts, reducing duplication and improving efficiency.

• Ensure consistency across your workspace: Use standardized language and formatting in rule descriptions to maintain uniformity. This reduces misunderstandings and ensures everyone interprets and implements rules the same way.
  Note: To utilize the auto generate rule description feature on the rules page, you must initially enable the Generate Rule description functionality at the workspace level in the AI tab. If disabled, the Generate button will not appear in the rule creation interface. For further guidance, refer to the AI manager documentation.

To auto generate rule description:

1. On the main navigation menu, click Quality and navigate to Rules.
2. On the Rules page, click on the Create Rule button
3. Enter the necessary rule parameters, including name and dimension. Provide a name that helps to set context for the rule and select an appropriate dimension.
4. Select the target datasets that have to be evaluated by the rule and define the pass conditions.
5. Once all the parameters are defined, click Generate below the Description box to automatically generate the rule description.
   The application will automatically generate a rule description based on the defined parameters for the rule.

   Tip: Click Retry to regenerate the rule description. After each attempt, it is possible to return to previous versions, review earlier descriptions, and select the one that best meets your requirements. You can use the Retry option up to five times. To access more options beyond this limit, please refresh the page.

6. Click on the Create button to save the rule with the generated description and other details.

The rule description may be further refined following its initial generation.

To edit the generated rule description:

1. On the main navigation menu, select Quality and navigate to Rules.
2. On the Rules page, locate the desired rule and click the ellipsis icon adjacent to it.
3. Select Edit.
4. In the description box, click Generate to automatically produce a new rule description. The system will regenerate the rule description accordingly.
5. If the AI-generated output doesn't meet your expectations, you may manually modify the rule description as needed to satisfy the specific requirements.