Jump to: navigation, search

Difference between revisions of "Intelligent Atelier (Plugin)"

m
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
The {{UBIK}} Intelligent Atelier Plugin provides a user interface for interactive agentic AI modelling in {{UBIK}} Studio.
 
The {{UBIK}} Intelligent Atelier Plugin provides a user interface for interactive agentic AI modelling in {{UBIK}} Studio.
−
{{UnderConstructionStart}}
+
 
 +
== Overview ==
 +
The Intelligent Atelier can be used to develop part of a {{UBIK}} customizing, debug errors or to find answers to {{UBIK}}-specific questions.
 +
In the To-Do List, one can always see what is being planned and done. The artefacts view lists all currently relevant objects, ready for drag & drop to other {{UBIK}} Studio controls.
 +
[[File:intelligent-atelier-control.png|thumb|right|350px|Intelligent Atelier as a tab control]]
  
 
== Prerequisites ==
 
== Prerequisites ==
−
 
+
The Intelligent Atelier is a {{UBIK}} Plugin for {{UBIK}} Studio{{Version/ServerSince|5.2.0}}.  
−
The Intelligent Atelier Plugin is available starting with '''UBIK 5.2.0''' version and can only be used in {{UBIK}} Studio.{{Version/ServerSince|5.2.0}}. Before using the plugin, it must be installed via the "Add Plugins" #thing#, where the plugin is copied automatically or by manually copying the plugin in the Injection folder (''\AppData\Local\Augmensys\UBIK\CUSTOM\{DataBase Name}\INJECTION ''), where its automatically discovered during the startup.
+
=== Installation ===
−
 
+
Install the plugin with the name "UBIK.Module.IntelligentAtelier" using [[Injection_Management|UBIK Plugin Injection]].
−
To use the AI service, the plugin requires a valid configuration of the:
+
=== Configuration ===
−
* AI Model
+
For the feature to work, an AI model is required. Access to this service must be provided by the administrator.
−
* URL and
+
In {{UBIK}} Studio's database connection settings, configure values for the following keys:
−
* API key with acces to the selected model
+
* <b>AI REST API URL</b>: Azure AI Foundry deployment URL
−
 
+
* <b>AI REST API Key</b>: Azure AI Foundry deployment Key
−
The plugin currently supports the REST API with the models from '''GPT-4.1''' to '''GPT-5.4'''.
+
* <b>AI REST API Model</b>: The name of the deployed model
−
 
+
When this article was created, the supported models are GPT-4.1 and GPT-5.4, presumably including any version in between.
−
After the installation the Intelligent Atelier can be opened through:
+
Further, only the Azure OpenAI chat completion REST API is supported.
−
* UBIK Studio -> Views -> Intelligent Atelier, or
+
[[File:ai-api-settings.png|thumb|right|350px|UBIK Studio connection settings for the AI REST API]]
−
* Tab header "Magic Stick Icon"
+
=== Accessibility ===
−
 
+
The Intelligent Atelier can be opened either as a Window or as a Tab Control. Use the "Magic Wand" toolbar menu icon or the "Intelligent Atelier" View-menu entry to open it in a window, or right-click the tab header in the main working area to open the Intelligent Atelier as a tab control, using the respective context menu entry.
−
### Screenshots from
+
[[File:intelligent-atelier-icon.png|thumb|right|350px|Opening the Intelligent Atelier as a window via toolbar button]]
−
* How it looks when opened
+
[[File:intelligent-atelier-tab.png|thumb|right|350px|Opening the Intelligent Atelier as a tab control via tab header context menu]]
−
* Where it can be opened
+
  
 
== Usage ==
 
== Usage ==
 +
[[File:intelligent-atelier-control-areas.png|thumb|right|350px|Intelligent Atelier control areas]]
 +
[[File:intelligent-atelier-example.png|thumb|right|350px|The Intelligent Atelier processing an example...]]
 +
[[File:intelligent-atelier-example-result.png|thumb|right|350px|...and showing the result.]]
 +
=== Paradigm ===
 +
The general usage workflow is to enter and send a request, upon which the Intelligent Atelier creates a plan and works it off, providing the results.
 +
Complex requests usually require a dialog to refine the results iteratively.
 +
=== Use-cases ===
 +
The Intelligent Atelier supports the following use-cases:
 +
* <b>Support</b>: Answer a {{UBIK}}-related question
 +
