Aura agent

modules/ROOT/content-nav.adoc

@@ -9,8 +9,6 @@ Generic Start
 ** xref:microsoft-fabric.adoc[Workload for Microsoft Fabric]
 ** xref:visual-tour/index.adoc[Visual tour]
 
-* xref:graph-analytics/index.adoc[]
-
 * Quick start
 ** xref:getting-started/create-account.adoc[Create an account]
 ** xref:getting-started/create-instance.adoc[Create an instance]
@@ -44,6 +42,10 @@ Generic Start
 ** xref:import/indexes-and-constraints.adoc[Indexes and constraints]
 ** xref:import/import.adoc[Run the import]
 
+* xref:graph-analytics/index.adoc[]
+
+* xref:aura-agent.adoc[Aura agent]
+
 
 * Explore data
 ** xref:explore/introduction.adoc[What is Explore?]

modules/ROOT/pages/aura-agent.adoc

@@ -0,0 +1,91 @@
+[[aura-agent]]
+= Aura Agent
+:description: This page describes the creation and capabilities of Aura GraphRAG Agent.
+
+label:AuraDB-Free[]
+label:AuraDB-Professional[]
+label:AuraDB-Business-Critical[]
+
+Aura Agent is a no/low-code agent-creation platform that allows you to build, test, and deploy GraphRAG agents contextualized by your own knowledge graph in AuraDB.
+
+Aura takes care of the orchestration layer as well as the integration with GenAI model/LLMs and provides different iterative tools that allows your agent to provide the right context to the LLM.
+
+You can test the agent and iterate on it directly in the UI.
+
+Once you are satisfied with your agent, you can either share it internally with other members of your Aura project, or you can make it available externally via an Aura API endpoint and thus integrate it into your system.
+
+To get started you need a knowledge graph in a running AuraDB instance and you need to enable *Generative AI assistance* in the xref:visual-tour/index.adoc#org-settings[Organization settings].
+
+== Creating an Agent
+
+Navigate to *Agents* in the left-hand menu and use the *Create* button to start creating your agent.
+
+[.shadow]
+.Create an Agent
+image::agent.jpg[width=300]
+
+You need to give the agent a name (it is advisable to use a descriptive name), a description, and prompt instructions.
+The more detailed you are in the description and prompt instructions, the better your agent will operate.
+
+Then you need to specify which AuraDB instance the agent should target.
+Keep in mind that the selected instance *must* be running.
+
+You can make the agent externally available right away, but it is recommended to keep it internal while testing it.
+You can change the agent's availability at any time.
+
+Then you can start adding the tools that will allow your agent to retrieve specific data from your graph, or to convert questions to Cypher queries.
+Keep in mind that currently the agent only supports *read only* queries against the database.
+The tools are described in detail in the following section.
+
+== Tools
+
+Aura Agent has three tools available:
+
+* *Cypher Template*
+* *Text2Cypher*
+* *Similarity Search*
+
+Consider your dataset and its underlying datamodel when you configure the tools to ensure your agent has access to the right ways of retrieving *only* the right information.
+
+=== Cypher Template
+
+This tool executes pre-defined, parameterized Cypher queries against the database and returns the results to the agent.
+The values for the parameters are provided by the user.
+It works in the same way as other Cypher queries you write but are reusable by the agent.
+
+This tool is best for:
+
+* Common and repeated questions
+* Predictable results
+* Complex queries
+* Well-defined business logic patterns
+
+You need to provide a *name* and a *description* for the tool.
+Again, the better the description, the better your agent will perform.
+If your query contains *parameters*, these need to be defined with a *name*, *data type*, and *description*.
+
+[.shadow]
+.Cypher Template tool
+image::cypher-template.jpg[width=400]
+
+For best performance, make sure that the query:
+
+* returns only relevant information
+* returns only select node and relationship properties
+* does not return embeddings or graph elements like node/relationship/paths
+* does not return duplicates
+
+Additionally, it is advisable to limit the results to 10-50 rows to keep the results relevant.
+Also, always test the Cypher statement to make sure they work as expected.
+
+
+
+
+
+
+
+
+
+
+
+

package.json

@@ -24,6 +24,7 @@
   },
   "homepage": "https://github.com/neo-technology/aura-documentation#readme",
   "dependencies": {
+    "@antora/site-generator": "^3.1.14",
     "@neo4j-antora/antora-add-notes": "^0.3.1",
     "@neo4j-antora/antora-modify-sitemaps": "^0.4.4",
     "@neo4j-antora/antora-table-footnotes": "^0.3.2",