Autodocumenting terms and KPIs with AI

Applies to: Dataedo 24.x (current) versions, Article available also for: 23.x

To generate descriptions for a term or KPI:

  1. Press the small arrow in the AI button.
  2. Select the engine.
  3. Click the AI button and wait for generating descriptions (it may take several seconds).

Selecting Generate button

Editing and saving the AI-generated descriptions in Dataedo Portal

To edit the generated description, use the pencil icon.

You can use the buttons from the bottom row:

  • [Save to AI description] - saves the result to a special AI description field
  • [Save to description] - saves the result to a regular description field
  • [Discard] - discards the generated text

Saving description.

Note: the AI-generated description is visible both in Dataedo Portal (in dedicated field) and in Dataedo Desktop (in dedicated tab). Of course, you can save the AI description to the regular Description field (using the button [Save to description]).

AI-generated term description

If you saved the text using [Save to AI description] button, the new section AI GENERATED DESCRIPTION appears on the term overview:

AI-generated description

You can:

  • leave the text in this section
  • copy the text to the Description section
  • delete the AI-generated description. To delete the AI description:
  1. Press the three-dot icon in the bottom right corner of the section
  2. Select Delete

Deleting AI-generated description

Generating AI descriptions from Dataedo Desktop

To generate AI descriptions you need Dataedo Portal with configured AI Autodocumentation function (see the instructions Configuring AI Autodocumentation). You can also run the generation in Dataedo Portal from within Dataedo Desktop (to configure link between Dataedo Portal and Dataedo Desktop, see the instructions Configure Open in Dataedo Portal).

To generate AI descriptions from Dataedo Desktop:

  1. Right click the AI description field in the grid (only for terms and KPIs)
  2. Select the option Generate AI description in Dataedo Portal

Generate AI description from grid

Or if there is no description for the term or KPI:

  1. Open the tab AI description on the object overview
  2. Click the link Generate AI description in Dataedo Portal

Note: This link will be visible only if no AI description is generated for the selected object. If the AI description has been already generated, you can right-click it and select Generate AI description in Dataedo Portal option from the context menu.

Generate AI description from tab

After selecting the Generate AI description in Dataedo Portal option/link, the AI generated descriptions window will open in Dataedo Portal. To proceed, see the section Editing and saving the AI-generated descriptions above.

Permissions

To generate descriptions using an AI engine you need Admin or Data Steward rights.

Tips

If the generated text seems to be not connected with the context of the term or KPI try to link it to some other terms related to the main topic. For example, if you have a "Rental" term, and the GPT model generates text related to a car rental company, link the term to the "Movie" term to obtain AI-generated descriptions related to the movie rental.

Learn more

Check this Video Tutorial on AI Autodocumentation in Dataedo Portal.