Design Assistant

Available in product edition: Professional

⚠Beta

The Design Assistant is in beta. Capabilities are limited to certain tasks in this release and will be expanded in future versions. Behaviour and supported operations may change.

Introduction

The Design Assistant is an AI-based chatbot integrated into the Solution Builder. It supports users during their daily design work by answering questions about the current project and executing design tasks on their behalf.

The assistant is accessible from anywhere within the workbench, so teams can get guidance quickly without breaking their flow.

Capabilities

The Design Assistant currently supports two main areas:

• Answering questions about the current design — explore and understand the model elements, relationships, and overall structure of your project through natural-language questions.
• Executing design tasks — create model elements, establish relationships between them, and perform other design operations based on your instructions.

ℹ️note

The capabilities of the Design Assistant are limited to certain tasks in this release. Support for additional operations will be added in upcoming versions.

Using the Design Assistant

Opening the chatbot

1. Open a project in the Solution Builder — the chatbot icon only appears within projects.
2. Click the Chat icon in the top header bar. The chatbot opens as a sidebar panel on the right-hand side.
3. Click the same icon again (or the close button inside the sidebar) to close it.

Interacting with the chatbot

Action	How
Send a message	Type in the text area and press Enter. Use Shift+Enter to insert a newline. You can also click the send button.
Stop generation	While the assistant is responding, a stop button appears — click it to cancel the current response.
Start a new session	Click Start new session in the sidebar header to clear the conversation and begin fresh. Disabled while the assistant is actively streaming.
Use example prompts	When the conversation is empty, clickable prompt chips are shown to help you get started.
Confirm or reject actions	Some responses request a confirmation before applying a change. Confirm and Reject buttons appear on those messages and can each only be clicked once.

Good to know

• The chatbot automatically uses the current project and branch as context — you do not need to specify them.
• Chat history is session-only. It is not persisted to the server or local storage. Closing the sidebar or starting a new session clears the conversation.
• Responses are streamed in real time via server-sent events (SSE).

Usage hints

• When referring to existing instances, use the exact label values or exact file names so the assistant can identify the intended instance reliably.
• Wrapping labels and file names in quotes ("...") can improve identification.
• Some actions require confirmation during the flow. If a suggestion is not correct, click Reject and tell the assistant what should be changed.
• Conversation history for the current session is considered up to 20 messages. Keep sessions at 20 messages or fewer to ensure all relevant context is considered.
• It is recommended to start a new session when switching to a new topic or task.

Asking questions

Use the Design Assistant to explore and understand your project without navigating through the UI manually. The assistant can interpret your OML configuration and the current design data to provide concise answers.

Example questions:

In a nutshell, what is the content of this project?

Provides a high-level summary of the project scope and its main design elements.

What are the available REST APIs?

Lists all REST API elements defined in the current branch.

What are the available entities and how are they connected?

Describes the entity model elements and the relationships between them.

List all the available model elements in the project and how they are related.

Gives a comprehensive overview of every model element and their connections.

Executing design tasks

Beyond answering questions, the Design Assistant can create and modify design elements based on your instructions. Describe what you need in natural language, and the assistant translates your intent into concrete design operations.

Example prompts:

Creating multiple elements at once

Create 10 REST APIs: names should all be prefixed with "version" and increasing numbers as suffix.

The assistant creates ten REST API elements named version1, version2, … version10.

Creating entities with properties and inheritance

Create the following entities:
- abstract root entity "Expense" which is an entity for the travel expense management, with the following properties:
  - expenseId (string, required)
- root entity "Meals Expense", extending "Expense"
  - mealName (string, required)
  - breakfast (boolean, optional)
- root entity "AccomodationExpense", extending "Expense" with the following properties:
  - hotelName (string, required)

The assistant creates the entity hierarchy including all properties and inheritance relationships.

Cloning configuration from existing elements

Create new REST API "v2" with same description, summary and interaction type as REST API v1.

The assistant reads the properties of the existing element and applies them to the newly created one.

Limitations

Because the Design Assistant is in beta, keep the following in mind:

• Only a subset of all available design operations is supported. Complex multi-step workflows may require manual intervention.
• Responses depend on the AI model's interpretation of your prompt — be as specific as possible for best results.
• The assistant operates within the scope of the currently selected project and branch.