diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index 556da86a8..bdce4d756 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -97,12 +97,14 @@ Generic Start ** xref:aura-cli/configuration.adoc[Configuration] ** xref:aura-cli/migration.adoc[Migration] +* xref:sample-dataset.adoc[Sample dataset (Aura)] + * Dashboards ** xref:dashboards/index.adoc[Overview] -** xref:dashboards/getting-started.adoc[Getting started] -** xref:dashboards/managing-dashboards.adoc[Managing dashboards] +** xref:dashboards/create-dashboards-with-ai.adoc[Create dashboards with AI (Aura)] +** xref:dashboards/create-dashboards-manually.adoc[Create dashboards with Cypher (Desktop & Aura)] +** xref:dashboards/managing-dashboards.adoc[Managing dashboards (Desktop & Aura)] ** xref:dashboards/import.adoc[Import and export] -** xref:dashboards/ai-dashboards.adoc[AI dashboards] ** xref:dashboards/parameters-and-filters.adoc[Parameters and filters] ** xref:dashboards/sharing-dashboards.adoc[Sharing dashboards] ** xref:dashboards/visualizations/index.adoc[Visualizations] diff --git a/modules/ROOT/pages/dashboards/ai-dashboards.adoc b/modules/ROOT/pages/dashboards/ai-dashboards.adoc index cd2f295f6..e69de29bb 100644 --- a/modules/ROOT/pages/dashboards/ai-dashboards.adoc +++ b/modules/ROOT/pages/dashboards/ai-dashboards.adoc @@ -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. - diff --git a/modules/ROOT/pages/dashboards/getting-started.adoc b/modules/ROOT/pages/dashboards/create-dashboards-manually.adoc similarity index 62% rename from modules/ROOT/pages/dashboards/getting-started.adoc rename to modules/ROOT/pages/dashboards/create-dashboards-manually.adoc index ff44d6d88..b76cc24ac 100644 --- a/modules/ROOT/pages/dashboards/getting-started.adoc +++ b/modules/ROOT/pages/dashboards/create-dashboards-manually.adoc @@ -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/ === 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 diff --git a/modules/ROOT/pages/dashboards/create-dashboards-with-ai.adoc b/modules/ROOT/pages/dashboards/create-dashboards-with-ai.adoc new file mode 100644 index 000000000..7da7e1b7a --- /dev/null +++ b/modules/ROOT/pages/dashboards/create-dashboards-with-ai.adoc @@ -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. + diff --git a/modules/ROOT/pages/dashboards/index.adoc b/modules/ROOT/pages/dashboards/index.adoc index c01cdac41..8a5ed9e90 100644 --- a/modules/ROOT/pages/dashboards/index.adoc +++ b/modules/ROOT/pages/dashboards/index.adoc @@ -10,10 +10,29 @@ image::dashboards/dashboard-full.png[] Neo4j dashboards' main features include: -* Neo4j dashboards are a part of the Aura console experience and are stored automatically in the Neo4j cloud storage. * Neo4j dashboards operate directly on your graph data via Cypher queries. * Manage and customize your dashboards, dashboard pages and cards. * Customize visualizations via settings and their corresponding Cypher query. // * Parameterize visualizations or entire dashboards // * Apply rule-based styling to your visualizations -// * Share your dashboards across your team or your company \ No newline at end of file +// * Share your dashboards across your team or your company + +== Create a dashboard + +You can create dashboards in two ways: + +* *Create with AI (Aura only)*: Use natural language to generate Cypher queries and visualizations automatically. + +// === Creating a dashboard with LLM assistance +// See xref::/dashboards/ai-dashboards.adoc[] for details. + +* *Create with Cypher (Desktop or Aura)*: Write your own Cypher queries to define charts and data relationships. + +[NOTE] +==== +The number of dashboards you can create depends on your Aura tier: + +* AuraDB Free: three dashboards +* AuraDB Professional: 25 dashboards +* AuraDB Business Critical and Virtual Dedicated Cloud: unlimited dashboards +==== \ No newline at end of file diff --git a/modules/ROOT/pages/dashboards/managing-dashboards.adoc b/modules/ROOT/pages/dashboards/managing-dashboards.adoc index 106bc3fa1..2d4624e05 100644 --- a/modules/ROOT/pages/dashboards/managing-dashboards.adoc +++ b/modules/ROOT/pages/dashboards/managing-dashboards.adoc @@ -1,34 +1,7 @@ = Managing dashboards :description: Create and modify Neo4j dashboards. -In Neo4j Aura, use **Dashboards** under **Tools** in the left-side navigation to access the dashboard page. - -[NOTE] -==== -The number of dashboards you can create depends on your Aura tier: - -* AuraDB Free: three dashboards -* AuraDB Professional: 25 dashboards -* AuraDB Business Critical and Virtual Dedicated Cloud: unlimited dashboards -==== - - -== Creating a dashboard - -If you have no dashboards, select **Create with AI**, **Create from scratch** or **Import**. - -.Create your first dashboard -image::dashboards/create-first-dashboard.png[] - -If you already have a dashboard and want to create another, use either **Import** or **Create** and then **Create from scratch**, or **Create with AI** at the top right. - -See xref::/dashboards/ai-dashboards.adoc[] for advice how to create a dashboard via prompt. - -**Create from scratch** takes you directly to a new and empty dashboard. - -See xref:/dashboards/import.adoc[] to learn more about importing dashboards. - - +Use **Dashboards** under **Tools** in the left-side navigation to access the dashboard page. == Editing a dashboard diff --git a/modules/ROOT/pages/dashboards/sharing-dashboards.adoc b/modules/ROOT/pages/dashboards/sharing-dashboards.adoc index 162fee6b8..3ed221520 100644 --- a/modules/ROOT/pages/dashboards/sharing-dashboards.adoc +++ b/modules/ROOT/pages/dashboards/sharing-dashboards.adoc @@ -1,4 +1,4 @@ -= Sharing dashboards += Sharing dashboards (Aura only) :description: Share your dashboards with people in your project. You can share your dashboards with other users in your project. diff --git a/modules/ROOT/pages/sample-dataset.adoc b/modules/ROOT/pages/sample-dataset.adoc new file mode 100644 index 000000000..6e4472da3 --- /dev/null +++ b/modules/ROOT/pages/sample-dataset.adoc @@ -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] +