Your data uses your words. “Revenue” might mean orders before refunds, a “session” might end after 30
minutes, and a column called src might be where the visitor came from. Crunch can guess, but a guess
can be wrong. A semantic note is a short document where you say what things mean, and Crunch reads it
whenever it uses that dataset, workspace or connection.
What you’ll need
- A dataset, workspace or connection to write about.
- To write about a workspace or a connection, make it first. See Workspaces.
Write a note
Notes live on a workspace page, in its Semantic notes section. Each note is about one thing: the workspace as a whole, one of its datasets, or one of its connections.
- Open the workspace and find Semantic notes.
- Under Note on, choose what the note is about: This workspace, a dataset, or a connection.
- Click Write for a blank document, or Draft from this to have Crunch draft it from the dataset or API first. Draft from this isn’t offered for the workspace itself, only for a dataset or an API.
- The note opens as a document with Crunch beside it. Say what a row is, what each column holds, how you define your terms, and anything people often get wrong, and let Crunch tighten the wording.
You can edit the document the way you edit any other, and ask Crunch to change it as you go.
Write one from a chat
Attach exactly one dataset to a chat, then type /notes. Crunch drafts a note on that dataset (what a
row is, each column, terms and caveats) and opens it. If you have none or several attached, it says
“Attach the one dataset to write notes on, then /notes.” See
The + and / menus.
Keep a meaning from an answer
When Crunch reads one of your words in a particular way, the answer shows a line like “Read revenue as net of refunds”. Next to it, Keep as a note saves that meaning, so Crunch reads your word the same way in later chats. After it’s saved, the line says “Kept” with a link to Notes. Where Crunch used a note you wrote, the line says “from your notes”; where it guessed, it says so and asks you to say if you meant something else.
Manage your notes
On the workspace page, each note is listed with two buttons:
- Open opens the note with Crunch beside it, to read or change.
- Stop using makes Crunch stop reading it. The document stays in your docs, so nothing is lost.
Notes Crunch kept for you in earlier chats appear under Earlier notes, as plain text. Click Make it a doc to turn one into a document you can edit, or Remove to delete it.
How to tell it worked
The note appears in the workspace’s Semantic notes list. Ask a question that uses one of your terms and check the answer reads it the way you wrote it; the Read … as line says “from your notes”.
Good to know
- A note applies wherever its dataset, workspace or connection is in use in your chats.
- Keep notes short and concrete. “A row is one order line, not one order” helps more than a paragraph of background.
- Tip: if an answer keeps misreading a word, that’s the one to write down first.
Related
- Workspaces: where your notes live.
- Connections: write a note on what an API or database holds.
- Datasets: pick the data a note is about.