AI Guide inspector
The AI Guide is the database-understanding layer used by Speak To Your Database. The inspector inside AI Guide lets you review, edit, and control how that understanding maps to your database schema.
What the AI Guide Inspector is for
After you run the analyzer with Analyze data, the inspector shows the generated schema documentation for connections, tables, and columns.
What STYD already understands
Selecting a connection shows a What STYD already understandscard, with What STYD discovered here: the tables and columns analyzed, the kinds of tables found and the kinds of information found. It is made automatically and shown for information only.
Left tree selection
The left panel contains the AI Guide tree. Selecting an item updates the inspector on the right.
Shows high-level information for the selected database connection.
Shows the table's description, its review status, and its visibility.
Shows the column's description, its type, sample values, and flags.
Shows a placeholder until a connection, table, or column is selected.
Table inspector
When you select a table, Speak To Your Database displays information about how that table is understood by AI Guide.
The database table currently selected.
One box: the AI's explanation of what the table represents, which owners and admins can correct. Saving your own text marks it Confirmed, and STYD then follows it as a rule.
AI draft, Draft, or Confirmed, shown next to the table name.
Owners and admins can hide the table from chosen members.
Column inspector
When you select a column, the inspector shows the metadata Speak To Your Database uses to understand that column.
The selected database column.
AI-drafted or user-edited explanation of what the column means, first in the inspector, with the same review status as a table.
The detected database type, such as text, integer, date, or boolean.
Example values found in the column when available.
Indicates whether the column may contain personal information. Set by the analysis; owners and admins can change it.
Indicates whether the column appears to contain URLs. Set by the analysis; owners and admins can change it.
Owners and admins can mark a column that flags deleted, archived, or inactive rows.
Table visibility
AI Guide can also show table visibility controls. These controls help decide which tables are available to specific users.
Tables that Speak To Your Database can use when answering questions.
Tables excluded from AI query planning for selected users or workspace rules.
Some workspaces can hide sensitive tables from specific members.
Who can edit AI Guide?
AI Guide permissions depend on the user role inside the workspace.
Can view and edit AI Guide descriptions, flags, and visibility settings.
Can view and edit AI Guide descriptions, flags, and visibility settings.
Can view AI Guide information but cannot edit AI Guide settings.
Cannot open Settings, so cannot open the AI Guide.
Why editing descriptions matters
AI-drafted descriptions are useful, but users often know the business meaning better than the database schema alone.
Best practices
Start with the tables most often used for reporting and operations.
Add descriptions for columns with unclear names or internal abbreviations.
If new columns are added, run the AI Guide analysis again so Speak To Your Database can detect and document them. Running the analysis again costs prompts, about 1 for every 500 columns (at least 1), and the price is shown before you confirm.
Use visibility controls to reduce access to tables that should not be used by everyone.