Skip to content

Commit 3acc7a7

Browse files
authored
docs: Semantic Catalog and AI assistant (#8388)
1 parent 04d1bc1 commit 3acc7a7

File tree

4 files changed

+182
-32
lines changed

4 files changed

+182
-32
lines changed

docs/pages/product/workspace.mdx

Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -13,35 +13,38 @@ and are only available in Cube Cloud.
1313
## Workspace tools in Cube Cloud
1414

1515
In Cube Cloud, you can:
16-
* Use the [data model editor][ref-data-model] with the [development
17-
mode][ref-dev-mode] and [Rollup Designer][ref-rollup-designer] to build
18-
the data model of your semantic layer.
19-
* Use [SQL Runner][ref-sql-runner] to inform the development of the data
20-
model.
21-
* Use [Playground][ref-playground] to run queries and test the data model.
22-
* Use [Chart Prototyping][ref-vizard] to generate code of a front-end
23-
application that works with Cube.
24-
* Use [Semantic Layer Sync][ref-sls] to connect your semantic layer to BI
25-
tools.
26-
* Use [Query History][ref-query-history] to observe queries and their
27-
performance in real-time.
28-
* Use the [pre-aggregations page][ref-pre-aggs] to inspect pre-aggregations
29-
and their build history.
30-
* Use [Performance Insights][ref-perf-insights] to analyze the performance
31-
of your deployment as a whole.
32-
* Use the [access control page][ref-access-control] to manage users of your
33-
Cube Cloud account and [single sign-on][ref-sso].
34-
* Use [Budgets][ref-budgets] to control the usage and spend of your Cube
35-
Cloud account.
36-
* Use [Preferences][ref-prefs] to adjust the workspace to your liking.
16+
17+
- Use the [data model editor][ref-data-model] with the [development
18+
mode][ref-dev-mode] and [Rollup Designer][ref-rollup-designer] to build
19+
the data model of your semantic layer.
20+
- Use [SQL Runner][ref-sql-runner] to inform the development of the data
21+
model.
22+
- Use [Playground][ref-playground] to run queries and test the data model.
23+
- Use [Chart Prototyping][ref-vizard] to generate code of a front-end
24+
application that works with Cube.
25+
- Use [Semantic Layer Sync][ref-sls] to connect your semantic layer to BI
26+
tools.
27+
- Use [Query History][ref-query-history] to observe queries and their
28+
performance in real-time.
29+
- Use the [pre-aggregations page][ref-pre-aggs] to inspect pre-aggregations
30+
and their build history.
31+
- Use [Performance Insights][ref-perf-insights] to analyze the performance
32+
of your deployment as a whole.
33+
- Use the [access control page][ref-access-control] to manage users of your
34+
Cube Cloud account and [single sign-on][ref-sso].
35+
- Use [Budgets][ref-budgets] to control the usage and spend of your Cube
36+
Cloud account.
37+
- Use [Preferences][ref-prefs] to adjust the workspace to your liking.
38+
- Use [AI Assistant][ref-ai-assistant] to explore and query data with natural language.
39+
- Use [Semantic Catalog][ref-semantic-catalog] to search a unified view of connected data assets, see lineage, and explore connected BI content.
3740

3841
## Workspace tools in Cube Core
3942

4043
With Cube Core, you can:
4144

42-
* Use the data model builder to generate the initial data model.
43-
* Use [Playground][ref-playground] to run queries and test the data model.
44-
* Use the [command-line tool][ref-cli] to automate your workflows.
45+
- Use the data model builder to generate the initial data model.
46+
- Use [Playground][ref-playground] to run queries and test the data model.
47+
- Use the [command-line tool][ref-cli] to automate your workflows.
4548

4649
[ref-infrastructure]: /product/deployment/cloud
4750
[ref-data-model]: /product/workspace/data-model
@@ -59,3 +62,5 @@ With Cube Core, you can:
5962
[ref-budgets]: /product/workspace/budgets
6063
[ref-prefs]: /product/workspace/preferences
6164
[ref-cli]: /product/workspace/cli
65+
[ref-ai-assistant]: /product/workspace/ai-assistant
66+
[ref-semantic-catalog]: /product/workspace/semantic-catalog
Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
module.exports = {
2-
"playground": "Playground",
2+
playground: "Playground",
33
"data-model": "Data Model",
44
"rollup-designer": "Rollup Designer",
55
"dev-mode": "Development mode",
6-
"vizard": "Chart Prototyping",
6+
vizard: "Chart Prototyping",
77
"semantic-layer-sync": "Semantic Layer Sync",
88
"sql-runner": "SQL Runner",
99
"query-history": "Query History",
1010
"pre-aggregations": "Pre-Aggregations",
11-
"performance": "Performance Insights",
11+
performance: "Performance Insights",
1212
"access-control": "Access Control",
13-
"sso": "Single Sign-on",
14-
"budgets": "Budgets",
15-
"preferences": "Preferences",
16-
"cli": "CLI"
17-
}
13+
sso: "Single Sign-on",
14+
budgets: "Budgets",
15+
preferences: "Preferences",
16+
cli: "CLI",
17+
"ai-assistant": "AI Assistant",
18+
};
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# AI Assistant
2+
3+
Business users can ask questions about your organization's Cube data model and run queries using natural language.
4+
AI Assistant is integrated with the [Playground][ref-playground] and [Semantic Catalog][ref-catalog] so that users can easily explore their results further.
5+
6+
<SuccessBox>
7+
8+
AI Assistant is available in Cube Cloud on
9+
[Premium and above](https://cube.dev/pricing) tiers.
10+
[Contact us](https://cube.dev/contact) for details.
11+
12+
</SuccessBox>
13+
14+
<Screenshot src="https://ucarecdn.com/9aee5273-e219-4ccc-aa5c-2c8b66a6c932/assistant.jpg" />
15+
16+
## Getting Started
17+
18+
AI Assistant is currently in preview. To get started, please ask your account team to enable AI Assistant for you.
19+
20+
Then, if you've already set up Semantic Catalog, you're ready to use AI Assistant. If you haven't, do the following to enable AI Asisstant:
21+
22+
1. In your Cube deployment sidebar, navigate to "Settings" and then "Catalog Services"
23+
2. Click the button to enable the Catalog. This will connect your Cube data model and enable AI Assistant.
24+
3. If you'd like to connect any downstream business intelligence tools, follow the [guide on the Semantic Catalog page][ref-catalog-downstream].
25+
26+
## Using AI Assistant
27+
28+
Users can ask questions and have conversations with the AI Assistant to better understand the data in your Cube data model, to pull data, and run basic analyses.
29+
There are two specific types of questions that the AI Assistant can answer: catalog questions and data queries. These are described in more detail below.
30+
31+
### Catalog questions
32+
33+
A catalog question is a question about what data is available to the user or what particular data assets mean (for example, a dimension or measure).
34+
35+
**Example**
36+
37+
A user might want to do some analysis around geographies, but they're not sure if their organization already has dashboards about users' locations
38+
or how granular their organization's data on user locations goes. They could ask:
39+
40+
> What info do we have about user locations?
41+
42+
The AI Assistant will reply with a summary and display the dashboards, charts, and/or Cube view(s) containing location information for the user to explore.
43+
44+
<Screenshot src="https://ucarecdn.com/0fb3768f-1b1a-42d5-89f0-38555b0c7427/Screenshot20240624at41011PM.png" />
45+
46+
### Data Queries
47+
48+
A data query is one where the user wants the AI Assistant to generate and run a Cube query, and return the results.
49+
Users can get quick answers to questions instead of having to ask an analyst, file a ticket, or navigate a complex visualization tool.
50+
51+
**Example**
52+
53+
A sales analyst might want to know which cities orders are trending in lately. They could ask the following question:
54+
55+
> Where did we have the most orders last month?
56+
57+
The query will automatically run in the sidebar and can be opened in the [Playground][ref-playground] for further exploration.
58+
59+
<Screenshot src="https://ucarecdn.com/4249ff1e-fae1-42c8-ad3a-b9e406ea2022/Screenshot20240624at34327PM.png" />
60+
61+
## FAQ and limitations
62+
63+
### 1. What language model(s) does the AI Assistant use?
64+
65+
- The AI Assistant currently uses GPT-4o from OpenAI, but this may change in the future
66+
67+
### 2. Are conversations saved or used for training models?
68+
69+
- Per our terms with the LLM provider(s), they do not use the conversations for training models.
70+
- They may save conversations for up to 30 days for abuse and fraud monitoring purposes.
71+
- Note that customer data (i.e. the results of queries) is _never_ visible to the LLM in the AI Assistant.
72+
73+
### 3. Can the LLM hallucinate or give incorrect results?
74+
75+
- We make every effort to avoid hallucinations and incorrect results. However, the nature of AI-based systems is that they may make mistakes from time to time.
76+
- If the model hallucinates data assets (such as dimensions, measures, or views) that don't exist, the user will see an error in the playground. It will _never_ return "fake" data, as a valid Cube query is needed to display results.
77+
78+
### 4. How can I give feedback or train the model?
79+
80+
- To give feedback to the model, use the thumbs-up and thumbs-down buttons that appear under each response.
81+
- If a model is consistently getting something wrong, it may be a sign that the data model is confusing or incomplete. Check things like field labels and descriptions and make sure that irrelevant fields are not marked as visible in your Cube data model.
82+
83+
[ref-catalog]: /product/workspace/semantic-catalog
84+
[ref-playground]: /product/workspace/playground
85+
[ref-catalog-downstream]: /product/workspace/semantic-catalog#connecting-downstream-tools
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Semantic Catalog
2+
3+
Semantic Catalog lets users search, understand, and re-use trusted data products,
4+
both from Cube and external sources such as cloud data warehouses and business intelligence tools.
5+
6+
<SuccessBox>
7+
8+
Semantic Catalog is available in Cube Cloud on
9+
[Premium and above](https://cube.dev/pricing) tiers.
10+
[Contact us](https://cube.dev/contact) for details.
11+
12+
</SuccessBox>
13+
14+
<Screenshot src="https://ucarecdn.com/d8e09149-7ed2-4f5c-83f6-406734557efb/catalog.jpg" />
15+
16+
## Getting Started
17+
18+
### Enabling Semantic Catalog
19+
20+
Semantic Catalog is currently in preview. First, ask your account team to enable it for you.
21+
22+
Then, in your Cube deployment, navigate to the "Catalog" sidebar tab.
23+
If it is not already enabled, there will be a button to get started.
24+
After you click this button, your Cube data model will sync to the Semantic Catalog.
25+
In a few moments, you will see Cubes, Views, and Tables appear in the Semantic Catalog.
26+
27+
### Connecting downstream tools
28+
29+
In addition to your Cube data model, Semantic Catalog can be used to understand charts and dashboards in downstream business intelligence and data visualization tools.
30+
These currently include:
31+
32+
- [Tableau][ref-tableau]
33+
- [Superset][ref-superset]
34+
- [Preset][ref-superset]
35+
- Amazon Quicksight
36+
37+
To connect these, navigate to "Settings" in your Cube deployment sidebar, and then choose "Catalog Services."
38+
Click the "Add Service" button, and a modal will pop up for you to enter credentials, test the connection, and create your service.
39+
40+
<Screenshot src="https://ucarecdn.com/a060a3cb-f5f0-4b5e-90fb-84694d6c32f4/Screenshot20240624at43731PM.png" />
41+
42+
## Usage
43+
44+
### Overview
45+
46+
You can search and filter for data assets such as Cubes, Views, tables, charts, and dashboards.
47+
Semantic Catalog will show you an overview of each data asset, including information such as name,
48+
description, the measures and dimensions included (for a Cube or View), and usage information.
49+
50+
### Lineage
51+
52+
Semantic Catalog can be used to explore lineage between your connected data assets.
53+
For example, for a View, users can see what tables and Cubes flow into it as well as the downstream
54+
dashboards that query it in tools such as Tableau and Superset.
55+
56+
<Screenshot src="https://ucarecdn.com/9adbeb24-203d-4608-9351-fac348a01f51/Screenshot20240624at44511PM.png" />
57+
58+
[ref-tableau]: /product/configuration/visualization-tools/tableau
59+
[ref-superset]: /product/configuration/visualization-tools/superset

0 commit comments

Comments
 (0)