diff --git a/docs/pages/product/d3/agent-settings--configure-agent-visibility/agent-settings--configure-agent-visibility.md b/docs/pages/product/d3/agent-settings--configure-agent-visibility/agent-settings--configure-agent-visibility.md new file mode 100644 index 0000000000000..60564385bb69a --- /dev/null +++ b/docs/pages/product/d3/agent-settings--configure-agent-visibility/agent-settings--configure-agent-visibility.md @@ -0,0 +1,31 @@ +## Overview + +Configure agent visibility to control which data views your agents can access. This ensures agents only interact with relevant information, improving efficiency and security. + +## Managing Agent Visibility + +### Navigating to Agent Settings + +To configure agent visibility, first navigate to the agent settings. The specific steps may vary based on your Cube setup. Generally, you will find the agent settings within the main settings menu or through the agent's individual profile. + +This screenshot displays the general settings panel for an agent. + + + +It includes options for `Name`, `Description`, `Runtime`, `Plan`, `Model`, `Danger Zone`, and more. + +### Restricting Agent Access + +Restricting agent access to specific data views enhances security and focus. By limiting the data an agent can see, you prevent accidental data exposure and ensure the agent only works with necessary information. + +In the `Semantic Model Section`, select the `Restrict agent to specific views` checkbox. + + + +Then, click the `Search and select a view` dropdown menu. + +Choose the desired views to which you want to restrict the agent. You may select multiple views if needed. You can remove views with the `Remove` button. + +## Future Capabilities + +Cube is developing experimental features for agents. One planned future capability will allow agents to not only consume the data model, but also modify it. This feature is currently labeled as "Experimental" in the settings panel, and includes the `Change Semantic Model` checkbox. \ No newline at end of file diff --git a/docs/pages/product/d3/home-screen--start-analysis/home-screen--start-analysis.md b/docs/pages/product/d3/home-screen--start-analysis/home-screen--start-analysis.md new file mode 100644 index 0000000000000..e596b22a72083 --- /dev/null +++ b/docs/pages/product/d3/home-screen--start-analysis/home-screen--start-analysis.md @@ -0,0 +1,65 @@ +## Overview + +Learn to analyze revenue data using Cube's interactive features, including charts, tables, and SQL queries. + +## Starting an Analysis + +Type your analysis request into the textbox in the main area. + + + +Click the `Button` to begin the analysis. + +## Viewing and Interacting with Results + +View the total revenue number. + + + +The system shows the steps taken to retrieve the data, including the semantic model searched and the queried semantic model. + +View a summary of the retrieved revenue numbers, with a message explaining the data's origin and representation. + + + +Provide feedback on the results using the thumbs up/down icons. This feedback helps Cube learn and improve future results. + +### Viewing Data in Tables and Charts + +The initial view shows a summary of the total revenue. + + + +Click the `Break it down by month` button to view monthly revenue data in a table. Click `Certify` to confirm the results. Click `Download` to download the data. + +Click the `Chart` tab to switch to a chart view of the monthly revenue data. + + + +You can switch from the chart view to the table view. + + + +Use the pagination controls to navigate through the data. + +### Customizing SQL Queries + +You can open reports in full screen. + +Click `Edit SQL Query` to view and edit the underlying SQL query for the chart. + + + +You can send the query to chat. + +You can edit the query, including changing the `ORDER BY` clause via the dropdown menu. + + + +The right side shows available fields to add to the query. + +The SQL query can include a `LAG` function to calculate prior month revenue. + + + +A sidebar shows available fields to include in the query. \ No newline at end of file diff --git a/docs/pages/product/d3/home-screen--start-chatting/home-screen--start-chatting.md b/docs/pages/product/d3/home-screen--start-chatting/home-screen--start-chatting.md new file mode 100644 index 0000000000000..d4bb4024c57f6 --- /dev/null +++ b/docs/pages/product/d3/home-screen--start-chatting/home-screen--start-chatting.md @@ -0,0 +1,119 @@ +## Overview + +Manage Cube's settings, spaces, and agents to customize your data analysis experience. + +## Admin Panel + +Access the admin panel through the `Main Menu` sidebar on the left of the home screen. + + + +### User Management + +To manage users, select `Users` in the sidebar. + + + +You will see a table view of users, their email addresses, roles, and last login times. + +To change a user's role, select a new role from the dropdown menu next to their name. + + + +You will see a success message upon updating the role. + + + +Use the pagination controls to navigate through multiple pages of users, if needed. + +### Global Settings + +To access global settings, select `Settings` in the sidebar. + + + +Configure custom AI models in the "Bring Your Own Model (BYOM)" section. + +Click `Add Model` to open the new model modal. + + + +Specify the `Name`, select the `Provider` and the `Model` from the dropdown menus. + +You may need to enter your `Region`, `Access Key ID`, and `Secret Access Key`, depending on the model and provider you choose. + + + +The `MCP servers` section will allow you to configure connections. + + + +It currently displays a loading indicator and the message "MCP server settings coming soon." + +## Agent Spaces + +To manage agent spaces, select `Spaces` in the sidebar. + + + +You can create new spaces, view existing spaces, and delete spaces. + +To create a new space, click `Create Space` and enter a `Name` for the space. + + + +To delete a space, select the space from the list and click `Delete Space`. + + + +A modal will appear to confirm the deletion. Deleting a space permanently removes it and all related agents. + +### Certified Queries + +Within a space, click the `Certified Queries` tab to view and manage certified queries. + + + +If there are no certified queries, this will be indicated. + + + +Otherwise, you will see a table of certified queries, with options to `View` and `Delete` each query. + +Use the pagination controls to navigate through multiple pages if needed. + + + +### Rules + +Click the `Rules` tab to manage rules for the selected space. + + + +If no rules exist, you will see a message indicating this, along with an `Add Rule` button. + +To add a new rule, click `Add Rule`. + + + +Choose the `Type` from the dropdown and enter a `Prompt` for the rule. You may also enter a `Description` for the rule. + +## Agents + +To manage agents, select `Agents` in the sidebar. + + + +If there are no agents, a table will be displayed along with a button to `Create Agent`. + +To create a new agent, click `Create Agent`. + + + +Enter a `Name` for the agent (required), select a `Cube Cloud Semantic Model`, and then select the `Space` for the agent. + +To delete an agent, go to the agent details view and click `Delete Agent`. + + + +You can also `Clear Chat History` for the agent. \ No newline at end of file diff --git a/docs/pages/product/d3/query-editor--send-to-chat/query-editor--send-to-chat.md b/docs/pages/product/d3/query-editor--send-to-chat/query-editor--send-to-chat.md new file mode 100644 index 0000000000000..ac4c64b3ffb0a --- /dev/null +++ b/docs/pages/product/d3/query-editor--send-to-chat/query-editor--send-to-chat.md @@ -0,0 +1,51 @@ +## Overview + +Use the SQL editor in Cube to write, modify, and run queries, and send query results to chat. + +## Using the Query Editor + +Open the query editor in Cube. + + + +You will see a text box labeled `Edit SQL Query`, where you can write and edit your queries. The `Fields` section to the right lists available fields. Click a field name to add it to the query, or type it directly into the query text box. + +You may already see a pre-populated query. + + + +If so, you can run or modify this query. + +### Modifying and Running a Query + +To modify the query, edit the text in the `Edit SQL Query` text box. You can add fields from the `Fields` section by clicking on the desired field. You can also type in field names directly. + +For example, you could change `DATE_TRUNC('y', orders_view.date)` to `DATE_TRUNC('year', orders_view.date)`. + + + +After making changes, click the `Run` button to see the updated results. + +Click the `Send to chat` button to send the query results to chat. This avoids repetition using CTEs (Common Table Expressions), allows smaller changes to be made easily, and provides feedback to the agent. Consider attaching context to feedback (e.g., "do this instead"). + +### Using the Results Table + +The query results display in a table below the query editor. + + + +A summary section below the table shows summary information for the displayed data. + +Use the `Pagination Controls` below the table to navigate through pages of data if there are a lot of results. + + + +### Closing the Editor + +To close the editor, click the close button. + + + +A confirmation modal will appear asking you to confirm. + +You can choose to `Send to chat` to save and send the query before closing, or click `Don't save and close` to close without saving.