news 2026/9/12 15:08:55

ToolJet AI Docs Assistant 使用指南：在 Learn 标签页中用自然语言问答驱动官方文档检索

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
ToolJet AI Docs Assistant 使用指南：在 Learn 标签页中用自然语言问答驱动官方文档检索

ToolJet AI Docs Assistant 使用指南：在 Learn 标签页中用自然语言问答驱动官方文档检索

【免费下载链接】ToolJetOpen-source foundation of ToolJet AI - the enterprise app generation platform for internal tools, dashboards, business applications, workflows and AI agents. Build visually, from a prompt, or from Claude Code, Codex and Cursor over MCP 🚀项目地址: https://gitcode.com/GitHub_Trending/to/ToolJet

ToolJet 的AI Docs Assistant（AI 文档助手）是一个内置于 Build with AI 侧边栏 Learn 标签页的智能问答助手，它面向 ToolJet 官方文档库提供即时检索、要点总结、分步引导与排障建议。读完本文，你将掌握该助手的入口与定位、六类核心能力，并通过 Form 自定义 Schema、Table 动态列、Chart 的 Plotly JSON 三个实战示例，学会用自然语言快速获取可落地的组件配置方案。

AI Docs Assistant 是什么

AI Docs Assistant 是 ToolJet 面向文档检索场景推出的智能助手。它的核心价值在于把“翻文档”变成“问问题”：你无需预先知道某个概念在文档的哪个章节，只需用自然语言描述需求，助手便会基于 ToolJet 官方文档内容给出快速答案、分步指南或概念解释，并顺带完成文档要点总结、问题排查与最佳实践引导。

该能力与 Build with AI 整体方案 一脉相承——ToolJet 支持用自然语言生成业务应用，而 AI Docs Assistant 则负责让用户在构建过程中随时获得文档级的知识支撑。在 build-with-ai 文档目录 中，它作为独立主题与overview.md、generate-applications.md并列，本文所依据的原始文档即 ai-docs-assitant.md（当前最新版 docs/docs 目录 下亦有同步内容）。

入口与访问方式

助手位于Build with AI 侧边栏的 Learn 标签页下，访问路径为：

  1. 打开 ToolJet 应用编辑器 / 仪表盘；
  2. 展开左侧Build with AI侧边栏；
  3. 切换至Learn标签；
  4. 在对话框中直接提问，或描述你正在寻找的内容，助手即返回相关文档与解读。

从界面截图可以看到，Build with AI 侧边栏同时包含 Generate（生成应用）与 Learn（学习与问答）两类入口，AI Docs Assistant 属于后者，职责聚焦在“文档检索与理解”，与负责“应用生成”的 Generate Applications 互补。

你能用 AI Docs Assistant 做什么

根据官方文档，AI Docs Assistant 的能力覆盖了从平台管理到安全合规的六类典型场景：

  • 工作区与权限管理：获取关于创建工作区、管理用户、配置角色与权限的指导；
  • 复杂主题速览：对复杂概念给出清晰、可执行的步骤，快速理解；
  • 常见问题排障：找到常见问题的答案，高效解决问题；
  • 连接外部系统：探索如何连接数据库、API 及外部工具；
  • 应用安全加固：发现保护应用安全的最佳实践；
  • 平台能力速成：快速熟悉关键功能与平台级最佳实践。

本质上，助手回答的质量取决于其背后索引的文档覆盖面——ToolJet 的组件文档体系（如 widgets 目录）、数据源文档（如 />

助手会返回可直接粘贴到组件属性中的 JSON Schema。回答背后对应的文档知识来自 Form 组件文档：Form 组件启用Use custom schema属性后，即可用 JSON 格式提供表单结构，Schema 由三个顶层键组成：

键说明
title指定表单的标题
properties定义表单内部各组件的属性（组件类型、默认值、占位符、校验规则、样式等）
submitButton定义表单提交按钮的属性

其基础结构为：

