You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/aura-agent.adoc
+44-1Lines changed: 44 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ The more detailed you are in the description and prompt instructions, the better
30
30
Then you need to specify which AuraDB instance the agent should target.
31
31
Keep in mind that the selected instance *must* be running.
32
32
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.
34
34
You can change the agent's availability at any time.
35
35
36
36
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.
39
39
40
40
== Tools
41
41
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.
0 commit comments