User Documentation

A comprehensive guide to securely connecting, analyzing, and conversing with your data without compromising governance.

1. Getting Started

Welcome to Dataface.ai. Follow these steps to set up your account and begin analyzing data.

Sign Up & Login

Navigate to the Registration page to create an account. You can sign up using your email and password, or use Google OAuth for single sign-on (SSO). Once registered, you can Log In at any time from the top right of the landing page.

Subscription & Pricing

Dataface operates on a freemium model. Upon signing up, you are placed on a free tier which includes a set amount of credits for query generation.
To upgrade your limits or access advanced features:

  • Navigate to the Settings or Credits page from your Dashboard sidebar.
  • Review the available plans (Professional, Enterprise).
  • Click Subscribe to securely process payment via Stripe. Your account limits will instantly update upon successful payment.

2. Managing Connections

Dataface.ai supports zero-data-movement analytics by connecting directly to your existing databases and APIs.

Connecting a Database

From the Dashboard, click Connect Datasource. You will need standard read-only credentials:

  • Host/URL: The server address
  • Port: (e.g., 5432 for Postgres)
  • Database Name
  • Username & Password
Security Best Practice: We highly recommend creating a dedicated database user with READ ONLY permissions strictly limited to the tables you wish to analyze.

Connecting an API

You can also connect REST APIs to converse with external data streams.

  • Select API Source during creation.
  • Provide the base URL and necessary authentication headers (Bearer tokens, API keys).
  • Define the endpoints you wish the agent to access.

Connection Status & Deletion

Your connected sources appear as cards on the Dashboard.

  • Status Indicators: A green dot indicates a healthy connection. If credentials expire or the host becomes unreachable, the status will turn red.
  • Delete Database: Click the trash/delete icon on any datasource card to instantly remove it. This deletes all cached metadata, schema information, and connection credentials from our systems permanently.

3. Metadata & Schema

When you connect a datasource, Dataface runs an automated background extraction to read your Schema (table names, column names, data types). It does not extract the underlying row data.

Viewing Extracted Metadata

You can review what the AI "knows" about your database to ensure accuracy:

  1. Locate the datasource card on your Dashboard.
  2. Click the Metadata / Schema button (often represented by an info or table icon).
  3. A popover or modal will display the synchronized tables and columns.

If you add new tables to your database, simply click the Refresh Metadata button on the card to sync the latest structure to the AI agent.

4. Conversational Chat Interface

The Chat interface is the core of Dataface.ai. You can access it by clicking the floating chat button on the bottom right of the screen, or by directly entering the /chat route.

Global Chat vs. Specific Chat

Global Chat

If you open the chat without selecting a datasource, the AI acts globally. You can ask "What databases do I have?" or perform platform operations. If you ask an analytical question, the AI will try to determine which of your databases contains the relevant data.

Datasource-Specific Chat

Clicking "Chat" directly on a datasource card instantly opens a conversation specifically targeted at that database. The AI will only query the selected schema.

Context Locking

In the chat input box, you will notice a Database Icon. Clicking this opens the Context Linker.

  • Locking Context: When the lock icon is engaged (amber/locked state), the AI is strictly confined to querying the selected databases. It will not hallucinate or attempt to query external sources.
  • Adding Context: You can link multiple databases into a single chat session by clicking "Link More" in the context menu.

5. Data Privacy vs. AI Analysis Toggling

You have granular control over how your data interacts with Large Language Models (LLMs). Next to the send button in the chat input, you will find the Analysis Toggle.

Strict Privacy Mode

Default

Indicated by a grey shield icon. Designed for highly sensitive financial, healthcare, or proprietary data.

  • Only schema is shared with the LLM to generate the SQL query.
  • Actual data rows are NEVER sent to the AI. Results are fetched locally.

AI Analysis Mode

Opt-In

Indicated by a purple sparkles icon. Designed for deep insights and strategic recommendations.

  • A summarized sample of the result set is securely sent to the LLM.
  • AI generates a written executive summary and smart follow-up suggestions.

Execution Trace Transparency

To maintain complete transparency, you can view exactly what operations the AI performed on your database. Under any data response, click the </> SQL Query button to reveal the exact native query that was executed on your system.

API Documentation (Coming Soon)

Dataface is built on a highly extensible, API-first architecture. In the near future, we will release comprehensive Developer Documentation detailing how to programmatically interact with our semantic routing engine, manage connections via CI/CD, and embed conversational analytics directly into your own applications.