* <b>Concept</b>: Provide a functional or technical customizing concept
 +
* <b>Debugging</b>: Find a configuration error
 +
* <b>Bugfixing</b>: Fix a misconfiguration
 +
* <b>Prototyping</b>: Implement requirements
 +
=== Request ===
 +
In the "Request" field (1.), the user can enter any prompt corresponding to a use-case listed above, and start processing using the Play-button.
 +
=== Response ===
 +
Once the Intelligent Atelier has come to a conclusion, it will output an answer in the "Response" field (2.).
 +
This can take a while, because there is a lot of expert knowledge to process for the Atelier.
 +
Further, similarly to an interaction with a coworker, complex requests usually require a dialog, with the user reviewing the (intermediate) results and providing follow-up instructions.
 +
=== To-Do List ===
 +
For most non-trivial use-cases, the Intelligent Atelier establishes a plan in the form of a To-Do List (3.). Hover the items to inspect its notes in a tool-tip!
 +
=== Artefacts ===
 +
All relevant objects accessed, created or edited by the Intelligent Atelier are listed in the Artefacts area (4.). These items can be dragged and dropped to most other {{UBIK}} Studio controls, including tab controls like the Bulk Editor, Relation Editor or Object Explorer.
 +
=== Tips and tricks ===
 +
* Create a backup of the database before starting an Atelier session.
 +
* To restart a session completely, close the Intelligent Atelier control or window and open a new one.
 +
* The quality of the results depends, amongst other factors, on the quality of the request. The clearer and more precise a prompt is, the easier it is to process.
 +
* Ambiguity or even contradiction are some of the most difficult obstacles for the Intelligent Atelier; the results are rarely satisfactory for requests with these properties.
 +
* Sometimes, the modelling gets off on the wrong foot. When things just don't work out, often it's best to restart with a new session.
 +
* Sessions are not persisted and cease to exist when closing the Atelier view. The configured REST API may or may not persist details about the interaction, this depends on the configured service.
  
−
# UI Elements
+
== Supported scope ==
−
Request
+
When this article was created, the Intelligent Atelier had an understanding of the following concepts:
−
*
+
* Basic ER-models with MetaClasses, MetaProperties, References, Relations
−
Response
+
* Basic View Items (Relation, Reference, including the reverse cases)
−
*
+
* MetaClass Scopes
−
To-Do List
+
* Basic View configuration including explicit root objects
−
*
+
* Not yet supported: Queries, Proxies, Plugin content like MRO, etc.
−
Artefacts
+
−
*
+
−
 
+
−
 
+
−
# Workflow
+
−
Open the Intelligent Atelier
+
−
Describe the moddeling task you want or ask a question.
+
−
Start the agent execution (You are able to pause or stop the execution)
+
−
Response box shows you the results or the comment from the AI
+
−
ToDo list shows its progress
+
−
Artefacts shown when the progress is done or something created
+
−
 
+
 
== Technical background ==
 
== Technical background ==
−
 
+
The Intelligent Atelier uses an agentic loop with a mixture-of-experts architecture on application level. An Azure OpenAI chat completions REST API is accessed in combination with a rich set of functions for tool-calls and elaborate system instructions to enable both a deep understanding of {{UBIK}} and an algorithm for processing complex requirements. 
 
== See also ==
 
== See also ==
 
*[[Injection_Management|UBIK Plugin Injection]]
 
*[[Injection_Management|UBIK Plugin Injection]]
  
 +
[[Category:AI|Intelligent Atelier (Plugin)]]
 
[[Category:Injecting|Intelligent Atelier (Plugin)]]
 
[[Category:Injecting|Intelligent Atelier (Plugin)]]
 
[[Category:Plugin|Intelligent Atelier (Plugin)]]
 
[[Category:Plugin|Intelligent Atelier (Plugin)]]
 
[[Category:Studio|Intelligent Atelier (Plugin)]]
 
[[Category:Studio|Intelligent Atelier (Plugin)]]
 
[[Category:Version 5.2|Intelligent Atelier (Plugin)]]
 
[[Category:Version 5.2|Intelligent Atelier (Plugin)]]

Latest revision as of 11:49, 28 July 2026

The UBIK® Intelligent Atelier Plugin provides a user interface for interactive agentic AI modelling in UBIK® Studio.

Overview

