Skip to content

Commit 1dac907

Browse files
author
GitHub Action Sync Bot
committed
Update from source repository (workflow run: 19518670579) (PR #15561) (commit: 75c77fb980043e096b1a7d638be7fc6f0fd15ba8) (branch: 10.15.0.cl)
1 parent 2adc413 commit 1dac907

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

cloud/modules/ROOT/pages/spotter-model.adoc

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,22 @@ Unless required for performance, we suggest avoiding having such columns and rel
105105

106106

107107
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.
108109

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.
109121

110122
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.
112124
Example;; A column labeled "ACV" can have the description:
113125
"Annual Contract Value, representing total revenue from contracts over a year."
114126
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:
130142
This prevents misinterpretation of TRUE/FALSE values in queries.
131143

132144

133-
Keep descriptions concise (maximum 200 characters)::
134-
Spotter will only consider the first 200 characters of the description.
145+
Keep descriptions concise (maximum 400 characters)::
146+
Spotter considers up to 400 characters, but aim for around 200 characters for optimal AI Context generation.
135147
Ensure critical details are included within this limit for accurate interpretation.
136148

137149

0 commit comments

Comments
 (0)