Skip to content

Commit d716dcc

Browse files
authored
add AI assistance documentation (#872)
1 parent 0753eb2 commit d716dcc

4 files changed

Lines changed: 44 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ Explore how to use MetaConfigurator with real-world examples:
9999

100100
* **[Code Generation](./documentation_user/examples/code_generation)** – Learn how to generate code in multiple programming languages from JSON schemas.
101101

102+
* **[AI Assistance](./documentation_user/examples/ai_assistance)** – Learn how to use AI-assisted features for schema and data creation/editing, as well as data transformation.
103+
102104

103105

104106
📚 Read the full [User Documentation](./documentation_user).

documentation_user/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* [Configurator Building](examples/configurator_building) (Shows how to use MetaConfigurator as a Configurator Builder, allowing users to create and share URLs that open MetaConfigurator with preloaded schema, data, and settings)
77
* [Code Generation](examples/code_generation) (Shows how to generate code in multiple programming languages from JSON schemas)
88
* [Schema Selection List](examples/schema_selection_list) (Provide your users a pre-defined list of schemas to choose from; useful for organizations)
9+
* [AI Assistance](examples/ai_assistance) (Shows how to use AI-assisted features for schema and data creation/editing, as well as data transformation)
910

1011
## Load a Schema
1112

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# AI Assistance
2+
3+
## Overview
4+
5+
MetaConfigurator provides different AI-assisted features to help you create and edit JSON schemas and instance data using natural language inputs.
6+
7+
Demonstration and Introduction video from the Allotrope Connect Workshop 2025 (click the image to open the video on Youtube):
8+
9+
[![AI Assistance Introduction Video](http://i3.ytimg.com/vi/DfS6PgMr1q0/hqdefault.jpg)](https://www.youtube.com/watch?v=DfS6PgMr1q0)
10+
11+
12+
## Requirements
13+
14+
To use the AI-assisted features, you need to have an OpenAI API key (or API key of another LLM endpoint provider).
15+
You can obtain an API key by signing up on the [OpenAI website](https://platform.openai.com/signup/).
16+
17+
## Endpoint Configuration
18+
19+
To configure the LLM endpoint, open an AI-assisted feature (e.g., `Show AI Prompts View` button in the top menu bar) and expand the expandable/collapsible dialog.
20+
Here, you can enter your API key and select the desired LLM endpoint (e.g., OpenAI GPT-4, Perplexity, or a custom endpoint) and other parameters.
21+
22+
<img alt="AI Endpoint Configuration" src="ai_settings.png" width="400"/>
23+
24+
## How to Use AI Assistance
25+
26+
### Schema Creation and Editing
27+
28+
Open the AI Prompts View by clicking the `Show AI Prompts View` button in the top menu bar.
29+
Now you can enter prompts to create or edit schemas using natural language.
30+
31+
### Schema Mapping and Data Transformation
32+
33+
In the `Data` tab, click `Utility...` -> `Transform Data to match the Schema...`.
34+
This will open a dialog to generate a mapping configuration to map the current data to the target schema using AI.
35+
The generated mapping configuration can be reviewed and adjusted before applying it to transform the data.
36+
37+
### Data Transformation to other Formats
38+
39+
In the `Data` tab, click `Utility...` -> `Export Data via Text Template...`.
40+
This will open a dialog to generate a text template using AI to transform the current data to another format (e.g., XML, CSV, custom format).
41+
The generated text template can be reviewed and adjusted before applying it to transform the data.
103 KB
Loading

0 commit comments

Comments
 (0)