Skip to main content

AutoReview: Prompting

Updated over 4 months ago

AutoReview can leverage user-generated text-based prompts to guide individual peer checker runs and produce more relevant, targeted results. Prompts are optional, and can be added to both general analysis and checklist-based runs.

How to include a prompt

To run an analysis with a prompt, simply select the type of analysis you would like to run, and enter your prompt in the free-text field provided. Clicking the submit button will trigger the analysis, incorporating the chosen checklist and the prompt entered.

Note: To trigger an AutoReview run without a prompt, simply leave the free-text field blank and click on the submit button next to the field.

If a prompt was used in a peer checker analysis run, the prompt will show in the description section of the run header.

Writing effective AutoReview prompts

Optimal for Best Results

Avoid

Content

  • Details and context about the design not captured in the file, such as:

    • Material(s) used in the design

    • Intended fabrication method

    • Application details about how the design will be used

  • Instructions for what AutoReview should verify on a file

  • Complex or multi-step instructions for what AutoReview should check on a file

  • References to information AutoReview lacks access to

  • Requests to provide costing estimates or design optimization feedback

Style & Format

  • Direct and concise

  • Complete sentences

  • Address AutoReview as “you”

  • Fragmented sentences

  • Non-punctuation characters and symbols

Prompting Do's

AutoReview operates best when prompts are related to formatting, typos, material inconsistencies and missing dimensions. Other prompts may be actioned with less success. Expanded support for additional review areas is in progress.

The following are examples of well-formed prompts:

This is part of the housing for an outdoor camera. It will be injection molded using nylon.

This is an injection molded conical fitting for a ventilator machine. Make sure all date fields are filled in.

This is a machined rod end with a swivel pocket, made from 304 stainless steel. Ensure that material and surface finish details are called out.

This is a welded fuel tank bracket assembly drawing. Ensure all the units are consistent in the drawing and that no more than 3 significant digits are reported in dimensions.

Prompting Dont's

⚠️ Prompts detected as containing malicious intent will cause the AutoReview run to fail.

The following are examples of prompts that will not work well and should be avoided:

Aluminum enclosure - check holes (threads, size) indoor box thing.

Part of housing outdoor camera nylon injection molding.

I want you to suggest how to redesign this bracket to make it stronger.

What is the estimated cost to produce this component?

Did this answer your question?