Atlan AI helps you automate the process of documenting your data assets. You can use Atlan AI to generate meaningful context for your assets and then simply review the content for accuracy and relevance. Accept, reject, or edit any AI-powered suggestions, the choice is yours!
You can use Atlan AI to:
- Document tables and views with AI-generated descriptions
- Document columns with AI-generated descriptions
Add a description to a table or view
You can use Atlan AI to add descriptions to your assets in Atlan and provide helpful context to your teams. Supported asset types include:
- SQL tables and views
- Salesforce objects
To add a description to a table or view using Atlan AI:
- From the left menu on any screen, click Assets.
- (Optional) Under the search bar on the Assets page, click the Table tab.
- (Optional) In the Filters menu on the left, click Properties to expand the menu and select Description to search for assets without a description.
- Click an asset to view the Overview tab in the sidebar.
- Under Description, navigate to the text box and click use Atlan AI to add an Atlan AI-suggested description to the table asset.
- Once Atlan AI has generated a description, you can:
- Click anywhere in the text box to edit the text and then click Apply.
- Click Apply to add the description to your asset.
- Click Discard to discard the AI-generated description.
- Click the retry button to generate a new description, compare the two to select the most relevant option, and then click Apply.
- (Optional) From the sidebar tabs on the right, click the Activity tab to view the changelog — including the Updated using Atlan AI stamp, user information, and timestamp for the update.
Your AI-suggested table or view description is now live! 🎉
Add a description to a column
You can use Atlan AI to add descriptions to your columns from the following:
- Overview tab in the sidebar for column assets
- Column preview section in the asset profile for table and view assets
- Columns tab in the sidebar for table and view assets
Supported asset types include:
- SQL columns
- Salesforce fields
In this example, we'll use Atlan AI to add a description to a column from the Column preview section in a table asset profile.
To add a description to a column using Atlan AI:
- From the left menu on any screen, click Assets.
- (Optional) Under the search bar on the Assets page, click the Table tab.
- Right-click an asset and then select Open profile to view its asset profile.
- From the asset profile, navigate to the Column Preview section and select a column to document.
- Under Description, click use Atlan AI to add an AI-generated description to the column.
- Once Atlan AI has generated a description, you can:
- Click anywhere in the text box to edit the text and then click Apply.
- Click Apply to add the description to your asset.
- Click Discard to discard the AI-generated description.
- Click the retry button to generate a new description, compare the two to select the most relevant option, and then click Apply.
- (Optional) From the sidebar tabs on the right, click the Activity tab to view the changelog — including the Updated using Atlan AI stamp, user information, and timestamp for the update.
Your AI-suggested column descriptions are now live! 🎉
