Getting Familiar with the UI

Introduction

This guide provides an overview of Codd AI's user interface and its main components. Understanding the navigation and key features will help you effectively utilize the platform's capabilities.

Tip: Start with the demo environment to familiarize yourself with the interface before creating your own workspace.

Onboarding & Demo

When you first access Codd AI, you'll see the onboarding page with helpful resources to get started:

Welcome Screen Features

  • Introduction Video: Watch a quick overview of Codd AI's capabilities
  • Try Demo Button: Instantly access a pre-configured retail sales environment
  • Demo Data: Explore real data with 25+ pre-built metrics
  • Navigation Options: Quick links to explore the demo workspace and its knowledge

Recommended: Click "Try Demo" to immediately start exploring Codd AI with sample data.

Brain Selector

How to access: Click on the brain name (e.g., "Codd Demo") in the top right corner next to your profile icon to open the brain selector dropdown.

The Brain is your workspace in Codd AI. You can switch between different brains to organize specific domains or business areas:

Your Brain

Your personal workspace for creating and managing data models and metrics. You can rename it in settings.

  • Create data models
  • Upload your own knowledge
  • Connect your databases

Codd Demo Brain

Pre-configured demo environment with retail sales data for learning and exploration.

  • Retail sales data model
  • Sample business knowledge
  • 25+ ready-to-use metrics

Database Integrations

How to access: Click the backstage icon () in the top right → Integrations, or click "Add Integration" when creating technical knowledge.

Connect your databases to create technical knowledge:

Supported Databases

Creating an Integration:

  1. Navigate to Integrations or click "Add Integration" when creating technical knowledge
  2. Select your database type
  3. Enter connection details (host, port, credentials)
  4. Test the connection
  5. Save for use in technical knowledge
View Integration Guides

Knowledge Management

How to access: Click "Knowledge" in the top navigation bar. Then click "Add Knowledge Cell" button to create new business or technical knowledge.

Knowledge is the foundation for building your data model and generating metrics. There are two types you need to create:

Business Knowledge

Upload documents or connect to REST APIs containing business context:

  • Business glossaries
  • KPI definitions
  • Synonym references
  • Business rules
  • REST API integration for pulling knowledge from external systems (e.g., data catalogs, documentation sites)
Create First: Always add business knowledge before technical knowledge

Technical Knowledge

Connect to databases and select tables:

  • Database connections
  • Table selection
  • Facts & dimensions
  • Schema metadata
Integration Required: Create database integration first
Learn more about Knowledge Creation

Corpus Board

How to access: Click "Corpus" in the top navigation bar to see the Corpus Board. You can also use the "Switch Corpus" option to view other corpus boards.

The Corpus Board is your control center for managing data models and knowledge:

Board Features

Knowledge Cells

View all knowledge cells (business and technical) that power your workspace.

  • Document summaries
  • Database connections
  • Knowledge relationships

Data Model

Review AI-generated relationships between your data entities.

  • Primary/Foreign keys
  • Cardinality
  • Confidence scores

Metrics

Browse and execute pre-generated business metrics.

  • 25+ auto-generated KPIs
  • Dimensions & measures
  • SQL definitions

Actions

Manage your workspace with these actions:

  • Update knowledge
  • Lock/unlock data model
  • Regenerate metrics
Learn more about Corpus Management

Data Model

How to access: From the Corpus Board, the Data Model section is displayed in the middle card. Click on the table entities or "Edit" button to interact with the data model.

After creating knowledge, Codd AI automatically generates a data model showing relationships between your entities:

Data Model Features

Visual Representation

Interactive graph showing all entities and their relationships:

  • Entity nodes with table names
  • Relationship lines showing connections
  • Cardinality indicators (1:1, 1:N, N:N)
  • Click entities to view details

AI-Generated Relationships

The AI analyzes your knowledge to identify:

  • Primary keys for each table
  • Foreign key relationships
  • Confidence scores for each relationship
  • Fact and dimension classifications

Review and Refinement

  • Review: Examine AI-identified relationships
  • Provide Feedback: Correct any misidentified relationships
  • Lock Model: Finalize when satisfied to enable metric generation
  • Regenerate: Request AI to refine based on feedback

Important: The data model must be locked before metrics can be generated. This ensures consistent relationships across all analytics.

Learn more about Data Models

Metrics View

How to access: From the Corpus Board, the Metrics section is displayed in the right card. Click "Review" button to see all metrics in detail.

The Metrics view shows all AI-generated KPIs for your workspace:

Metrics Interface

Metric List

View all 25+ auto-generated metrics with:

  • Metric name and description
  • Dimensions (grouping fields)
  • Measures (calculations)
  • Database entities used

Metric Actions

  • View SQL: See the generated SQL query
  • Execute: Run the metric to see results
  • Modify: Edit SQL or ask AI to adjust
  • Export: Download results for analysis
Learn more about Metrics

Canvas Interface

How to access: Click "Canvas" in the top navigation bar, or click "Start Conversation" button from the Corpus Board.

Canvas is where you interact with your data through natural language conversations:

Canvas Components

Query Input

Type questions in natural language like "Show me gross margin by product" or "What's the average sales by category?"

Results Display

View data results in tables and charts with AI-generated insights about your query.

SQL Viewer

Click to see the generated SQL query. You can modify it directly or ask AI to help adjust it.

Follow-up Questions

AI suggests relevant follow-up questions to continue your analysis journey.

Learn more about Canvas

Settings & Profile

How to access: Click on your profile icon (initials) in the top right corner, then select Settings from the dropdown menu.

Access settings and support options from the profile menu:

Settings Options

  • Profile: Your account information
  • Organization: Team settings
  • Brain: Rename your workspace
  • Config: Platform preferences
  • Agent Config: AI settings
Learn more about Settings