> ## Documentation Index
> Fetch the complete documentation index at: https://docs.validio.io/llms.txt
> Use this file to discover all available pages before exploring further.

# AI Description Generation

> Use AI to generate contextual descriptions for catalog assets, schema fields, glossary terms, domains, validators, and lineage edges.

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](https://docs.validio.io/v11.0/docs/ai-features.md#enabling-ai-features).
* An [LLM credential](https://docs.validio.io/v11.0/docs/integrations/llm-credentials.md) 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](https://docs.validio.io/v11.0/docs/access-and-settings/settings/managing-roles.md).

## Generate a description

![The description area of a source overview with the AI generate sparkle button](https://mintcdn.com/validio/30m58lWK6Ph-vklQ/images/docs/ai-features/820-ai-generate-description.png?fit=max\&auto=format\&n=30m58lWK6Ph-vklQ\&q=85\&s=6489f4eac0e5e10f89f7b000b5f8fa15)

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](#supported-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

| Entity Type | Context Used by AI |
| :- | :- |
| Catalog Asset | Schema fields, data types, glossary terms, tags, external descriptions |
| Schema Field | Field name, data type, parent asset context, neighboring fields, descriptions |
| Glossary Term | Term name, aliases, domain, assigned assets and fields |
| Domain | Domain name, associated glossary terms, linked assets |
| Validator | Validator type, configuration, source context, monitored fields |
| Lineage Edge | Upstream and downstream assets, field mappings, schema context |

## 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](https://mintcdn.com/validio/30m58lWK6Ph-vklQ/images/docs/ai-features/820-schema-bulk-descriptions.png?fit=max\&auto=format\&n=30m58lWK6Ph-vklQ\&q=85\&s=ced0579c40009570784ac9bbd82e4e02)

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.

## Related resources

* [About Validio AI Features](https://docs.validio.io/v11.0/docs/ai-features.md)
* [LLM Credentials](https://docs.validio.io/v11.0/docs/integrations/llm-credentials.md)
* [Catalog Assets](https://docs.validio.io/v11.0/docs/catalog/catalog-assets.md)
* [Business Glossary](https://docs.validio.io/v11.0/docs/catalog/business-glossary.md)
* [Lineage Edge Suggestions](https://docs.validio.io/v11.0/docs/ai-features/lineage-edge-suggestions.md)