Skip to content

Commit 254a657

Browse files
committed
more content and images
1 parent ba5a7c8 commit 254a657

File tree

4 files changed

+602
-277
lines changed

4 files changed

+602
-277
lines changed
63.3 KB
Loading

modules/ROOT/pages/aura-agent.adoc

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The more detailed you are in the description and prompt instructions, the better
3030
Then you need to specify which AuraDB instance the agent should target.
3131
Keep in mind that the selected instance *must* be running.
3232

33-
You can make the agen external right away, but it is recommended to keep it internal while testing it.
33+
You can make the agent externally available right away, but it is recommended to keep it internal while testing it.
3434
You can change the agent's availability at any time.
3535

3636
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.
@@ -39,6 +39,49 @@ The tools are described in detail in the following section.
3939

4040
== Tools
4141

42+
Aura Agent has three tools available:
43+
44+
* *Cypher Template*
45+
* *Text2Cypher*
46+
* *Similarity Search*
47+
48+
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.
49+
50+
=== Cypher Template
51+
52+
This tool executes pre-defined, parameterized Cypher queries against the database and returns the results to the agent.
53+
The values for the parameters are provided by the user.
54+
It works in the same way as other Cypher queries you write but are reusable by the agent.
55+
56+
This tool is best for:
57+
58+
* Common and repeated questions
59+
* Predictable results
60+
* Complex queries
61+
* Well-defined business logic patterns
62+
63+
You need to provide a *name* and a *description* for the tool.
64+
Again, the better the description, the better your agent will perform.
65+
If your query contains *parameters*, these need to be defined with a *name*, *data type*, and *description*.
66+
67+
[.shadow]
68+
.Cypher Template tool
69+
image::cypher-template.jpg[width=400]
70+
71+
For best performance, make sure that the query:
72+
73+
* returns only relevant information
74+
* returns only select node and relationship properties
75+
* does not return embeddings or graph elements like node/relationship/paths
76+
* does not return duplicates
77+
78+
Additionally, it is advisable to limit the results to 10-50 rows to keep the results relevant.
79+
Also, always test the Cypher statement to make sure they work as expected.
80+
81+
82+
83+
84+
4285

4386

4487

0 commit comments

Comments
 (0)