Skip to main content
The Workbook Agent enables conversational analytics that take the need for technical know-how out of data analysis.

Workbook Agent

This feature requires enabling the Workbook Agent setting in AI settings.
The Workbook Agent can help you create and refine workbook queries using natural language. You can ask questions like: What was the total revenue for the last three months? How many new users signed up last month? How many support tickets are submitted on weekends? The Workbook Agent will either provide a text response or generate a query in the workbook.

Generating queries

How you access the Workbook Agent differs depending on whether you’re using an embedded Omni instance or not:
  • Embedded - Click the icon in the left navigation
  • Non-embedded Omni - Click the floating avatar to open the chat panel
A panel will open next to the field browser with some tips about how to use the agent, as well as a text box to ask your first question. In addition to generating queries, the Workbook Agent can also:
  • Iterate on the questions you ask to provide a more refined result. For example:
    Note: Closing the Workbook Agent will delete the text history.
  • Add totals to results, such as adding a column total that sums a Sale Price measure
  • Create new measure fields, such as a Sale Price Average
  • Attach images by pasting from your clipboard to provide visual context (for example, pasting a screenshot of a chart you want to analyze) To attach an image, copy it to your clipboard and paste it directly into the Workbook Agent text input. The image appears as a file chip, ready to be sent with your message.
    The Workbook Agent > File uploads AI setting must be enabled to use this feature.
Along with the Workbook Agent in the workbook, you can also use the Generate an AI query API to interact with it. You can then use the response to run the query with the Run a query API.If your model has query_all_views_and_fields enabled and you want to query views outside of topics via the API, set the queryAllViews parameter to true.

Creating filters

Make filtering easier by having the agent create filters for you using natural language. You can describe a filter like Only include orders created on a Saturday or Exclude customers with a status of deactivated and the agent will automatically apply the filter to the query.

Summarizing query results

This feature requires enabling the Workbook Agent setting in AI settings.
In addition to helping you build queries, the agent can also summarize the results of the query for you. For example, you can ask the agent to:
  • Describe any anomalies in the data
  • Identify insights into trends
  • Detail the next steps you should take
To get started, enter a prompt directly in the Workbook Agent. To make a summary part of a dashboard, use the AI summary visualization.

Generating forecasts

The agent can generate statistical forecasts for time-series data. Refer to Generating forecasts with AI to learn more.

Generating visualizations

The agent can also generate visualizations based on your query results. Refer to Generating visualizations with AI to learn more.

Getting help

If you’re stuck and can’t remember how to do something in Omni, ask the Omni Agent. Questions like “How do I do [thing]?” will prompt the agent to search the official Omni docs and provide you with an answer, all without leaving your Omni workflow. You can also directly tell the agent to search the docs when researching the answer to your question.
Working in an embedded context? If you have the Hide Omni watermark setting enabled to provide a fully white-labeled experience, the AI doc search feature will respect it. Omni doc links will not be returned in chat, even if explicitly requested.

Improving AI results

Queries and filter prompts submitted to Workbook Agent may require some tweaking to get the best result. Refer to the Optimizing your models for AI guide to learn how to curate your models and include context to achieve this.