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: cloud/modules/ROOT/pages/spotter-model.adoc
+15-3Lines changed: 15 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,10 +105,22 @@ Unless required for performance, we suggest avoiding having such columns and rel
105
105
106
106
107
107
Adding clear and concise column descriptions improves Spotter’s accuracy by helping it interpret the column’s meaning, values, and intended use in queries.
108
+
They serve as human-readable explanations helping end-users understand what each column represents.
108
109
110
+
We recommend the following workflow:
111
+
112
+
. Write clear, user-focused column descriptions.
113
+
. Generate AI Context. This feature uses your descriptions, column names, and values.
114
+
. Review and refine the AI Context with AI-specific instructions.
115
+
116
+
Column descriptions versus AI Context:: Column descriptions are written for end users. They answer questions about what the data represents. Spotter uses column descriptions to understand basic column meaning when AI Context is absent.
117
+
+
118
+
AI Context is for the AI. It provides permanent instruction to Spotter. Use AI Context for advanced logic, business rules, column prioritization, or special value interpretation.
119
+
120
+
Focus on end users:: Write column descriptions for someone unfamiliar with your data model.
109
121
110
122
Provide meaningful descriptions to improve query interpretation::
111
-
Include a brief but informative description to clarify what the column represents. This helps Spotter generate more accurate responses.
123
+
Include a brief but informative column description to clarify what the column represents. This helps Spotter generate more accurate responses.
112
124
Example;; A column labeled "ACV" can have the description:
113
125
"Annual Contract Value, representing total revenue from contracts over a year."
114
126
This ensures Spotter correctly interprets queries related to revenue and ACV.
@@ -130,8 +142,8 @@ Example;; A column with Boolean values can have the description:
130
142
This prevents misinterpretation of TRUE/FALSE values in queries.
0 commit comments