|
| 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 | +[](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. |
0 commit comments