What the AI Guide is
The AI Guide is the database-understanding layer used by Speak To Your Database. AI Guide is the product's understanding of your connected database, its tables, columns, relationships, and business meaning.
What it is
When you connect a database, the analyzer (the Analyze databutton) scans its structure and builds a layer of descriptions and metadata on top of it: what each table and column appears to represent, and how they relate. This understanding is what Speak To Your Database draws on when it answers a question.
What it is not
- It is not the database itself, it is a description layer that helps Speak To Your Database interpret your data.
- It does not replace database permissions. What Speak To Your Database can read is still controlled by the database user and your access rules.
Odoo and uploaded files
An Odoo connection has an AI Guide of its own: it is built from what Odoo describes about its own data (models, fields and relations), read-only, and it has no Analyze data button. It is rebuilt when you re-sync the connection. The Uploaded files connection is described when you upload your spreadsheets; add, replace or delete files in Settings → Documents.
Where to review it
You can review and refine AI Guide under Settings → AI Guide. The inspector is organised as Connections → Tables → Columns. Owners and admins can edit descriptions; members can read them.
From analyzer to better answers
AI Guide is one step in a larger chain:
Running Analyze data reads the database structure, tables, columns, types, and sample values. The first analysis of a database can be included; after that, an analysis costs prompts and shows its price first (see Run the AI Guide analysis).
The AI writes a description for each table and each column. To do so, STYD sends the AI provider the table and column names, their types and example values; columns flagged as email addresses, phone numbers or secrets, or that look like secrets, are sent without example values. The analysis also flags columns that hold personal information or URLs.
Under Settings → AI Guide, owners and admins read each description and correct it where needed.
Saving your own text marks the description Confirmed, and STYD then follows it as a rule in its answers. Your texts are kept when the analysis runs again.