Create and view item descriptions for ReviewAI

Dina Bennett
Dina Bennett
  • Updated

Use the checklist item description field to define what reviewers should look for and how ReviewAI should interpret each checklist item. 

Available for administrators on: Enterprise

The checklist item description field is where you set the intent of the check and clarify what “pass” and “fail” mean, adding context, and specifying details that ReviewAI can’t infer on its own. Each time you edit and save a description, Ziflow creates a new version so you can see past versions, test improvements, and view ReviewAI’s reliability level.

ReviewAI is available as a paid add-on for Enterprise customers. To learn more about enabling ReviewAI and our introductory pricing, please contact your Ziflow Customer Success Manager.

 

Data privacy

ReviewAI uses third-party AI services, but your data is never used to train or tune those models. It remains private and is only processed within your Ziflow environment to support your review workflows.

Add a checklist item description

Checklist item descriptions are part of each checklist item in your template. For more information on adding checklist templates, see Create a checklist template

The Description field for each checklist item can include instructions for reviewers and is the starting point that ReviewAI uses to generate suggested results. 

checklist-description-fiield.jpg

To start viewing ReviewAI prompt descriptions, save your checklist and run ReviewAI at least once.

Suggested workflow:

  1. Add a description to your checklist item in the Description field.
  2. Enable ReviewAI (if it isn't already enabled) and select Save
  3. Add the checklist to a proof.
  4. Open the proof in the Proof Viewer and run ReviewAI.
    ReviewAI uses your latest description to make pass/fail suggestions (called suggested results).
  5. Select the edit icon to open your checklist. You will now see a Show ReviewAI prompt description link when you expand the checklist item. 
    Each time you edit and save the checklist item description or the ReviewAI prompt description, a new prompt description version is stored automatically.
  6. Test your prompt. 
  7. Save the checklist and reset the checklist in the Proof Viewer to apply your latests description changes, then run ReviewAI again.

View prompt description versions

Once you enable ReviewAI and run your first ReviewAI session in the Proof Viewer, you can view your prompt description versions.

  1. Open your checklist item and select Show ReviewAI prompt description.

    ai-show-reviewai-version.jpg
     
  2. View the latest version, or choose a previous version from the drop-down list.  

    ai-choose-version.jpg
     

View your reliability score

Run ReviewAI at least 10 times on the same checklist to generate a Reliability level:

  • High  = ReviewAI makes the same decision as a human more than 90% of the time.
  • Medium = ReviewAI has between 51-89% reliability and requires improvement.
  • Low  = Indicates that more description refining and testing is required (below 50% reliability).
  • Not evaluated: There is not enough data collected to evaluate ReviewAI's performance (less than 10 reviews). 

To find your reliability level, open your prompt version in the checklist item description, or to view the current version's accuracy, expand the checklist item in the Proof Viewer.

expand-item.jpg

 

Edit a prompt description

Edit a ReviewAI prompt description to refine how ReviewAI interprets a checklist item. For writing tips, see ReviewAI prompt description guidelines.

Each time you edit a ReviewAI prompt description, ReviewAI automatically creates a new minor version (for example, from 1.1 to 1.2).

v1  ───── v2  
│  
├── v1.1  
└── v1.2  ← edited prompt description
 

Note: Editing the ReviewAI prompt description does NOT change the checklist item description. 

  1. Open the description through the ReviewAI prompt description link from the checklist item.
  2. In the latest version, select Edit
  3. [Optional] Select Improve to let ReviewAI suggest a prompt that you can refine.

    If you have any specific changes that you want the AI to understand, type them in the description box before you select Improve to further refine the prompt.

  4. Make your changes and select Save.

    ai-choose-version.jpg

When you edit the ReviewAI prompt description:

  • New reviews that use this checklist will automatically use the latest version of the prompt description.
  • Existing reviews that already use the checklist will continue running the previous version until the checklist is reset or re-added.

How editing affects versions

  • Editing the ReviewAI prompt description: creates a new minor version (1.1 → 1.2).
  • Editing the checklist item description: creates a new major version (1.0 → 2.0).

When you edit the checklist item description:

  • New reviews that use this checklist will automatically use the latest version of the prompt description.
  • Existing reviews that already use the checklist will continue running the previous version until the checklist is reset or re-added.

Earlier prompt description versions remain available for reference and copying from the ReviewAI prompt description link.

Test prompt descriptions

After you edit a prompt description, you can test your new prompt in the editing window. You can use any eligible proof (static assets (images, PDFs) up to 10 pages) you have in your dashboard, even archived or locked proofs.

The test prompt sandbox is not part of any proof review process and does not consume ReviewAI usage credits.

  1.  Open the description through the ReviewAI prompt description link in the checklist item.
  2. In the latest version, select Edit
    Edit your prompt and select Test prompt. The test area opens.

    test-prompt-open.jpg
     
  3. Paste a proof ID or a public proof link in the test area and select Run test.

    test-prompt-run.jpg
     
  4. Wait for the test to run. Do not close the window or you will cancel the test and lose your results.
  5. Read your results and refine your prompt until it provides consistent results. Test with as many proofs as you want to establish a strong ReviewAI prompt description.

    As you edit and test, save your prompt to keep previous versions. Any edits that you do not save are replaced with the new prompt.

Was this article helpful?

Comments

0 comments

Please sign in to leave a comment.