Customize entity descriptions for the semantic layer
Create custom entity descriptions in the Semantic Table Configuration table so that customizations can be transferred between instances via update sets.
Before you begin
Role required: sn_query_gen.admin or higher
About this task
The Query Generation semantic layer uses natural-language descriptions to help AI understand what each table represents. By default, descriptions are auto-derived from the Field Label [sys_documentation] table, but you can override these descriptions with custom descriptions that better explain the business purpose of your tables. When you clear a custom description, the system falls back to the Field Label value.
This procedure uses the Semantic Table Configuration table. Customizations made this way can be transferred between instances via update sets and override descriptions set directly in the Entity table. For simpler, single-instance testing, you can edit the Semantic Description field directly in the Entity [sn_query_gen_entity] table instead.
Procedure
Result
The custom entity description is active and will be used by Query Generation when processing queries for this table. Because this customization is stored in the Semantic Table Configuration table, it can be included in an update set and transferred to other instances. For more information, see System update sets.
Entity descriptions
This example shows the difference between auto-generated and custom descriptions:
| Table | Auto-generated (poor) | Custom (good) |
|---|---|---|
|
incident |
Incident table |
IT incidents, outages, service disruptions, and IT support tickets |
alm_ai_digital_asset |
Tracks records for AI digital assets. | Base inventory table for all AI-related digital assets within the AI Control Tower (AICT) governance framework. Each record represents an AI artifact — model, prompt, dataset, skill, agent, or tool — tracked for governance, compliance, and lifecycle management. Governance teams, product managers, and AI platform owners use this table for centralized AI inventory oversight, audit readiness, and traceability. |
What to do next
Test your custom description by asking questions about the table in Query Generation and verifying that the correct table is selected.