Skip to main content

Ask AI for Embedded Analytics

Introduction​

Ask AI brings conversational analytics to your embedded application. Your embed users can ask questions in natural language to explore data, get insights, and dig deeper into charts.

Embed User Experience​

Once you enable Ask AI, your embed users can interact with data using natural language.

Asking Questions​

Users can use Ask AI to build charts and explore data directly from dashboard widgets or dataset exploration. They can ask questions like:

  • "What were the top 5 products by revenue last month?"
  • "Show me the trend of daily active users"
  • "Why did sales drop in Q3?"

Asking questions in Ask AI

Getting Insights from Charts​

Users can hover over any chart and click "Ask AI" to get instant insights, explain data, or dig deeper into the data.

Getting insights from charts

How to Set Up Ask AI in Embed Portal​

To use embeddable Ask AI , make sure you enabled:

  • AI: Powers the natural language query capabilities.
  • Embed Portal: The embedding framework to integrate Ask AI into your application.

Enable Ask AI in Embed Portal​

To enable AI features for your embed users, set settings.ai parameters to true in your embed payload:

const embed_payload = {
  object_type: 'EmbedPortal',
  object_name: 'your_portal_name',
  embed_user_id: 'user_123',
  embed_org_id: 'org_123',
  settings: {
    ai: true,  // Enable Ask AI feature
  }
}

Configure Data Access & Permissions​

Ask AI can only query and return data the current embed user is permitted to see. It automatically enforces your Embed Portal's data permissions.

Dataset Access​

Ask AI can query only datasets included in your Embed Portal. If a dataset isn't added to the portal, Ask AI won't be able to use it.

sales_portal.embed.aml
EmbedPortal sales_portal {
  objects: [
    sales_dashboard,
    ecom_dataset,       // Ask AI can query this dataset
    marketing_dataset,  // Ask AI can query this dataset
  ]
}
warning

Include at least one dataset in your Embed Portal, otherwise Ask AI won't be able to answer questions.

Row-Level Permissions (RLP)​

Ask AI runs every query as the current embed user, so Row-level Permissions are applied automatically. Users only see rows they're permitted to access.

Set Ask AI as the Default Page (Optional)​

You can configure the embed portal to open directly to the Ask AI interface. There are two ways to do this:

Option 1: Using embed definition​

Set the initial_object setting in your .embed.aml file:

sales_portal.embed.aml
EmbedPortal sales_portal {
  objects: [
    sales_overview,
    revenue_trends,
  ],
  initial_object: 'ai'   // Open Ask AI as the default page
}

Option 2: Using URL path​

Append /ai to your embed URL:

https://secure.holistics.io/embed/<embed_key_id>/ai?_token=<generated_token>

This option can override the initial object defined in your embed definition, allowing you to dynamically control which page users land on.

Learn More​

For more information about the underlying AI capabilities, see:

Let us know what you think about this document :)