Ask, review, apply

The Assistant prepares a change; you decide. This guide takes one change from your words to the model, on the Claims Platform example, and shows how to undo it.

Before you start

• A diagram you can edit, open in the editor. To follow the example, use a containers view of the Claims Platform with a Claims API container.
• The Assistant on. It is on for your personal workspace. In an organisation, an owner turns it on first: see Turn on the Assistant for your organisation.
• Credits left on your plan. A change uses credits; the panel shows the estimate before it runs. See How the Assistant uses credits.

Ask for a change

1. Open the Assistant

   Press Ctrl J, or choose Ask the Assistant in the Assistant menu. The panel opens beside the canvas with its box at the bottom: Ask or describe a change.

2. Describe the change in your words

   Say what you want, as you would to a colleague. Name the elements as they appear in the diagram, or type @ to point at one:

   “Add a Fraud Scoring service that the Claims API calls synchronously over HTTPS before it accepts a claim.”

   Press Enter to send (Shift Enter adds a line). To stop a request that is running, press Esc in the empty box.

3. Read the proposal

   The card in the panel says how many changes are ready, for example 3 changes ready on the canvas, and the canvas shows them as ghosts. Read the list of changes on the card: every row is ticked. Untick a row you do not want.

   The card also says where the changes go: Applies into this diagram as one undo step. or, for a new diagram, Applies into a new diagram: the open diagram does not change.

4. Apply

   Select Apply 3 changes on the card, or press Ctrl Enter while the proposal has the focus.

   The ghosts become part of the drawing with the new Fraud Scoring element, and the card reads Applied 3 changes. The change is saved as a new version of the diagram.

Undo an Apply

Select Undo on the applied card, or press Ctrl Z. The card reads Undone. The diagram is as it was.

If you edited the diagram after the Apply, the Assistant cannot take the change back alone and says so: use Before / after in the diagram's history instead. See Save and restore versions.

Change the proposal before you apply

• Ask again in the same conversation. While a proposal waits, what you type next updates it: Changes you ask for now update the proposal above. Nothing is applied until you click Apply.
• Answer its questions. When the Assistant needs a value, the card shows Questions about this proposal. Type your answers, then Update the proposal with my answers. You can also apply at once: unanswered questions keep the proposed values.
• Drop it. Discard removes the proposal and the ghosts. Nothing was applied.

What the Assistant holds back

The Assistant changes only what your words ask for. Removals, security settings, view edits and moves wait for your say:

• When it left something as it is, its card says why, for example I left the security settings of Claims API as they are: your request didn't ask to change them.
• A button on that line, such as Remove it too, proposes that one extra change and nothing else. You still apply it.
• The options of a request list what it may change: Allow removals, Allow security-relevant changes, Allow view edits.

Coming soonThe Apply bar stays in view while you read a long proposal.

If it doesn't work

More symptoms: Assistant troubleshooting.