Skip to content

README.md

Latest commit

 

History

History
166 lines (112 loc) · 3.51 KB

README.md

File metadata and controls

166 lines (112 loc) · 3.51 KB
Raw

Chat Demo

demo/chat_v2 is the browser-based DeepAnalyze demo. It includes the backend API, the workspace/file layer, the frontend UI, and both local and Docker execution modes.

Chinese Version

Features

  • Upload and manage tables, databases, text files, logs, and documents in the workspace
  • Preview common workspace files directly in the UI
  • Stream structured <Analyze> / <Understand> / <Code> / <Execute> / <File> / <Answer> blocks
  • Execute Python analysis code inside the workspace
  • Export Markdown and PDF reports
  • Switch between Chinese and English UI
  • Run code either locally or inside Docker
  • Choose model provider: Local, HeyWhale API, or Custom OpenAI-compatible API

Model Provider Settings

In the left configuration panel:

  • Local: uses your local DeepAnalyze-compatible endpoint.
  • HeyWhale API: requires API Key; API base uses the built-in HeyWhale endpoint by default.
  • Custom Model: requires your own Model Name and API Base; API Key is optional.

When provider is Custom Model, the frontend automatically prepends a structured data-analysis system prefix:

  • English UI => English prefix
  • Chinese UI => Chinese prefix

For local or HeyWhale DeepAnalyze usage, this extra prefix is not injected.

Prerequisites

1. Model service

Start a DeepAnalyze model service first, for example:

vllm serve DeepAnalyze-8B

By default the chat demo connects to an OpenAI-compatible endpoint around http://localhost:8000.

2. Python and Node.js

Recommended setup:

  • Python: use your existing DeepAnalyze environment, for example deepanalyze
  • Node.js: use a version that can run the bundled Next.js frontend

Install frontend dependencies once:

cd demo/chat_v2/frontend
npm install
cd ..

3. Environment variables

Use the sample config file:

cd demo/chat_v2
cp .env.example .env

Windows:

cd demo/chat_v2
Copy-Item .env.example .env

Execution Modes

Local mode

Recommended as the default if the local machine already has the required Python data-analysis dependencies.

DEEPANALYZE_EXECUTION_MODE=local

Docker mode

Use this if you want an isolated execution environment.

DEEPANALYZE_EXECUTION_MODE=docker

Important:

  • The system does not auto-build the Docker image
  • If the target machine has no image, Docker execution will fail immediately
  • You must build the image manually first

Example:

cd demo/chat_v2
docker build -t deepanalyze-chat-exec:latest -f Dockerfile.exec .

Run

Linux / macOS

cd demo/chat_v2
bash start.sh

Stop:

cd demo/chat_v2
bash stop.sh

Windows

cd demo\chat
start.bat

Stop:

cd demo\chat
stop.bat

Default addresses after startup:

  • Frontend: http://localhost:4000
  • Backend API: http://localhost:8200
  • File service: http://localhost:8100

PDF Export

PDF export depends on:

  • pypandoc
  • pandoc
  • xelatex

Behavior details:

  • If pandoc is missing, the backend will try to auto-download it (enabled by default).
  • xelatex is still required and must be installed manually.
  • You can control this with:
    • DEEPANALYZE_PDF_AUTO_DOWNLOAD_PANDOC (true by default)
    • DEEPANALYZE_PDF_PANDOC_CACHE_DIR (optional pandoc cache path)

Directory Overview

  • backend.py: backend startup entry
  • backend_app/: FastAPI backend implementation
  • frontend/: Next.js frontend
  • Dockerfile.exec: Docker image for code execution
  • workspace/: per-session workspace
  • logs/: runtime logs