Autodocumenting tables and views with AI

You can generate descriptions for tables, views, and their columns from two places:

• Overview tab for the table/view
• Columns tab for this table/view

In both cases, a single operation creates the descriptions both for the table/view and for their columns.

Generating descriptions in Dataedo Portal

Generating from the Overview tab

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)

Generating from the Columns tab

1. Go to the Columns tab of the selected table/view.
2. Press the small arrow in the AI button on top of the columns grid
3. Select the engine
4. Click the AI button and wait for generating descriptions (it may take several seconds)

Editing and saving the AI-generated descriptions in Dataedo Portal

To edit the generated description, use the pencil icon.

Available options:

• Save this description checkbox - picks only selected descriptions to be saved
• [Select all] - selects all generated descriptions for saving
• [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

.

Note: the AI-generated description field 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 descriptions on the Overview page

If you saved the text using [Save to AI description] button, the new section AI GENERATED DESCRIPTION appears on the overview page of the table, view, or column:

You can:

• leave the text in this section
• copy the text to the Description section (in Editing mode)
• 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

AI-generated descriptions on the Columns tab

AI-generated descriptions are denoted with the OpenAI icon:

If the column has both standard and AI-generated descriptions, the OpenAI icon is displayed on the right. You can click the icon to display an AI-generated description below the regular one:

To show/hide all AI-generated texts in this tab, press [Show/Hide AI descriptions]:

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 the 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
2. Select the option Generate AI description in Dataedo Portal

Or if there is no description for the table or view:

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

Note: The 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.

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 table or view, try to link this object to some terms related to the main topic. For example, if you have a "Rental" table in your DVD rental database, and the GPT model generates text related to a car rental company, link the "Movie" term to the table to obtain AI-generated descriptions related to the movie rental.

Learn more

Check this Video Tutorial on AI Autodocumentation in Dataedo Portal.