-
Notifications
You must be signed in to change notification settings - Fork 28
dashboard ideas for desktop restructure #846
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: console
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,97 +0,0 @@ | ||
| = Creating a dashboard with AI | ||
|
|
||
| For AI features to be accessible, an xref:user-management.adoc#_organization_level_roles[organization admin] must enable Generative AI assistance under xref:visual-tour/index.adoc#org-settings[organization settings]. | ||
|
|
||
| . In the **Create with AI** dialog, you can enter an optional natural language text prompt to let Neo4j create a customized dashboard. | ||
| . Once you are happy with the prompt, **Create** the dashboard. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| When creating a dashboard with AI, the AI analyzes your link:https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_schema_visualization[database schema], that is, the node labels and relationship types of your database. | ||
| It cannot read the actual data in your database. | ||
| ==== | ||
|
|
||
| The prompt is processed in the background. | ||
| The AI analyzes your database schema and tries to come up with useful queries about the data while taking your prompt into account. | ||
| Then it creates a suitable visualization for each query. | ||
|
|
||
| If you do not enter a prompt, Neo4j AI will still make use of your database schema and come up with a suitable dashboard. | ||
|
|
||
| Note that the following examples might differ when you reproduce them. | ||
| This is due to the nature of how LLM processing works. | ||
|
|
||
|
|
||
| == Creating a data-focused dashboard | ||
|
|
||
| Copy the following prompt or create your own and use it to create a dashboard: | ||
|
|
||
| .Prompt for a data-focused dashboard | ||
| [source] | ||
| ---- | ||
| Create a dashboard on my retail database, giving me an overview over recent top customers, top selling products, currently available stock, a category overview and sales volume per quarter. | ||
| ---- | ||
|
|
||
| The more information you include, the better the result. | ||
| This holds for information about the database itself as well as entities in the data model. | ||
|
|
||
| .Create a data-focused dashboard | ||
| image::dashboards/ai-dashboard-prompt-data-focus.png[] | ||
|
|
||
| Here is a sample result: | ||
|
|
||
| .A data-focused dashboard | ||
| image::dashboards/ai-dashboard-data-focus.png[] | ||
|
|
||
|
|
||
| == Creating a visualization-focused dashboard | ||
|
|
||
| Copy the following prompt or create your own and use it to create a dashboard: | ||
|
|
||
| .Prompt for a visualization-focused dashboard | ||
| [source] | ||
| ---- | ||
| Create a dashboard with only graph visualizations to analyze my graph. | ||
| ---- | ||
|
|
||
| .Create visualization-focused dashboard | ||
| image::dashboards/ai-dashboard-prompt-visualization-focus.png[] | ||
|
|
||
| Here is a sample result: | ||
|
|
||
| .A visualization-focused dashboard | ||
| image::dashboards/ai-dashboard-visualization-focus.png[] | ||
|
|
||
|
|
||
| == Combining data- and visualization focus | ||
|
|
||
| Copy the following prompt or create your own and use it to create a dashboard: | ||
|
|
||
| .Prompt for a dashboard with both a data and a visualization focus | ||
| [source] | ||
| ---- | ||
| Create a dashboard with 5 bar charts analyzing products for categories and 5 graph visualizations for these categories. | ||
| ---- | ||
|
|
||
| .Create a dashboard with both a data and a visualization focus | ||
| image::dashboards/ai-dashboard-prompt-dual-focus.png[] | ||
|
|
||
| Here is a sample result: | ||
|
|
||
| .A dashboard with both a data and a visualization focus (1) | ||
| image::dashboards/ai-dashboard-dual-focus-1.png[] | ||
|
|
||
| .A dashboard with both a data and a visualization focus (2) | ||
| image::dashboards/ai-dashboard-dual-focus-2.png[] | ||
|
|
||
| == Quality of the data model | ||
|
|
||
| AI provides a great starting point, but the quality of your underlying data model still matters. | ||
| A graph model that has been thought out well leads to a dashboard that yields more meaningful insights. | ||
| AI infers nodes and relationships. | ||
| You can leverage this by using the exact node and relationship identifiers from the schema in your prompts to guide AI towards more relevant charts. | ||
|
|
||
| == AI as a starting point | ||
|
|
||
| Remember, you can always edit an AI-generated dashboard. | ||
| It is a valid workflow to use AI as a starting point, and then build on it by editing the output - and refining visualizations, colors, and layouts to match your needs. | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,45 +1,20 @@ | ||
| = Getting started | ||
| = Create dashboards with Cypher | ||
| :description: This page contains a working example of Neo4j dashboards. | ||
|
|
||
| label:Aura-DB[] | ||
| label:Desktop[] | ||
|
|
||
| Set up a working example of Neo4j dashboards. | ||
|
|
||
| == Prerequisites | ||
|
|
||
| You need: | ||
|
|
||
| . A Neo4j Aura account | ||
| . A Neo4j Aura database instance | ||
|
|
||
| See xref::/getting-started/create-account.adoc[Create an account] and xref::/getting-started/create-instance.adoc[Create an instance] for details. | ||
| . A database instance | ||
|
|
||
| == Add a sample data set | ||
|
|
||
| Import the Northwind dataset to your instance: | ||
|
|
||
| * In Aura, select **Learning** from the navigation. | ||
| * In the **Beginner** page, select the **Learn the basics** guide. | ||
| * When prompted to **Connect to instance**, select the instance where you would like to import sample data. | ||
| * In step 4 of 11 of the guide, import via **Get the Northwind dataset**. | ||
| * Run the import from the **Import** page via **Run import**. | ||
|
|
||
| The examples on this page refer to the Northwind dataset. | ||
|
|
||
| [.shadow] | ||
| .Northwind dataset | ||
| image::northwind-data-set.png[] | ||
|
|
||
| == Create a dashboard | ||
|
|
||
| Create a new dashboard: | ||
|
|
||
| . In the **Dashboards** page, create a new dashboard, either with LLM assistance or from scratch. | ||
| . If prompted to **Connect to instance**, select your instance. | ||
|
|
||
|
|
||
| === Creating a dashboard with LLM assistance | ||
|
|
||
| See xref::/dashboards/ai-dashboards.adoc[] for details. | ||
|
|
||
| Import the Northwind dataset to your instance: https://neo4j.com/docs/getting-started/appendix/example-data/ | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the link doesn't tell the user how to actually import the data - that's why i wrote instructions for it :)
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. after writing, i see now that it's still there in "create-dashboards-with-ai" -
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good point |
||
|
|
||
| === Creating a dashboard from scratch | ||
|
|
||
|
|
@@ -50,7 +25,6 @@ To create a dashboard from scratch: | |
| . Your dashboard has a single page titled "Main page". To change the name, hover it and then use the more menu *[...]* and **Edit page name**. | ||
| . Use **Add card** to create cards which represent visualizations. | ||
|
|
||
|
|
||
| ==== Add a card with a bar chart | ||
|
|
||
| Create a bar chart which displays the number of orders per customer. | ||
|
|
@@ -73,9 +47,6 @@ Your bar chart should look like this: | |
| .Example bar chart | ||
| image::dashboards/visualizations/visualization-bar-chart.png[] | ||
|
|
||
| Alternatively, use xref:/dashboards/visualizations/index.adoc#_natural_language[natural language] to create the query for your bar chart. | ||
|
|
||
|
|
||
| ==== Add a card with a line chart | ||
|
|
||
| Create a line chart which displays the number of product categories by order dates. | ||
|
|
@@ -100,8 +71,7 @@ Your line chart should look like this: | |
| .Example line chart | ||
| image::dashboards/visualizations/visualization-line-chart.png[] | ||
|
|
||
| Alternatively, use xref:/dashboards/visualizations/index.adoc#_natural_language[natural language] to create the query for your bar chart. | ||
|
|
||
| Alternatively, if you're using Aura, use xref:/dashboards/visualizations/index.adoc#_natural_language[natural language] to create the query for your bar chart. | ||
|
|
||
| == Next steps | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| = Creating a dashboard with AI | ||
|
|
||
| For AI features to be accessible, an xref:user-management.adoc#_organization_level_roles[organization admin] must enable Generative AI assistance under xref:visual-tour/index.adoc#org-settings[organization settings]. | ||
|
|
||
| . In the **Create with AI** dialog, you can enter an optional natural language text prompt to let Neo4j create a customized dashboard. | ||
| . Once you are happy with the prompt, **Create** the dashboard. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| When creating a dashboard with AI, the AI analyzes your link:https://neo4j.com/docs/operations-manual/current/procedures/#procedure_db_schema_visualization[database schema], that is, the node labels and relationship types of your database. | ||
| It cannot read the actual data in your database. | ||
| ==== | ||
|
|
||
| The prompt is processed in the background. | ||
| The AI analyzes your database schema and tries to come up with useful queries about the data while taking your prompt into account. | ||
| Then it creates a suitable visualization for each query. | ||
|
|
||
| If you do not enter a prompt, Neo4j AI will still make use of your database schema and come up with a suitable dashboard. | ||
|
|
||
| Note that the following examples might differ when you reproduce them. | ||
| This is due to the nature of how LLM processing works. | ||
|
|
||
| == Creating a data-focused dashboard | ||
|
|
||
| Copy the following prompt or create your own and use it to create a dashboard: | ||
|
|
||
| .Prompt for a data-focused dashboard | ||
| [source] | ||
| ---- | ||
| Create a dashboard on my retail database, giving me an overview over recent top customers, top selling products, currently available stock, a category overview and sales volume per quarter. | ||
| ---- | ||
|
|
||
| The more information you include, the better the result. | ||
| This holds for information about the database itself as well as entities in the data model. | ||
|
|
||
| .Create a data-focused dashboard | ||
| image::dashboards/ai-dashboard-prompt-data-focus.png[] | ||
|
|
||
| Here is a sample result: | ||
|
|
||
| .A data-focused dashboard | ||
| image::dashboards/ai-dashboard-data-focus.png[] | ||
|
|
||
| == Creating a visualization-focused dashboard | ||
|
|
||
| Copy the following prompt or create your own and use it to create a dashboard: | ||
|
|
||
| .Prompt for a visualization-focused dashboard | ||
| [source] | ||
| ---- | ||
| Create a dashboard with only graph visualizations to analyze my graph. | ||
| ---- | ||
|
|
||
| .Create visualization-focused dashboard | ||
| image::dashboards/ai-dashboard-prompt-visualization-focus.png[] | ||
|
|
||
| Here is a sample result: | ||
|
|
||
| .A visualization-focused dashboard | ||
| image::dashboards/ai-dashboard-visualization-focus.png[] | ||
|
|
||
|
|
||
| == Combining data- and visualization focus | ||
|
|
||
| Copy the following prompt or create your own and use it to create a dashboard: | ||
|
|
||
| .Prompt for a dashboard with both a data and a visualization focus | ||
| [source] | ||
| ---- | ||
| Create a dashboard with 5 bar charts analyzing products for categories and 5 graph visualizations for these categories. | ||
| ---- | ||
|
|
||
| .Create a dashboard with both a data and a visualization focus | ||
| image::dashboards/ai-dashboard-prompt-dual-focus.png[] | ||
|
|
||
| Here is a sample result: | ||
|
|
||
| .A dashboard with both a data and a visualization focus (1) | ||
| image::dashboards/ai-dashboard-dual-focus-1.png[] | ||
|
|
||
| .A dashboard with both a data and a visualization focus (2) | ||
| image::dashboards/ai-dashboard-dual-focus-2.png[] | ||
|
|
||
| == Quality of the data model | ||
|
|
||
| AI provides a great starting point, but the quality of your underlying data model still matters. | ||
| A graph model that has been thought out well leads to a dashboard that yields more meaningful insights. | ||
| AI infers nodes and relationships. | ||
| You can leverage this by using the exact node and relationship identifiers from the schema in your prompts to guide AI towards more relevant charts. | ||
|
|
||
| == AI as a starting point | ||
|
|
||
| Remember, you can always edit an AI-generated dashboard. | ||
| It is a valid workflow to use AI as a starting point, and then build on it by editing the output - and refining visualizations, colors, and layouts to match your needs. | ||
|
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| [[Sample-dataset]] | ||
| = Sample dataset (Aura) | ||
| :description: description goes here | ||
|
|
||
| The examples in the dashboard documentation refer to the Northwind dataset. | ||
| To import the Northwind dataset to your instance: | ||
|
|
||
| * In Aura, select **Learning** from the navigation. | ||
| * In the **Beginner** page, select the **Learn the basics** guide. | ||
| * When prompted to **Connect to instance**, select the instance where you would like to import sample data. | ||
| * In step 4 of 11 of the guide, import via **Get the Northwind dataset**. | ||
| * Run the import from the **Import** page via **Run import**. | ||
|
|
||
| [.shadow] | ||
| .Northwind dataset | ||
| image::northwind-data-set.png[width=600] | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
since it's removed from the navigation, the file should probably be removed as well
this also means that we should add aliases and/or redirects
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes great shout, let's do that once we've got the final structure looking how we like