The Intelligent Atelier can be used to develop part of a UBIK® customizing, debug errors or to find answers to UBIK®-specific questions. In the To-Do List, one can always see what is being planned and done. The artefacts view lists all currently relevant objects, ready for drag & drop to other UBIK® Studio controls.

Intelligent Atelier as a tab control

Prerequisites

The Intelligent Atelier is a UBIK® Plugin for UBIK® Studio.

Installation

Install the plugin with the name "UBIK.Module.IntelligentAtelier" using UBIK Plugin Injection.

Configuration

For the feature to work, an AI model is required. Access to this service must be provided by the administrator. In UBIK® Studio's database connection settings, configure values for the following keys:

  • AI REST API URL: Azure AI Foundry deployment URL
  • AI REST API Key: Azure AI Foundry deployment Key
  • AI REST API Model: The name of the deployed model

When this article was created, the supported models are GPT-4.1 and GPT-5.4, presumably including any version in between. Further, only the Azure OpenAI chat completion REST API is supported.

UBIK Studio connection settings for the AI REST API

Accessibility

The Intelligent Atelier can be opened either as a Window or as a Tab Control. Use the "Magic Wand" toolbar menu icon or the "Intelligent Atelier" View-menu entry to open it in a window, or right-click the tab header in the main working area to open the Intelligent Atelier as a tab control, using the respective context menu entry.

Opening the Intelligent Atelier as a window via toolbar button
Opening the Intelligent Atelier as a tab control via tab header context menu

Usage

Intelligent Atelier control areas
The Intelligent Atelier processing an example...
...and showing the result.

Paradigm

The general usage workflow is to enter and send a request, upon which the Intelligent Atelier creates a plan and works it off, providing the results. Complex requests usually require a dialog to refine the results iteratively.

Use-cases

The Intelligent Atelier supports the following use-cases:

  • Support: Answer a UBIK®-related question
  • Concept: Provide a functional or technical customizing concept
  • Debugging: Find a configuration error
  • Bugfixing: Fix a misconfiguration
  • Prototyping: Implement requirements

Request

In the "Request" field (1.), the user can enter any prompt corresponding to a use-case listed above, and start processing using the Play-button.

Response

Once the Intelligent Atelier has come to a conclusion, it will output an answer in the "Response" field (2.). This can take a while, because there is a lot of expert knowledge to process for the Atelier. Further, similarly to an interaction with a coworker, complex requests usually require a dialog, with the user reviewing the (intermediate) results and providing follow-up instructions.

To-Do List

For most non-trivial use-cases, the Intelligent Atelier establishes a plan in the form of a To-Do List (3.). Hover the items to inspect its notes in a tool-tip!

Artefacts

All relevant objects accessed, created or edited by the Intelligent Atelier are listed in the Artefacts area (4.). These items can be dragged and dropped to most other UBIK® Studio controls, including tab controls like the Bulk Editor, Relation Editor or Object Explorer.

Tips and tricks

  • Create a backup of the database before starting an Atelier session.
  • To restart a session completely, close the Intelligent Atelier control or window and open a new one.
  • The quality of the results depends, amongst other factors, on the quality of the request. The clearer and more precise a prompt is, the easier it is to process.
  • Ambiguity or even contradiction are some of the most difficult obstacles for the Intelligent Atelier; the results are rarely satisfactory for requests with these properties.
  • Sometimes, the modelling gets off on the wrong foot. When things just don't work out, often it's best to restart with a new session.
  • Sessions are not persisted and cease to exist when closing the Atelier view. The configured REST API may or may not persist details about the interaction, this depends on the configured service.

Supported scope

When this article was created, the Intelligent Atelier had an understanding of the following concepts:

  • Basic ER-models with MetaClasses, MetaProperties, References, Relations
  • Basic View Items (Relation, Reference, including the reverse cases)
  • MetaClass Scopes
  • Basic View configuration including explicit root objects
  • Not yet supported: Queries, Proxies, Plugin content like MRO, etc.

Technical background

The Intelligent Atelier uses an agentic loop with a mixture-of-experts architecture on application level. An Azure OpenAI chat completions REST API is accessed in combination with a rich set of functions for tool-calls and elaborate system instructions to enable both a deep understanding of UBIK® and an algorithm for processing complex requirements.

See also

Retrieved from "https://wiki.augmensys.com/index.php?title=Intelligent_Atelier_(Plugin)&oldid=30357"