- Descriptions — visible to both end users and the AI agent.
- AI context via
meta— only visible to the AI agent, not exposed in the user interface.
Using descriptions
Thedescription parameter on cubes, views, measures,
dimensions, and segments provides human-readable context that is displayed in
the UI and also consumed by the AI agent.
Use descriptions to clarify the meaning of a member for both your team and
end users:
Using AI context
If you want to provide context to the AI agent without exposing it in the user interface, use theai_context key inside the
meta parameter. The meta parameter accepts custom
metadata on views, measures, and dimensions.
ai_context must be defined on views or on individual members
(measures, dimensions). ai_context defined at the cube level is not
consumed by the AI agent.ai_context on views to provide high-level guidance,
and on individual members for member-specific instructions:
ai_context directly on the measure or
dimension:
ai_context when including members in
a view — for example, to define synonyms or acronyms that only apply in the
context of that view:
Descriptions vs. AI context
Use
description when the context is useful to both end users and the AI
agent. Use ai_context when you want to provide additional instructions or
context that is only relevant to the AI agent — for example, guidance on
which measures to prefer, nuances about data quality, or business logic that
would be confusing in a user-facing description.
You can use both together. The AI agent reads both the description and
ai_context when generating queries:
Best practices
- Add descriptions to all public members. Descriptions help both end users and the AI agent understand your data model.
- Use AI context for agent-specific guidance. If you need to tell the AI
agent which measure to prefer or how to interpret ambiguous terms, use
ai_context. - Define context on views or individual members.
ai_contextdefined at the cube level is not consumed by the AI agent. Place it on the view itself or on individual measures and dimensions. - Be specific. Vague context like “important metric” is less helpful than “use this measure when users ask about monthly recurring revenue.”
- Document relationships. Use AI context to explain how cubes relate to each other and which views to prefer for common questions.
- Keep it up to date. As your data model evolves, update descriptions and AI context to reflect the current state.