> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.
# Omni Agent (standalone chat)
> Explore your data using conversational AI in a standalone chat experience.
export const CheckIcon = ({label}) => {
return
{label && ` ${label}`}
;
};
export const XCircleIcon = ({label}) => {
return
{label && ` ${label}`}
;
};
export const DashboardIcon = ({label}) => {
return
{label && ` ${label}`}
;
};
export const WorkbookIcon = ({label}) => {
return
{label && ` ${label}`}
;
};
export const WorkbookNumberFormatIcon = ({label}) => {
return ;
};
export const DashboardCatalogIcon = ({label}) => {
return
{label && ` ${label}`}
;
};
export const DashboardAddItemIcon = ({label}) => {
return
{label && ` ${label}`}
;
};
export const DashboardControlIcon = ({label}) => {
return
{label && ` ${label}`}
;
};
export const DashboardChartIcon = ({label}) => {
return
{label && ` ${label}`}
;
};
export const DashboardLayoutIcon = ({label}) => {
return
{label && ` ${label}`}
;
};
export const DashboardTextIcon = ({label}) => {
return
{label && ` ${label}`}
;
};
export const DashboardStackContainerIcon = ({label}) => {
return
{label && ` ${label}`}
;
};
export const DashboardPageNavIcon = ({label}) => {
return
{label && ` ${label}`}
;
};
export const IdeFileIcon = ({color = "#000000"}) => {
return ;
};
The Omni Agent provides a standalone, conversational interface for exploring your data. Ask questions, generate queries, and visualize results without needing to work directly in a workbook.
## Requirements
To use the Omni Agent, you'll need **Restricted Querier**, **Querier**, **Modeler**, or **Connection Admin** permissions.
## Accessing the Omni Agent
To access the Omni Agent, click **Omni Agent** in Omni's main navigation. The chat interface opens in a dedicated page where you can begin asking questions about your data.
The **Use Omni Agent** needs to be enabled in [**Settings > AI**](/ai/settings/features#chat). Organization Admins can enable or disable this feature.
## Capabilities
The Omni Agent can:
* **Allow you to ask questions about your data** using natural language
* **Generate queries** based on your prompts, routed through [topics](/modeling/topics) or any view in your model
* **Create visualizations**, including [KPI tiles](/visualize-present/visualizations/types/kpi), directly from your prompts
* **Create dashboards** based on the queries and visualizations in the session
* **Summarize and analyze results** to identify trends, anomalies, and insights
* **Attach images** by pasting from your clipboard to provide visual context for your questions
* **Upload files** including text and Markdown files to provide additional context alongside your queries
Refer to [Scoping responses](#scoping-responses) for details on how to control which data the AI can access.
## Uploading files
The **Workbook Agent > File uploads** [AI setting](/ai/settings/features#file-uploads) must be enabled to use this feature.
You can upload text (`.txt`), Markdown (`.md`), and [images](#attaching-images) to the Omni Agent to provide additional context for your questions. This is useful when you need to reference additional information alongside your data queries.
To upload a file:
1. Click the attachment icon in the chat input
2. Select a file from your computer
3. The file appears as a file chip in the chat input, indicating it's ready to be sent with your message
The Omni Agent can then read and reference the contents of the uploaded files when generating responses, allowing you to ask questions that combine your data with external context or documentation.
### Attaching images
You can paste images directly from your clipboard into the chat to provide visual context alongside your questions. This works with screenshots, images copied from web pages, or any image data on your clipboard.
To attach an image:
1. Copy an image to your clipboard (for example, take a screenshot or copy an image from a web page)
2. Click into the chat input
3. Paste the image using your system's paste command (`Cmd+V` on Mac, `Ctrl+V` on Windows/Linux)
The image appears as a file chip in the chat input, indicating it's ready to be sent with your message. You can attach multiple images to a single message by pasting them one after another.
Image pasting is supported in Chrome and Safari. Firefox does not currently support pasting images into textarea elements due to browser limitations.
## Viewing query field details
When the Omni Agent generates a query, you can view details about the fields used in the results. This helps you understand what data the AI selected and how each field is defined.
To view field details, click the icon near the top-right corner of the query results, next to the icon. A panel displays information for each field in the query, including:
* **Field name** - The field's label and identifier in the model
* **Definition** - The SQL or calculation that defines the field
* **Description** - Additional context about the field, if defined in the model
This feature provides transparency into AI-generated queries, helping you verify the AI selected appropriate fields and understand the underlying data structure. To improve the quality of field definitions displayed here, refer to [Optimizing your models for AI](/modeling/develop/ai-optimization).
## Refreshing query results
When you revisit a previous chat session, query results may be stale. To update the results with the latest data, click the **Re-run all queries** icon located at the bottom left corner of the chat box, next to the Model selector.
Clicking this icon re-runs all queries in the conversation, updating visualizations and results with current data. To optimize performance, only the most recent queries are re-run.
## Navigating prompt history
You can quickly recall previous prompts using keyboard shortcuts, similar to a command-line interface:
* Press the **Up arrow** key to cycle backward through your previous prompts
* Press the **Down arrow** key to cycle forward through your prompt history
When you reach your oldest prompt and press Up arrow again, the navigation wraps to your most recent prompt. Pressing Down arrow after your newest prompt restores any in-progress text you were typing before navigating the history.
Arrow key navigation only works when your cursor is at the beginning of the input field or when the field is empty. This preserves normal cursor movement when editing text.
The prompt history displays only your own prompts from the current chat session.
## Creating dashboards
The Omni Agent supports two ways to create dashboards.
**Ask the agent to build one** Beta — Describe the dashboard you want in the chat and the agent plans the layout, generates queries, and publishes a complete dashboard to your [**My documents**](/content/navigate#personal) folder:
> "Create a dashboard showing sales performance by region with monthly trends and a top customers table"
After the dashboard is created, you can ask the agent to iterate on it in the same session — rearranging tiles, editing charts, or adding new ones.
**Build one from your chat history** — To create a dashboard from charts already in your session:
1. Click the icon in the left navigation.
2. Add a name and select the charts to include.
3. Click **Create**.
You'll be redirected to the new dashboard in your [**My documents**](/content/navigate#personal) folder.
## Renaming chat sessions
The Omni Agent automatically generates a name for each chat session based on your conversation. You can customize these names to make it easier to identify and return to specific conversations.
To rename a chat session, double-click on the active session name in the Omni Agent sidebar. An inline text field appears where you can enter a new name. Press Enter to save the new name, or press Escape to revert to the original name.
Session names persist and display whenever you return to the Omni Agent. You can only rename chat sessions that you own.
## Managing long conversations
As your conversation with the Omni Agent grows, it consumes more of the available context window. When a chat session reaches 75% of the context window, a visual indicator appears on the **New chat** button to help you recognize when starting a fresh conversation would improve performance. Context window size is determined by the [`conversation_prune_length`](/modeling/models/ai-settings#param-conversation-prune-length) parameter.
This feature is automatic and requires no configuration. Starting a new chat when prompted helps maintain optimal AI performance, especially for complex queries and analysis.
## Sharing chat sessions
You can share a chat session by copying the URL from your browser's address bar and sending it to another user.
Query results stored in the chat history are cached from when the creator ran them. The viewer of the shared chat will see those same cached results.
Therefore, Omni requires that the viewer of the shared chat have **Querier**, **Modeler**, or **Connection Admin** permissions, as well as the same [connection environment](/connect-data/dynamic-environments), to view the session. Users with **Restricted Querier** permissions or lower will not be able to access shared chat sessions.
The following rules determine who can see a chat:
1. The **owner** of the chat can always view the chat.
2. Any user with the **Querier role or above on all relevant models** can view the chat. Because Queriers can already write SQL queries directly in Omni, this doesn't expose any data they couldn't otherwise access.
3. **Viewers and Restricted Queriers** are blocked from viewing, preventing access to data they are not authorized to see.
## Scoping responses
The Omni Agent uses pickers to scope responses to specific connections, models, and topics:
Up to three pickers can display in the chat interface:
* **Connections** - Lists the connections you have access to. Only displays if more than one connection is available.
Organization Admins can configure a default connection in [**Settings > AI > Features**](/ai/settings/features#default-connection) to set which connection the Omni Agent opens with by default.
* **Models** - Lists the available models in the selected connection. Only displays if:
* The connection has more than one model, **and**
* At least one topic in the model is accessible. This could mean that the model's [`ai_chat_topics`](/modeling/models/ai-chat-topics) is unset, making all topics accessible, or that it specifies at least one topic:
```yaml theme={null}
ai_chat_topics: [ Products ]
```
* **Topics** - Lists the available topics in the model. Only displays if at least two topics in the model are accessible. This could mean that the model's [`ai_chat_topics`](/modeling/models/ai-chat-topics) is unset, or that it specifies at least two topics:
```yaml theme={null}
ai_chat_topics: [ Products, Orders ]
```
### Topic selection
If a prompt is entered and a topic isn't selected - meaning that **Auto-select a topic** is selected in the topic picker - the AI will attempt to select the most relevant topic.
To scope the AI's response to a specific dataset, use the pickers to select a specific topic. The AI will remain "locked" to the selected topic until the selection is changed.
Additionally, the picker menus won't display when a model only has one AI-accessible topic. If a connection has one model with a single AI-accessible topic - determined by the value of the model's [`ai_chat_topics`](/modeling/models/ai-chat-topics) parameter - the AI will be scoped only to that topic and the pickers will not display.
## Getting help
If you're stuck and can't remember how to do something in Omni, just ask Blobby. Questions like *"How do I do \[thing]?"* will prompt Blobby to search the official Omni docs and provide you with an answer, all without leaving your Omni workflow.
You can also directly tell Blobby 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.
## Selecting an AI model tier
If your Omni organization uses [custom AI models](/ai/settings/model-providers), the model tier selector will be hidden in the chat interface. In this case, the AI will use the custom model configuration from your [AI settings](/ai/settings).
The Omni Agent provides a model tier selector that allows you to choose between different AI models for your chat session. This lets you optimize for speed or intelligence based on your needs:
* **Smarter** - Uses the most capable model (Opus) for complex analysis and nuanced queries
* **Standard** - Uses a balanced model (Sonnet) that provides good performance for most queries
* **Faster** - Uses a fast model (Haiku) for quick responses to simpler questions
To select a model tier, click the **sparkle icon** next to the topic selector (the icon) and choose your preferred tier from the dropdown menu. The selector displays the currently active tier, which defaults to your organization or model-level AI settings.
### When the selection resets
Your selected model tier will persist throughout the session, applying to prompts sent after the tier is selected. However, the selection automatically resets to the default tier when you:
* Switch to a different data model using the model picker
* Start a new chat session
The default tier for each model is determined by the model's [`ai_settings`](/modeling/models/ai-settings) configuration, falling back to organization-level settings when not specified.
## Customizing the Omni Agent
Organization Admins can customize the appearance of the AI chat interface, including the agent's name, icon, and greeting messages. Refer to the [AI branding settings](/ai/settings/branding) for more information.
## Embedding the Omni Agent
The Omni Agent can also be embedded into external applications. Refer to the [embedding the Omni Agent guide](/embed/customization/ai-chat) for setup instructions.
## Next steps
* [Optimize your models for AI](/modeling/develop/ai-optimization) to improve the quality of AI-generated responses
* [Configure topics](/modeling/topics) to organize and scope the data the Omni Agent can access
* [Customize the Omni Agent appearance](/ai/settings/branding) with your own branding
This feature provides transparency into AI-generated queries, helping you verify the AI selected appropriate fields and understand the underlying data structure. To improve the quality of field definitions displayed here, refer to [Optimizing your models for AI](/modeling/develop/ai-optimization).
## Refreshing query results
When you revisit a previous chat session, query results may be stale. To update the results with the latest data, click the **Re-run all queries** icon located at the bottom left corner of the chat box, next to the Model selector.
Clicking this icon re-runs all queries in the conversation, updating visualizations and results with current data. To optimize performance, only the most recent queries are re-run.
## Navigating prompt history
You can quickly recall previous prompts using keyboard shortcuts, similar to a command-line interface:
* Press the **Up arrow** key to cycle backward through your previous prompts
* Press the **Down arrow** key to cycle forward through your prompt history
When you reach your oldest prompt and press Up arrow again, the navigation wraps to your most recent prompt. Pressing Down arrow after your newest prompt restores any in-progress text you were typing before navigating the history.
Up to three pickers can display in the chat interface:
* **Connections** - Lists the connections you have access to. Only displays if more than one connection is available.