快速开始

提示

本教程要求使用者熟悉 docker/docker compose 的相关概念及使用方式。

本章节帮助你在最短时间内完成 Data Agent 的首次部署、数据接入与体验验证。按照以下步骤操作即可得到一个可回答基础问题的 Agent。

1. 环境准备

  • 安装 Docker 与 Docker Compose,确保可通过命令行正常运行(官网下载:https://www.docker.com/)。
  • 准备一个支持 Tool Calling 功能的非推理大模型 API 连接地址和 Key(如 OpenAI GPT-4o、Claude 3.5 Sonnet、DeepSeek V3 等)。
  • 准备一个 Embedding 模型的 API 连接地址和 Key(如 OpenAI text-embedding-3-small、阿里云 text-embedding-v3 等)。

2. 获取并启动服务

在任意目录下创建 docker-compose.yml(可放在独立目录中方便后续维护),根据网络环境选择下方"国外版"或"国内版":

警告

以下 docker-compose 文件的配置仅供开发测试使用,请勿在生产环境使用。

国外版
国内版
services:
  app:
    image: chatbi/yiask:latest
    pull_policy: always
    container_name: yiask
    environment:
      - PROJECT=test
      - LOGGER_LEVEL=error
      - TZ=Asia/Shanghai
      # 以1个进程的形式启动服务。请勿在生产环境中使用。生产环境配置见【安装部署】板块
      - CLUSTER_MODE=1
      # PG元数据库的配置
      - DB_HOST=postgres
      - DB_DATABASE=mydatabase
      - DB_USER=postgres
      - DB_PASSWORD=postgres

      # 网页搜索 API Key(可选)
      # - WEB_SEARCH_API_KEY=tvly-dev-xxxxxxxx
    volumes:
      - storage:/app/nocobase/storage
    depends_on:
      postgres:
        condition: service_healthy
    ports:
      - "3052:80"
    init: true
    extra_hosts:
      - "host.docker.internal:host-gateway"

  postgres:
    container_name: yiask_postgres
    image: pgvector/pgvector:pg17-trixie
    restart: always
    command: postgres -c wal_level=logical
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U postgres"]
      interval: 5s
      timeout: 5s
      retries: 10
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgres
      POSTGRES_DB: mydatabase
    volumes:
      - pg-data:/var/lib/postgresql/data

volumes:
  storage:
  pg-data:

保存文件后执行 docker compose up -d 即可启动所有依赖服务;可通过 docker compose logs -f 查看实时日志,确认服务启动成功后访问 http://<server-ip>:3052 进入系统。

注意

首次开启系统,系统会进行初始化,整个过程大约在5分钟左右。请耐心等待。

默认用户名/密码为:admin/12345678

3. 配置大模型

在初次进入时,会有一个引导页面。跟随引导页面配置好大模型API连接。

4. 连接数据源

在控制台点击导航栏的【系统搭建】,在左侧侧边栏依次选择【数据管理】→【数据源管理】,随后点击“添加”按钮即可新建数据源。

我们准备了一份示例数据库,里面预填了一些示例数据,用以快速体验本系统使用方式。

示例数据源配置:

字段
类型MySQL
是否只读
主机/IP139.224.53.201
端口3306
数据库demo-test
用户名read_user
密码myread
Info

可以通过我们提供的AI员工:表单助理Avery,通过自然语言描述数据源,自动生成连接配置。

如需了解更详细的配置步骤与排查建议,可阅读《连接数据库》章节。

5. 业务建模

在新建立的数据源的最右侧会出现一个AI员工的头像,点击该员工,点击【开始建模】按钮。我们的AI员工 Sage 会引导你完成建模任务。

Info

AI员工仅仅是辅助建模,不保证100%的正确性。 可能会有一定程度的错误率。

6. 进行问答

完成建模后,请点击【业务建模】菜单,检查Schema列表是否正确被生成。如确认正确,点击【学习所有Schema】标签,然后点击【开始学习】按钮。

学习完成后,点击导航栏的【智能问答】,选择默认 Agent “Nora”,并提出业务问题,例如“销售金额”。通过实际问答来验证模型是否能够返回正确结果,如有异常再返回语义模型或数据配置进行调整。

完成以上步骤后,你就拥有了一个可服务业务团队的 Data Agent。接下来阅读“使用指南”,继续深挖数据建模、权限、AI员工配置与运维策略。