Skip to content

05 Reference

Glossary

The terms used across Dimension Labs and these docs, with the names you see in the app.

Names in bold are the names you see in the app.

TermMeaning
ConversationThe unit of data Dimension Labs reads: one chat, ticket, call, review or survey response, with every message in it. All the messages of one conversation share a sessionId.
Conversation dataText a person wrote or said: chats, calls, tickets, reviews, survey answers. It goes under Unstructured data and is enriched into Dimensions.
Business dataRows and columns such as revenue, orders or accounts. It goes under Structured data, is queryable within about a minute of upload, and is never enriched. It comes in by file upload only today; an API for it is on the roadmap.
Data SourcesThe page in the app where your data comes in. It has two panels: Unstructured data and Structured data.
Unstructured dataThe panel in Data Sources for conversation data: your integrations and your conversation file uploads.
Structured dataThe panel in Data Sources for business data tables.
SourceOne item in Data Sources: an integration or an upload under Unstructured data, or a table under Structured data.
Live integrationA source that sends conversations as they happen: a one-click integration, or a universal API job sending to /track. It is enriched automatically every day.
MetadataThe extra columns that come with your conversations, such as rating, store, plan or channel. Stored in structured_metadata.
SessionThe grouping set by sessionId: every message with the same sessionId belongs to one conversation.
sessionIdRequired. The id that groups messages into one conversation.
userIdRequired. The end user’s id, on their messages and on the bot’s or agent’s replies to them. If you don’t have one, copy the sessionId into it. Never an email address, phone number or name.
incomingRequired. true for a message from the customer or end user, false for a message from your agent, bot or company.
textRequired. The words of one message.
dimensionlabs_timestampRequired. When the message was sent, as a 13-digit Unix time in milliseconds. Messages in one session need to be at least 1 second (1,000 ms) apart.
conversationIdRecommended. Keeps one conversation together across a handoff, for example from a bot to a human agent.
intentOptional, and only for an intent-based chatbot. An object: { "name": "TRACK_ORDER", "confidence": 0.94 }.
platformJsonAn optional nested object of extra fields sent with a message. Never put personal information in it.
partition_keyThe platform’s key for one conversation, used to join tables. Spelled partition_key in Dimension tables and PARTITION_KEY in structured_metadata.
transcriptsThe table holding every message, one row per message.
structured_metadataThe table holding the metadata you sent with your conversations, one row per conversation.
TermMeaning
DimensionOne typed field extracted from each conversation: a category, a yes or no, a score, or a verbatim quote.
PromptThe configuration that defines a set of Dimensions, with its instructions. Each prompt writes its own table.
Standard DimensionsThe general Dimensions every workspace has available, such as sentiment and contact reason. Called System Prompts in the app. They run every day only when Dimension Labs turns on daily enrichment for your workspace (ask support); otherwise, run a backfill.
System PromptsThe app’s name for the standard Dimensions. Their results are in the system_session_prompt table.
system_session_promptThe table that holds the standard Dimensions, one row per enriched conversation.
Custom DimensionsDimensions you design for your business, in your own prompts.
VerbatimA Dimension that quotes the customer’s exact words behind a label, so the label can be checked.
none_detectedThe value a Dimension returns when the model read the conversation and found nothing for that field. Different from an empty value, which means nothing was returned.
EnrichmentRunning prompts over conversations to write their Dimensions.
BackfillA run that applies a prompt to conversations you already have. Needed for a file upload and for anything sent to /trackhistorical. Start it from the Backfill tab. It typically shows up within the hour, depending on how much data is being enriched.
Backfill tabThe tab in the app where you start a backfill.
Prompts tabThe tab in the app that lists every prompt in your workspace.
Prompt DesignerA setting in the agent. Turn it on in the agent’s settings to design and save prompts with the agent.
Meaning layerThe whole structure the agent works on: your original conversations, the Dimensions extracted from each one, and your business data, in one schema you can query together.
TermMeaning
AgentThe analytics agent you talk to in plain English. It reads your tables, runs queries and statistics, and builds outputs.
ChatOne conversation with the agent. Your past chats are listed in the left rail.
ProjectA workspace for a piece of work: its files, its standing instructions (AGENTS.md) and its chats.
AGENTS.mdA file at the top of a project that the agent reads as a standing instruction in every chat of that project.
Analysis planA written research plan the agent drafts with you: the question, the data, the steps and the shape of the output. Saved as a file so it can be run again on new data.
File ManagerThe agent’s view of your project’s files. It has the button that saves a file as an artifact.
Final ReportsThe folder in a project where the agent saves finished deliverables.
ArtifactsPublished reports, dashboards and decks. Publishing gives a file a link anyone can open, and you can revoke the link. Publish from the File Manager or the Artifacts page.
TermMeaning
Universal APIThe API that receives conversation messages from any system, at tracker.dimensionlabs.io. Also called the tracker. See Universal API.
/trackThe universal API endpoint for new messages, sent as they happen. Enriched automatically every day.
/trackhistoricalThe universal API endpoint for older messages. Use it for anything older than an hour, then run a backfill.
Export APIThe API that returns your enrichments as a zip file, by day. Filter by integration ID and date range. Its key is in Settings. See Export API.
SettingsWhere you find your Export API keys.
User managementThe page where you invite users and see who has accepted.