Vendventory Documentation
v1.0.0 Changelog

Copilot Module

The Copilot module is a global, read-only assistant built inside the admin shell. In simple words, it is a side panel that helps the user understand what the current dashboard or report means without changing any business data. It reads the current analytical screen, collects the most important facts, and then returns an explanation in plain language.

Very simple explanation: Copilot is like a smart analyst standing beside the user. It does not run the business for the user. It explains the numbers that are already visible in the application.

Overview

Copilot works as a right-side slide-over panel that can be opened from the top navigation bar. Once opened, it asks one main question: "Which page is the user on right now?" After that, it prepares a structured summary of the current screen before generating an answer.

This means Copilot does not behave like a free-form robot with access to the whole internet or direct database control. It only talks about the facts that were already prepared by the application from dashboard and report data.

What Copilot is
A read-only analytical assistant for dashboard and report understanding.
What Copilot is not
It is not an auto-pilot, not a record editor, and not a direct database querying console.

Where It Works

Copilot is page-aware. That means it gives different answers depending on where the user opens it. The panel currently understands the following contexts:

Supported Screens
  • Dashboard: overall command-center explanation.
  • Executive Summary: management-level risk and attention overview.
  • Inventory Valuation: product economics, stock value, profit, and loss signals.
  • Inventory Valuation Detail: one-product deep analysis including batches and movements.
  • Purchase Cost Intelligence: purchase spend, cost averages, and variance patterns.
  • Supplier Spend & Dependency: supplier concentration and spend mix analysis.
  • Expiry & Batch Risk: expiry pressure and value-at-risk explanation.
  • Loss & Stock-Out Reasons: leakage and reason analysis.
  • Stock Movement Summary: inflow, outflow, and balance interpretation.
  • Adjustment Variance: stock correction and variance interpretation.
Fallback behavior: If Copilot is opened on a screen that is not yet supported, it falls back to a broader global inventory summary instead of failing.

How Copilot Understands the Current Page

Copilot does not read the screen the way a human reads a screenshot. Instead, the application creates a structured context packet for it.

What is inside the context packet
  • Screen name: which page the user is on.
  • Context label: a plain-language title such as Dashboard or Supplier Spend.
  • Facts: short business statements prepared from the current analytics.
  • KPIs: headline metrics from the current screen.
  • Top rows: the most important evidence rows that the answer is allowed to reference.
  • Suggested questions: prompt ideas relevant to that specific page.
  • Source links: direct links back to the pages or records behind the answer.

This is a very important design decision. It keeps Copilot focused, safer, and easier to trust. Instead of inventing answers from hidden data, it only explains curated facts already collected by the application.

Hybrid AI Mode vs Analytics-Only Mode

Copilot supports two runtime modes so the feature remains useful even when an AI API key has not been configured.

Hybrid AI Mode
  • The application first prepares structured business facts.
  • An AI provider then turns those facts into natural language explanation.
  • This mode is best when the user wants more human-like summaries and follow-up questions.
Analytics-Only Mode
  • No provider call is made when AI is disabled or the API key is missing.
  • Copilot still works using deterministic summaries from the same facts.
  • This prevents the side panel from feeling broken during first setup or on low-connectivity environments.
In practical terms: Even without an API key, the user can still ask questions and get useful, data-backed summaries. The difference is that the answer will sound more rule-based and less conversational.

Opening Copilot

How the user opens it
  1. Login to the admin panel.
  2. Open the dashboard or any supported report page.
  3. Click the AI Copilot button in the top navigation bar.
  4. The right-side slide-over panel appears.
  5. Read the suggested questions or type a custom question.

Suggested Questions

Copilot does not show the same starter prompts on every page. It generates suggestions based on the current screen. This makes the feature easier for non-technical users.

Example question types
  • Dashboard: What needs attention first right now?
  • Inventory Valuation: Which products are locking too much capital?
  • Product Detail: Why is this product underperforming?
  • Supplier Spend: Is supplier concentration becoming risky?
  • Expiry Risk: Which products are the biggest expiry pressure right now?
  • Loss Reasons: Which loss reason is costing the most?

Source Cards and Trust

A good analytical assistant should not only answer. It should also show where the answer came from. Copilot does this using source cards and source links.

Why source cards matter
  • They show which report or drill-down the answer is based on.
  • They reduce blind trust by giving the user a path back to the evidence.
  • They help buyers understand that the feature is analytical, not magical.

Permissions

Copilot is not automatically available to every user. Access is controlled by permissions.

Main permission rules
  • Use Analytics Copilot: required to open the panel and ask questions.
  • Screen permissions still matter: if the user cannot access a report, Copilot should not be treated as a backdoor for that report.
  • Export Reports: separate permission used for downloading analytical exports.

Settings and AI Provider

Copilot can be configured from the Settings module. This lets the application owner choose whether AI explanation is enabled and which provider details are used.

Key settings explained in plain language
  • Enabled: turns the provider-backed AI explanation layer on or off.
  • Driver: tells the application which provider type to use.
  • Base URL: the provider endpoint address.
  • API Key: the secret credential required for hybrid AI mode.
  • Model: the specific AI model name used for answer generation.
  • Temperature: controls how strict or creative the language style feels.
  • Test Saved Runtime: checks whether the saved provider configuration is working.

Failure Behavior

Copilot is designed to fail gracefully. If the provider is disabled, the key is missing, or the provider request does not succeed, the user still receives a deterministic summary instead of a blank error-heavy panel.

Important limitation: Copilot is read-only. It does not create purchases, edit products, send alerts, run SQL, or perform automatic stock corrections.

Example User Flow

Simple real-world scenario
  1. The manager opens the Dashboard.
  2. The manager opens Copilot and asks, "What needs attention first?"
  3. Copilot reads dashboard KPI cards, critical product rows, and recent risk signals.
  4. It answers with a short explanation such as expiry pressure, leakage, or supplier concentration.
  5. It returns follow-up questions and source links so the manager can drill deeper.
  6. If the manager moves to Supplier Spend and asks again, the answer becomes supplier-specific instead of dashboard-wide.

Practical Notes

  • Copilot is strongest when report data is already clean and current.
  • It should be marketed as a decision-support layer, not an autonomous operations engine.
  • Its value comes from combining existing analytics with quick explanation and guided follow-up.
  • Because chat is saved locally in the browser, recent conversation can survive page navigation without a dedicated database table.