{ "title": "", // 为 Form 提供标题 "properties": {}, // 提供表单内部组件的 Schema "submitButton": {} // 提供提交按钮的 Schema }

properties中的每个字段对应一个子组件，例如文本输入组件可配置type: "textinput"、label、placeholder、validation（如maxLength）以及styles（背景色、圆角、边框色等）。助手正是依据这类文档知识，将“两个输入框 + 一个下拉框”的需求翻译为合法的自定义 Schema。

示例二：解释 Table 组件的动态列

提示词（Prompt）：

Can you explain dynamic columns in the Table component?

（能否解释一下 Table 组件中的动态列？）

助手会返回动态列的概念说明、启用步骤与 JSON 配置示例。其文档依据是 Table 动态列文档，要点包括：

  • 动态列允许用户通过 JSON 值动态设定Table组件的列；
  • 启用步骤：拖入 Table 组件 → 连接查询为表格填充数据 → 打开Use dynamic column开关 → 输入 JSON 定义列；
  • 单个列配置示例：
{ "name": "Name", "columnType": "string", "key": "first_name", "cellBackgroundColor": "#000", "textColor": "#fff", "isEditable": true, "regex": "", "maxLength": 20, "minLength": 5, "customRule": "" }

上述配置会渲染出一列名为 Name 的可编辑字符串列，数据长度限制在 5～20 个字符之间，白字黑底。动态列的高级用法是根据当前用户角色渲染不同表结构，例如管理员看到包含薪资、绩效的完整列，普通员工只看到基础列，可借助{{globals.currentUser.groups.includes("admin") ? [...] : [...]}}这类 JS 表达式在属性中动态切换。当你不确定这类 JSON 的具体写法时，正是 AI Docs Assistant 的用武之地。

示例三：Chart 组件的 Plotly JSON 结构

提示词（Prompt）：

Can you help me with the structure of the Plotly JSON that I can pass into Chart components?

（能否帮我梳理一下可以传入 Chart 组件的 Plotly JSON 结构？）

助手会解释 Plotly JSON Schema 的用途与结构。文档依据是 Chart 组件文档：在组件属性中打开Use Plotly JSON Schema开关（也可点击fx用逻辑表达式动态控制）后，即可传入 Plotly 规范的 JSON 定义图表。Chart 组件常规的图表数据需为 JSON 数组，且包含x、y两个键：

[ { "x": "Jan", "y": 100 }, { "x": "Feb", "y": 80 }, { "x": "Mar", "y": 40 }, { "x": "Apr", "y": 100 }, { "x": "May", "y": 80 }, { "x": "Jun", "y": 40 } ]

当需要更自由的图表布局（坐标轴标题、标记样式、多系列等）时，Plotly JSON 提供了比内置属性更细的粒度，而助手可以帮助你快速生成或校验这类 JSON 的骨架。

如何让助手给出高质量回答

结合示例与文档问答的本质，以下提示词技巧可以显著提升回答质量：

  1. 指明组件名与具体能力：如“Form 组件的 custom schema”“Table 组件的 dynamic columns”，精准定位到对应文档；
  2. 描述目标而非步骤：说出你想实现的效果（如“两个输入框和一个下拉框”），让助手补全中间配置；
  3. 涉及配置格式时明确格式：如“Plotly JSON 的结构”“JSON Schema 的键”，引导助手输出结构化代码；
  4. 一次聚焦一个问题：混合多个组件或概念会降低回答的针对性。

与 Build with AI 生态的协同使用

AI Docs Assistant 不是孤立功能，它与 Build with AI 的生成链路紧密配合：

  • 生成阶段：在 Generate Applications 中，输入一句提示词即可生成应用需求清单（功能列表、数据库 Schema、设计细节与查询规格），确认后 ToolJet 在 App Builder 内完成应用搭建；
  • 理解阶段：当生成结果涉及你不熟悉的组件属性（如表单 Schema、动态列、图表 JSON）时，切到 Learn 标签页向 AI Docs Assistant 提问，即可实时补齐知识；
  • 修改阶段：生成的应用或已有应用都可通过提示词继续修改组件与查询，助手则负责回答“怎么做”的细节问题。

两者结合，就构成了一条“自然语言生成 → 文档级理解 → 迭代修改”的完整 AI 辅助构建闭环。

版本与适用范围说明

  • 本文内容基于当前仓库的version-3.0.0-LTS版本文档（ai-docs-assitant.md），最新文档同步维护在 docs/docs/build-with-ai/ 目录下，两者描述的功能一致；
  • AI Docs Assistant 的回答范围限定在 ToolJet 官方文档知识库内，面向平台功能、组件与集成的使用说明；
  • 若你关心的是“AI 生成查询”的能力边界，可参考 Generate Applications 文档 中列出的数据源限制（目前支持 Postgres、MySQL、SQL Server 与 RunJS 查询）——这是应用生成功能的能力约束，与文档问答助手相互独立。

总体而言，AI Docs Assistant 把 ToolJet 数百页的组件、数据源与平台文档变成了一座可对话的知识库，是搭建内部工具、仪表盘与业务应用过程中随查随用的得力助手。

【免费下载链接】ToolJetOpen-source foundation of ToolJet AI - the enterprise app generation platform for internal tools, dashboards, business applications, workflows and AI agents. Build visually, from a prompt, or from Claude Code, Codex and Cursor over MCP 🚀项目地址: https://gitcode.com/GitHub_Trending/to/ToolJet

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考

版权声明: 本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若内容造成侵权/违法违规/事实不符，请联系邮箱：809451989@qq.com进行投诉反馈，一经查实，立即删除！
网站建设 2026/9/12 15:07:07

Python+OpenCV实现人脸识别考勤系统毕业设计

1. 项目概述：人脸识别考勤系统的毕业设计实现这个毕业设计项目选择了一个非常实用的方向——基于人脸识别技术的考勤系统。作为计算机相关专业的毕业设计选题，它既符合当前技术发展趋势，又能解决实际场景中的考勤管理问题。我选择使用Python作…

作者头像 李华
网站建设 2026/9/12 15:06:42

MicroDuck：面向边缘具身智能的Rust原生确定性运行时

/* MD / 富文本中的 .toc（含博客园搬家等嵌套结构）；.toc-box 在侧栏，不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p（:empty 仍占 20px），一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

作者头像 李华
网站建设 2026/9/12 15:04:23

电子元器件检测的动态YOLO调度系统设计

/* MD / 富文本中的 .toc（含博客园搬家等嵌套结构）；.toc-box 在侧栏，不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p（:empty 仍占 20px），一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

作者头像 李华
网站建设 2026/9/12 15:00:17

数据分析中的分组功能：核心价值与实战技巧

1. 分组功能的核心价值与应用场景 分组功能在现代数据分析和业务管理中扮演着至关重要的角色。作为一名数据分析师，我几乎每天都要与各种分组操作打交道。简单来说，分组就是将数据集按照特定标准划分为若干子集的过程，这看似基础的操作却能解…

作者头像 李华