Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added modules/ROOT/images/enable-copilot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/explore-copilot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/query-copilot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions modules/ROOT/pages/explore/explore-visual-tour/search-bar.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ When you enter a term or phrase in the search bar, Explore provides a list of su
* Full-text search
* Actions

Additionally, you can use the co-pilot to help you write search patterns.
See further down for more information on the co-pilot.

[.shadow]
image::search-bar-5.png[width=500]
[.shadow]
Expand Down Expand Up @@ -63,6 +66,7 @@ Without any full-text index configured, Explore will fall back to searching in a

See xref:explore/explore-features//full-text-search.adoc[Full-text search] tutorial topic for tips on using the full-text search option.


== Actions

Actions are phrases that trigger user-interface commands when typed in the search bar, e.g. `Clear Scene` will empty the canvas of the currently shown nodes and relationships.
Expand All @@ -80,6 +84,28 @@ This lists some of the available Actions:

See xref:explore/explore-default-actions.adoc[Default actions and shortcuts] for the complete list and associated keyboard shortcuts.

== Explore co-pilot

The co-pilot is a feature to help you write search patterns.
The search bar already offers near-natural search, but the co-pilot is even closer to natural language.
It makes it easier to mimic Cypher queries without having to know the Cypher syntax.
The co-pilot is available in the search bar once you have enabled it in the Org settings.
See xref:visual-tour/index.adoc#org-settings[Organization settings] for more information.
You enter your query in a separate bar and the co-pilot suggests a pattern in the search bar, based on the input.

[.shadow]
image::explore-copilot.png[width=800]

The co-pilot is an experimental feature and does not provide guaranteed accuracy.
To get the best results, it is important to be familiar with the data model, especially the labels and relationships in the graph.
The more detailed you are when using the co-pilot, the more accurate the results will be.

For example, if you are looking for the shipper who ships the product _Ikura_, you could ask "Who ships Ikura".
But that doesn't yield any results so you need to be more specific.
You know that _Ikura_ is a **product** and that the **shipper** is the one shipping it, so a better suggestion is "Which Shipper ships the Product Ikura".
The main difference between the two questions for the co-pilot is that the latter includes category names, which are the labels in the graph.
If you use the data model as a basis for your questions, you will get better results from the co-pilot.




Expand Down
32 changes: 32 additions & 0 deletions modules/ROOT/pages/query/visual-tour.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -142,4 +142,36 @@ You can expand and collapse the result frames using the *Collapse* icon.
To remove all the frames from the stream, use the `:clear` command.
Clearing the stream does **not** clear the history, that is done from the **Query history** drawer, as mentioned previously.

== Query co-pilot

The co-pilot is a feature that helps you write Cypher queries.
It allows you to use natural language to ask the database a question, to *query* the database in other words.
You enter your question and the co-pilot suggests a Cypher query based on your input.
You can edit the query and run it or rephrase your question to generate a new query.

When you write a question, it is automatically augmented with the current database schema, which provides the LLM with the right context.
Being familiar with the database schema helps you write questions that are more likely to generate accurate Cypher queries.

[TIP]
====
If you need a reminder what your datamodel looks like, you can use the procedure `CALL db.schema.visualization()` for a visual representation of your database.
====

The co-pilot is available from the Cypher editor once you have enabled it in the Org settings.
See xref:visual-tour/index.adoc#org-settings[Organization settings] for more information.

[.shadow]
image::query-copilot.png[width=800]

The co-pilot is an experimental feature and is not guaranteed to always generate accurate Cypher queries.
It is recommended to review the generated query before running it, especially if the query is meant to write to the database.

Some known limitations include:

* Incorrect relationship direction.
* Using deprecated Cypher syntax.
* Tendency to not return relationships.




14 changes: 12 additions & 2 deletions modules/ROOT/pages/visual-tour/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,21 @@ Opening a project card takes you inside that project, where you can view existin

The organization or project you're currently viewing is always displayed in the header of the console.

To switch between different organisations or projects, click on its name.
This opens a dropdown menu where you can see all the organisations and projects you have access to and select the one you want to switch to.
To switch between different organizations or projects, click on its name.
This opens a dropdown menu where you can see all the organizations and projects you have access to and select the one you want to switch to.

image::breadcrumbs.png[]

[[org-settings]]
=== Organization settings

On the organization level, you can also find a Settings menu where you can manage your organization's settings, provided that you are an organization admin.
You can change the name of the organization and toggle an organization-wide setting for co-pilots.
Co-pilots are available in Query and Explore and use Generative AI to help you write queries and generate search patterns.
See xref:query/visual-tour.adoc#copilot[Query co-pilot] and xref:explore/explore-visual-tour/search-bar.adoc#copilot[Explore co-pilot] for more information.

image::enable-copilot.png[]

== Data Services

This section contains your instances and the Import service.
Expand Down