Skip to main content
Validio can use AI to generate rich, contextual descriptions for entities across the platform. The AI analyzes available metadata — schema information, glossary terms, tags, lineage context, and existing descriptions — to produce descriptions tailored to each entity type. Generated descriptions use markdown formatting, so you can review and refine them in the built-in markdown editor before saving.

​
Prerequisites

  • AI features must be enabled in your workspace. See Enabling AI features.
  • An LLM credential must be configured.
  • Write permission for the entity type you want to generate a description for (e.g., catalogAssets:WRITE for catalog assets, glossary:WRITE for glossary terms). For more information, see Managing Roles.

​
Generate a description

The description area of a source overview with the AI generate sparkle button

Generate description in a source overview

AI description generation is available wherever you can edit a description — in sidebars and on detail pages.
  1. Navigate to the entity you want to describe (catalog asset, source, glossary term, domain, validator, or lineage edge).
  2. Click the AI generate button (sparkle icon) in the description area.
  3. Select an LLM credential from the dropdown. The dropdown shows each credential’s name and model.
  4. The AI generates a description and populates the editor with the result.
  5. Review and edit the generated text as needed. The description uses markdown formatting.
  6. Click Save to keep the description, or Cancel to discard it.
The generation uses the entity’s available context to produce relevant descriptions. For example, a catalog asset description draws on its schema fields, glossary terms, tags, and any existing external descriptions.

​
Where generation is available

​
Bulk schema field descriptions

You can generate descriptions for multiple schema fields at once, which is useful for documenting a large table quickly.
The bulk description review dialog listing generated descriptions for selected schema fields

Generated descriptions for schema fields

  1. Navigate to a catalog asset or source details page and open the Schema tab.
  2. Select the schema fields you want to describe using the checkboxes.
  3. Click Generate descriptions in the selection actions bar.
  4. Select an LLM credential from the dropdown.
  5. The AI generates a description for each selected field. A review dialog opens showing all generated descriptions.
  6. Use the checkboxes to select which descriptions to keep. Each item shows the field name, data type, and a preview of the generated description.
  7. Click Apply to save the selected descriptions.
The bulk generation ensures each field gets a distinct description that differentiates it from related fields in the same table. For example, created_at and updated_at get descriptions that clarify their different roles.

​
Supported markdown formatting

AI-generated descriptions may include the following markdown formatting:
  • Headings (#, ##, ###)
  • Bold and italic text
  • Strikethrough
  • Bullet and numbered lists
  • Inline code and fenced code blocks with syntax highlighting
  • Blockquotes
Tables are not included in generated descriptions. You can further edit the generated markdown using the built-in editor, which provides a formatting toolbar for common operations.