Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

draft bpmn copilot #4735

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

draft bpmn copilot #4735

wants to merge 3 commits into from

Conversation

christinaausley
Copy link
Contributor

@christinaausley christinaausley commented Dec 9, 2024

Description

Relates to feedback iteration of the Web Modeler BPMN copilot with https://github.com/camunda/product-hub/issues/2511.

Before merging, must confirm:

  • Screenshot is accurate based on product UI.
  • Links are provided for feedback and opting into the feature.
  • Confirmed this iteration is either alpha or experimental.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@christinaausley christinaausley added the deploy Stand up a temporary docs site with this PR label Dec 9, 2024
Copy link
Contributor

github-actions bot commented Dec 9, 2024

👋 🤖 🤔 Hello, @christinaausley! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.

  • docs/components/early-access/alpha/bpmn-copilot/bpmn-copilot.md
  • docs/components/early-access/alpha/bpmn-copilot/img/bpmn-copilot-chat.png

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@github-actions github-actions bot temporarily deployed to camunda-docs December 9, 2024 20:04 Destroyed
@christinaausley christinaausley added the component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS label Dec 9, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs December 9, 2024 20:46 Destroyed
@ev-codes
Copy link
Contributor

Thanks @christinaausley ! I'll take a look at this later this week 😄

Copy link
Contributor

@HanselIdes HanselIdes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ev-codes I added some thoughts. Please review them for accuracy and integrate them in. I do not need to re-review this doc

<span class="badge badge--cloud">Camunda 8 SaaS only</span>

:::note Terms of use
By using this tool, you agree to Camunda's use of the anonymized input and output data and anonymized feedback to improve it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
By using this tool, you agree to Camunda's use of the anonymized input and output data and anonymized feedback to improve it.
By using this tool, you agree to Camunda's use of the anonymized input and output data and anonymized feedback to improve it.
Camunda does not collect your prompts and the resulting BPMN diagrams.

@ev-codes to confirm

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@philippfromme will be the best person to confirm this, since he's working on the Copilot AI model directly.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@philippfromme Can you confirm here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we don't collect prompts (once you close the tab they're gone) and BPMN diagrams (beyond saving the latest BPMN diagram in the user's account of course).


3. In the chat box, enter your prompt. This prompt should be a simple, clear, and concise request describing the BPMN diagram you would like to generate. For example, "Generate a mortgage loan process diagram". For more information, you can also ask questions like "How do I design a process?"
4. Wait for your diagram to generate; this takes about 50 seconds. Once complete, the copilot will then respond with an outline of the process it created.
5. Review the generated diagram. If the diagram is not exact, you can continue chatting with the BPMN copilot by requesting changes or rephrasing your request. For example, "add exceptions". The new diagram will overwrite existing work, but the BPMN copilot will automatically generate a [milestone](/components/modeler/web-modeler/milestones.md) of the previous version, so you can return or revert to it anytime.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The more complicated the existing diagram, the longer it will to complete the request

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@christinaausley in the first phase (i.e., what would be available in January), this #5 point will not yet be available.

I recommend removing it entirely for now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this applicable to the copilot automatically generating milestones as well?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this still accurate? As far as I remember we agreed that we're not going to restrict the BPMN copilots abilities but will create a milestone before a BPMN diagram is generated and (optionally) add a step to ask for confirmation before generating.

Copy link
Contributor

@YanaSegal YanaSegal Jan 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Side note - we will not use the term Milestone but Versions.
https://github.com/camunda/web-modeler/issues/12444

Copy link
Contributor

@ev-codes ev-codes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @christinaausley ! I left a few points.

We should also revisit the screenshot in January closer to launch, as the UI and text may change slightly.

<span class="badge badge--cloud">Camunda 8 SaaS only</span>

:::note Terms of use
By using this tool, you agree to Camunda's use of the anonymized input and output data and anonymized feedback to improve it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@philippfromme will be the best person to confirm this, since he's working on the Copilot AI model directly.


3. In the chat box, enter your prompt. This prompt should be a simple, clear, and concise request describing the BPMN diagram you would like to generate. For example, "Generate a mortgage loan process diagram". For more information, you can also ask questions like "How do I design a process?"
4. Wait for your diagram to generate; this takes about 50 seconds. Once complete, the copilot will then respond with an outline of the process it created.
5. Review the generated diagram. If the diagram is not exact, you can continue chatting with the BPMN copilot by requesting changes or rephrasing your request. For example, "add exceptions". The new diagram will overwrite existing work, but the BPMN copilot will automatically generate a [milestone](/components/modeler/web-modeler/milestones.md) of the previous version, so you can return or revert to it anytime.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@christinaausley in the first phase (i.e., what would be available in January), this #5 point will not yet be available.

I recommend removing it entirely for now.

@christinaausley
Copy link
Contributor Author

Thanks all for your feedback -- I will clean up this PR next week, with plans for a final review/any minor updates closer to January.

@christinaausley
Copy link
Contributor Author

This has been tidied based on the comments. I will revisit this PR in January to confirm the UI references and screenshots.

@github-actions github-actions bot temporarily deployed to camunda-docs December 18, 2024 19:22 Destroyed
@christinaausley
Copy link
Contributor Author

@lmbateman @ev-codes Can you please have another look over these changes and confirm the UI? Would you like this to go out with alpha-3 next week?

@ev-codes
Copy link
Contributor

ev-codes commented Jan 9, 2025

@christinaausley thanks for checking in!

We won't be releasing this publicly for a few weeks. I'll do a final UI check closer to release.

Also: @YanaSegal is now the primary designer working on this project. I'll add her as a reviewer closer to release.

Thanks 😄

@christinaausley christinaausley added the hold This issue is parked, do not merge. label Jan 9, 2025
@github-actions github-actions bot temporarily deployed to camunda-docs January 9, 2025 15:43 Destroyed
Copy link
Contributor

github-actions bot commented Jan 9, 2025

The preview environment relating to the commit 7de1c5c has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4735/index.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS deploy Stand up a temporary docs site with this PR hold This issue is parked, do not merge.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants